HAPI FHIR

HAPI FHIR - Java API for HL7 FHIR Clients and Servers

The leading open-source implementation of the HL7 FHIR specification for Java.

---

CI/CD Status

CI Status (master)	SNAPSHOT Pipeline	Current Release

Code Quality

---

🚀 Quick Start

Maven

<dependency>
    <groupId>ca.uhn.hapi.fhir</groupId>
    <artifactId>hapi-fhir-base</artifactId>
    <version>6.10.0</version>
</dependency>

<!-- Choose your FHIR version -->
<dependency>
    <groupId>ca.uhn.hapi.fhir</groupId>
    <artifactId>hapi-fhir-structures-r4</artifactId>
    <version>6.10.0</version>
</dependency>

Basic Usage

// Create a FHIR context for R4
FhirContext ctx = FhirContext.forR4();

// Parse a resource
Patient patient = ctx.newJsonParser().parseResource(Patient.class, jsonString);

// Create a client
IGenericClient client = ctx.newRestfulGenericClient("http://hapi.fhir.org/baseR4");

// Read a resource
Patient result = client.read().resource(Patient.class).withId("123").execute();

---

📚 Documentation

Resource	Link
Complete Documentation	hapifhir.io
Live Demo Server	hapi.fhir.org
Javadoc	hapifhir.io/hapi-fhir/apidocs/
Getting Help	Wiki - Getting Help

---

✨ Features

FHIR Version Support

Version	Module	Status
R5	hapi-fhir-structures-r5	✅ Supported
R4B	hapi-fhir-structures-r4b	✅ Supported
R4	hapi-fhir-structures-r4	✅ Supported
DSTU3	hapi-fhir-structures-dstu3	✅ Supported
DSTU2	hapi-fhir-structures-dstu2	⚠️ Maintenance

Core Capabilities

• 🔄 Client - Fluent REST client for any FHIR server
• 🖥️ Server - Build your own FHIR server
• 💾 JPA Server - Full FHIR server with database persistence
• ✅ Validation - Profile and resource validation
• 🔐 Security - SMART on FHIR, OAuth 2.0 support
• 📊 Subscriptions - Real-time notifications
• 🔗 MDM - Master Data Management

---

📦 Project Structure

hapi-fhir/
├── hapi-fhir-base/              # Core library
├── hapi-fhir-client/            # REST client
├── hapi-fhir-server/            # Server framework
├── hapi-fhir-jpaserver-*/       # JPA server modules
├── hapi-fhir-structures-*/      # FHIR version structures
├── hapi-fhir-validation/        # Validation support
└── docs/                        # Project documentation
    ├── adr/                     # Architecture Decision Records
    └── prd/                     # Product Requirements

---

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details on:

• Setting up your development environment
• Coding standards and testing requirements
• Pull request process

Looking to help? Check out issues labeled good first issue or help wanted.

---

🔒 Security

For security vulnerabilities, please see our Security Policy.

Do not report security vulnerabilities through public GitHub issues.

---

📄 License

This project is Open Source, licensed under the Apache Software License 2.0.

---

💼 Commercial Support

For commercial support and enterprise features, please see Smile CDR.

---

🙏 Acknowledgments

HAPI FHIR is made possible by contributions from:

• Smile CDR
• University Health Network
• Community contributors

---