Overview
License
To run openFHIR, you will first need a valid license. To obtain the license, please visit the official website at https://open-fhir.com and follow the instructions.
Engine overview
openFHIR Engine is a standalone component that exposes 2 restful APIs for mapping (/openfhir/tofhir and /openfhir/toopenehr) and 3 restful APIs for state configuration (/opt, /fc/context and /fc/model). These APIs are further described in RESTful APIs section.
State required by the engine are mapping files according to FHIR Connect specification and are split to context.yaml files and model.yaml files. Additionally, state required by the engine are also openEHR Operational Templates (.opt), which can either be part of the openFHIR Engine’s state or it can come from an integrated openEHR repository (see more: Integrations).
As an example, for a mapping of a blood pressure template, you’d need the following files (state) configured:
Blood Pressure.opt
simple-blood-pressure.context.yaml
blood-pressure.model.yaml
Responsibility, separation of concern
There is a clear separation of concerns: the openFHIR component is solely responsible for mapping between FHIR and openEHR. Its purpose is not to store clinical data, and it lacks a persistence layer for this. Additionally, it does not store data in any underlying openEHR repository, nor does it expose FHIR or openEHR endpoints. See more in Architecture.