OpenHIM platform comes bundled with a set of generic packages that can be deployed and configured to support a number of different use cases. To help users of OpenHIM Platform get started with something they can make use of immediately, a number of default OpenHIM Platform recipes are provided. These help you get started with everything you need setup and configured for a particular use case.

These recipes combine and configure multiple packages together so that a functional HIE is stood up that is pre-configured to support a particular use case.

We currently support the following default recipes:

This recipe sets up an HIE that deploys JeMPI behind the OpenHIM with a mapping mediator configured to allow for FHIR-based communication with JeMPI. It also deploys Keycloak for user management and authentication.

To launch this package in dev mode copy and paste this into your terminal in a new folder (ensure you have the instant CLI installed):

wget https://github.com/jembi/platform/releases/latest/download/mpi.env && \
wget https://github.com/jembi/platform/releases/latest/download/config.yaml && \
instant package init -p mpi --dev

This recipe sets up an HIE that does the following:

• Accept FHIR bundles submitted securely through an IOL (OpenHIM)

• Stores Clinical FHIR data to a FHIR store (HAPI FHIR)

• Stores Patient Demographic data to an MPI (JeMPI)

• Pushes FHIR resources to Kafka for other external systems to use

To launch this package in dev mode copy and paste this into your terminal in a new folder (ensure you have the instant CLI installed):

wget https://github.com/jembi/platform/releases/latest/download/cdr.env && \
wget https://github.com/jembi/platform/releases/latest/download/config.yaml && \
instant package init -p cdr --dev

This recipe sets up an HIE that does the following:

• Accept FHIR bundles submitted securely through an IOL (OpenHIM)

• Stores Clinical FHIR data to a FHIR store (HAPI FHIR)

• Stores Patient Demographic data to an MPI (JeMPI)

• Pushes FHIR resources to Kafka for the reporting pipeline (and other systems) to use

• Pulls FHIR data out of Kafka and maps it to flattened tables in the Data Warehouse (Clickhouse)

• Allows for the Data Warehouse data to be visualised via a BI tool (Apache Superset)

To launch this package in dev mode copy and paste this into your terminal in a new folder (ensure you have the instant CLI installed):

wget https://github.com/jembi/platform/releases/latest/download/cdr-dw.env && \
wget https://github.com/jembi/platform/releases/latest/download/config.yaml && \
instant package init -p cdr-dw --dev

Services

When deployed in --dev mode the location of the UIs will be as follows:

Extra UIs only exposed in --dev mode:

Example use

Use the following example postman collection to see interaction you cna have with the system and see how the system reacts.