https://github.com/jy95/spring-fhir-humanizer-api

Spring Boot REST API that converts FHIR Dosage and Timing data into human-readable text, with support for internationalization and configurable output. Includes Swagger UI for interactive exploration.
https://github.com/jy95/spring-fhir-humanizer-api

dosage fhir fhir-api fhir-parser fhir-r4 fhir-r5 fhir-server health healthcare hl7-be hl7-fhir human-readable internationalization narrative-generation open-source spring spring-boot springboot springframework timing

Last synced: 14 days ago
JSON representation

Spring Boot REST API that converts FHIR Dosage and Timing data into human-readable text, with support for internationalization and configurable output. Includes Swagger UI for interactive exploration.

• Host: GitHub
• URL: https://github.com/jy95/spring-fhir-humanizer-api
• Owner: jy95
• Created: 2025-07-11T18:27:46.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2025-09-06T10:26:50.000Z (28 days ago)
• Last Synced: 2025-09-06T12:24:00.022Z (28 days ago)
• Topics: dosage, fhir, fhir-api, fhir-parser, fhir-r4, fhir-r5, fhir-server, health, healthcare, hl7-be, hl7-fhir, human-readable, internationalization, narrative-generation, open-source, spring, spring-boot, springboot, springframework, timing
• Language: Java
• Homepage: https://spring-fhir-humanizer-api.onrender.com/swagger-ui/index.html
• Size: 147 KB
• Stars: 0
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# spring-fhir-humanizer-api [![Codacy Badge](https://app.codacy.com/project/badge/Grade/8ceab67e761147f398a3df72d1e0b741)](https://app.codacy.com/gh/jy95/spring-fhir-humanizer-api/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/8ceab67e761147f398a3df72d1e0b741)](https://app.codacy.com/gh/jy95/spring-fhir-humanizer-api/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)

**spring-fhir-humanizer-api** is a Spring Boot REST API powered by [FDS](https://github.com/jy95/fds) that converts 

* FHIR R4 [`Dosage`](https://hl7.org/fhir/R4/dosage.html) and [`Timing`](https://hl7.org/fhir/R4/datatypes.html#timing) elements 

* FHIR R5 [`Dosage`](https://hl7.org/fhir/R5/dosage.html) and [`Timing`](https://hl7.org/fhir/R5/datatypes.html#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](https://render.com), 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

```bash

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](https://github.com/jy95/fds)

- Render.com for the free plan hosting

## Contributors



  



## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=jy95/spring-fhir-humanizer-api&type=Date)](https://star-history.com/#jy95/spring-fhir-humanizer-api&Date)