Table of contents
Getting Started with the International Patient Summary
The International Patient Summary (IPS) module provides functionality for fetching, storing, and retrieving FHIR International Patient Summaries within the OpenMRS ecosystem. This module is designed to operate in a headless manner, meaning it does not include any user interface components.
How to Configure the Backend for the International Patient Summary on the Reference Application
Navigate to the OpenMRS GitHub repository.
Clone the repository
In this illustration the repository is cloned on Gitpod. Therefore, click on configure your own repository to start the Gitpod machine
The repository is searched under Gitpod and user clicks on the continue button. The workspace will start successfully.
The following repository https://github.com/I-TECH-UW/o3-distro/tree/IPS-MPI/distro has the required International Summary Patient artefacts that should be added to the Reference application currently running on the Gitpod instance. See illustration below
click on the committed changes for the artefacts.
Click on the Files changed.
These artefact changes are required to be made under our demo reference application currently running on Gitpod.
The first artefact is the IPS version OMOD found under the distro/distro.properties copy the OMOD artefact.
Click on the and paste under the same path of the cloned instance .
The second artefact is the IPS Snapshot version found under distro/pom.xml copy the artefact.
paste the artefact under properties in distro/pom.xml of the cloned instance.
Copy the repository.
This repository should be replaced with the relevant repository for the OpenMRS distribution. In this illustration, the Digital Initiatives Group at ITECH repository is used.
Paste the repository under the cloned instance.
Copy the IPS ESM App.
Paste the esm-ips-app under frontend/spa-assemble-config.json in the cloned instance.
Click on the docker-compose.yml file and copy the command to start-up the back end.
The backend image will be built successfully
Open a new terminal. change directory to the front end module and build the module.
copy the command to start-up the back end and run under the front -end terminal.
The frontend image will be built successfully
Open a new terminal and execute the command docker compose up
The images will be started successfully.
click on the ports tab and expose the port for the backend link to be publicly accessible.
Click on the link to access the backend.
Remove the path to access the back-end.
Enter login credentials and click on login button.
To set up the IPS module, you need to configure the following global properties in your OpenMRS instance. The table below shows the properties and their descriptions.
Property | Description |
|---|---|
| The URL of the FHIR server endpoint that returns the IPS. |
Example: | |
| The concept mapping or UUID of the complex concept used to store the IPS. |
| The UUID of the identifier type used to query the server for the IPS. |
To configure the above properties, we shall create an IPS concept so that we get the UUID that will store the IPS. To create the concept, the Dictionary menu item then click on Add New Concept.
Fill in the Concept Name, Class , Datatype and click on the Save Concept button.
Upon successful creation of the concept, copy the UUID.
Click on the administrator menu.
Click on Settings under Maitenance
Click on Ips, paste the Complex complex UUID that was copied
The Identifiertype Uuid and Url remain the same. Click on the Save button. The global properties saved successfully.
The https://hapi.fhir.org/baseR4/Patient/$summary Url access the FHIR cenral server patient summary. Upon filtering the Hapi fhir server by the patient identifier 32/34/43/46, The https://hapi.fhir.org/baseR4/Patient?identifier=32/34/43/46 returns a patient who has an IPS.
