Skip to content

Navigation Menu

Sign in
Sign up

Repository files navigation

openFHIR Logo

License: Apache-2.0

openFHIR is an open-source engine for healthcare interoperability that enables bidirectional mappings between openEHR and HL7 FHIR, based on the FHIR Connect specification .

openFHIR translates openEHR Compositions and FHIR Resources without storing clinical data itself — making it a flexible component for modern health IT architectures.

FHIR Version Support

openFHIR supports all major HL7 FHIR versions:

Version Status
FHIR STU3 (3.0)
FHIR R4 (4.0)
FHIR R4B (4.3)
FHIR R5 (5.0)

Note: This open-source version is not intended for production use. It lacks critical production capabilities including authentication and role-based access control, terminology server integration, and performance optimizations. For production-ready deployments with full security, scalability, and enterprise support, please refer to the Enterprise version .

Open Source vs Enterprise

Feature Open Source Enterprise
Bi-directional mapping between openEHR and FHIR
AQL Generation
Compliance with FHIRConnect specification
Included support and consultancy No
Postgres support No
Terminology server integration No
Operational Templates sync with underlying openEHR Server No
Multitenancy No
Mapping insights support No
Authentication and role-based access control No
Integration with a git repository as a source of mapping files No
Optimized performance No
Support for High Availability setups No

Changelog

Please check the CHANGELOG

Documentation

Check out the documentation at https://open-fhir.com/documentation

Performance

Performance is measured regularly, on every release, against the Enterprise version . The Enterprise version includes performance optimizations that this open-source version does not, so the numbers are not directly representative of what you will see here. They do, however, show that performance is not a limiting factor for production scenarios.

Try openFHIR Online

If you’d like to explore openFHIR without installing anything locally, you can use the public sandbox environment, which always runs the latest release of openFHIR:

https://sandbox.open-fhir.com/

The sandbox provides a live instance of the openFHIR engine where you can:

  • Test FHIR ↔ openEHR transformations
  • Validate mapping configurations
  • Experiment with API requests
  • Explore mapping transformation with a UI called openFHIR Atlas

⚠️ The sandbox is intended for testing and evaluation purposes only.


Get Started Locally (Docker)

For local development or testing we recommend running openFHIR using Docker.

docker run -e SPRING_DATA_MONGODB_URI=mongodb://your-mongodb-url \
-p 8080:8080 openfhir/openfhir:latest

Additionally, check out the Docker Compose file for a complete setup with mongodb.


Bootstrapping Mappings

openFHIR scans the directory configured with openfhir.bootstrap.dir (default /app/bootstrap/) on startup and loads what it finds there: *.context.yaml/*.context.yml as context mappers, other *.yaml/*.yml as model mappers, and *.opt as operational templates. Sub-folders are scanned too unless openfhir.bootstrap.recursively-open-directories is set to false.

Each applied file is recorded together with a hash of its content and the id of the entity it created. On every subsequent scan, new files are created, files whose content changed are updated in place under the same entity id, and unchanged files are skipped. Files that were bootstrapped previously but have since been removed from disk are reported in the log; their entities remain in the engine.

To re-scan without restarting the engine:

curl -X POST http://localhost:8080/\$bootstrap

To inspect what has been bootstrapped so far, and which entity each file created:

curl http://localhost:8080/bootstrap

The response summarises the run:

{
 "created": 2,
 "updated": 1,
 "unchanged": 14,
 "failed": 0,
 "files": [
 {"path": "kds/diagnose.context.yaml", "outcome": "UPDATED", "entityType": "CONTEXT", "entityId": "6f2c...", "message": null}
 ]
}

Credits

Original openFHIR project was initially open-sourced by MedBlocks in https://github.com/medblocks/openFHIR. Credits:

About

openFHIR, an engine that implements FHIRConnect specification for bidirectional mapping between openEHR and FHIR

Resources

Stars

28 stars

Watchers

3 watching

Forks

Releases

Packages

Contributors

Languages

AltStyle によって変換されたページ (->オリジナル) /