spring-fhir-humanizer-api

spring-fhir-humanizer-api is a Spring Boot REST API powered by FDS that converts

• FHIR R4 Dosage and Timing elements
• FHIR R5 Dosage and Timing elements

into human-readable text — in your desired language and with customizable formatting & more.

🚀 Demo

• Swagger UI : https://spring-fhir-humanizer-api.onrender.com/swagger-ui/index.html
• OpenAPI : https://spring-fhir-humanizer-api.onrender.com/v3/api-docs
• API : https://spring-fhir-humanizer-api.onrender.com

⚠️ Note: This instance is hosted on Render, which puts inactive web services to sleep. The first request after a period of inactivity may take up to 50 seconds to respond.

✨ Features

• 📝 Converts FHIR Dosage and Timing elements to plain-language descriptions
• 🌐 Supports internationalization (via locale parameter)
• ⚙️ Customize display format via options like displayOrder and displaySeparator
• 📦 Accepts single or multiple objects
• 🔍 Includes built-in Swagger UI for easy testing and exploration
• ✂️ Choose output format style :
  • SUMMARY : all results concatenated into a single string
  • DETAILED : generate one string per entry

---

🚀 Getting Started

Prerequisites

• Java 21+
• Maven

Build and Run

git clone https://github.com/your-org/spring-fhir-humanizer-api.git
cd spring-fhir-humanizer-api
./mvnw spring-boot:run

Credits

Special thanks to :

• The Java library which this webservice uses
• Render.com for the free plan hosting

Contributors

Star History