4.2.3. FHIR

4.2.3.1. Registration

The process for registering a FHIR instance in GeoPrism Registry is as follows:

1. Navigate to the Settings page using the burger menu.\

   
2. Scroll down to the External Systems section and click on the + button to open the Registration modal.\

   
3. Select 'FHIR' from the Type dropdown and fill out the other fields (descriptions in the table below).\

   Field name	Description	Required?
   Type	The type of external system.	Yes
   Organization	The organization the user belongs to. An external system will only be available to data and users within this organization.	Yes
   ID	The identifier for this external system.	Yes
   Label	The label of the external system.	Yes
   Description	A description of the external system.	No
   URL	The URL for the FHIR system.	Yes
   System	The FHIR system to use when exporting or importing	Yes

4.2.3.2. Compatibility

Integration with FHIR requires use of FHIR OAuth security integration. Not all versions of HAPI FHIR are known to be capable of integrating with GeoPrism Registry via OAuth. The following table shows whether or not the steps in this document have been found to work with the listed version of HAPI FHIR.

HAPPI FHIR version	Integration via OAuth possible?
5.3.0	Yes

4.2.3.3. Synchronization

A registered FHIR external system must exist in GeoPrism Registry.

A system synchronization must be created separately for a pull and push of data. GeoPrism Registry does not support using one external synchronization that does both a pull and a push.

External system synchronizations enable the ability to push and pull data between a GeoPrism Registry instance and a FHIR instance.

A. Pushing data to FHIR instance from a GeoPrism Registry instance

1. Navigate to the Settings page.

2. Find the External System Synchronizations section and click the + button to register synchronizations.

3. Click the create button on the Synchronization Configurations page.\

   
4. Fill out the modal fields being sure to select Export for the Synchronization Type.\

   

   Field	Description
   Label	Label of the synchronization configuration.
   Organization	The organization the synchronization configuration will be available to.
   Hierarchy	The hierarchy this synchronization will use to push data to an external system.
   External System	The registered external system that this synchronization will use to push data to an external system.
   Org Units	A mapping between the Geo-Object Types in the selected GPR hierarchy and the types in the DHIS2 instance.
5. Click Submit.

B. Pulling data from a FHIR instance to a GeoPrism Registry instance

Pulling data from a FHIR instance to GeoPrism Registry requires a custom transformation to be integrated with the GeoPrism Registry instance which defines how data is pulled into GeoPrism Registry. Contact your System Administrator to get more information. System Administrators can see section 3.7 for documentation on how to setup the FHIR custom implementations.

1. Navigate to the Settings page.

2. Find the External System Synchronizations section and click the + button to register synchronizations.

3. Click the Create button on the Synchronization Configurations page.\

   
4. Fill out the modal fields being sure to select 'Import' for the Synchronization Type.\

   Field	Description
   Label	Label of the synchronization configuration.	Yes
   Organization	The organization the synchronization configuration will be available to.	Yes
   External System	The registered external system that this synchronization will use to push data to an external system.	Yes
   Synchronization	Export data to the FHIR instance or Import data to the GeoPrism Registry instance.	Yes
   Type	The GeoPrism Registry instance.	Yes
   Implementation	The custom implementation of a HAPI FHIR synchronization configuration.	Yes

   
5. Click Submit.

C. Run a synchronization

1. Navigate to the Setting page.

2. Find the External System Synchronizations section and scroll to an existing configuration.

3. Click on the View button of the FHIR configuration.

4. Click the view button on the FHIR configuration row.

   
5. On the synchronization page click the “Run now“ button to queue a new synchronization job. The results of the job will appear in the “Jobs“ section lower on the page. The user can also click on “Generate Bundle“ to generate a JSON bundle of the data which would be exported.

\