Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Current »

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

  1. Navigate to the OpenMRS GitHub repository.

screencapture-google-search-2024-11-18-08_30_51.png

  1. Clone the repository

clone application.png

In this illustration the repository is cloned on Gitpod. Therefore, click on configure your own repository to start the Gitpod machine

click on configure your own repository.png

The repository is searched under Gitpod and user clicks on the continue button. The workspace will start successfully.

machine started successfully.png

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

  1. click on the committed changes for the artefacts.

access artefacts.png

  1. Click on the Files changed.

changed files.png

These artefact changes are required to be made under our demo reference application currently running on Gitpod.

  1. The first artefact is the IPS version OMOD found under the distro/distro.properties copy the OMOD artefact.

ips version.png

  1. Click on the and paste under the same path of the cloned instance .

add ips version.png

  1. The second artefact is the IPS Snapshot version found under distro/pom.xml copy the artefact.

ipms pom.png

  1. Paste the artefact under properties in distro/pom.xml of the cloned instance.

pom ips version.png

  1. 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.

repo3.png

  1. Paste the repository under the cloned instance.

pom repo.png

  1. Copy the IPS ESM App.

ips esm app.png

  1. Paste the esm-ips-app under frontend/spa-assemble-config.json in the cloned instance.

esm app.png

  1. Click on the docker-compose.yml file and copy the command to start-up the back end.

build backed 2.png

The backend image will be built successfully

built success.png

  1. Open a new terminal. change directory to the front end module and build the module.

frontend.png

  1. copy the command to start-up the back end and run under the front -end terminal.

build frontend.png

The frontend image will be built successfully

screencapture-openmrs-openmrsdistrore-mhczfp9vzqe-ws-eu116-gitpod-io-2024-11-18-21_14_11.png

  1. Open a new terminal and execute the command docker compose up

docker compose up.png

The images will be started successfully.

images running.png

  1. Click on the ports tab and expose the port for the backend link to be publicly accessible.

Clicking on the padlock icon exposes the port

unlock.png

  1. Click on the link to access the backend.

click link.png

  1. Remove the path to access the back-end.

remove spa home.png

  1. Enter login credentials and click on login button.

The backend might take a while to initialize the database. Please wait for the process to complete.

login be.png

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

ips.url

The URL of the FHIR server endpoint that returns the IPS.

Example: https://hapi.fhir.org/baseR4/Patient/$summary

ips.concept

The concept mapping or UUID of the complex concept used to store the IPS.

ips.identifierType.uuid

The UUID of the identifier type used to query the server for the IPS.

  1. 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.

add new concept.png

  1. Fill in the Concept Name, Class , Datatype and click on the Save Concept button.

creating new concept.png

  1. Upon successful creation of the concept, copy the UUID.

UUID.png

  1. Click on the administrator menu.

administrator 2.png

  1. Click on Settings under Maintenance

settings admin.png

  1. 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.

2ea7aa8d-702c-46d5-9db2-81e1c4847377.pngglobal properties.png

The https://hapi.fhir.org/baseR4/Patient 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.

patient fhir.pngurl 2.png

How to Configure the Frontend for the International Patient Summary on the Reference Application

  1. Click on the Url under the ports tab

access fe 1.png

  1. Enter the Username and click on the Continue button.

access fe.png

  1. Enter the Password and click on the Login button

access fe 3.png

  1. Select location.

access fe 34.png

  1. Search patient

search pat.png

  • No labels