OpenMRS patient imaging module docker compose (Orthanc integration)

Overview

This project provides a Docker setup for the OpenMRS 2.x and OpenMRS 3.x Imaging module. It contains all the configuration files and libraries needed to run the application with Orthanc integration.

This project provides a Docker Compose setup for the OpenMRS2.x and OpenMRS 3.x Imaging module. It contains all the configuration files and libraries needed to run the application with Orthanc integration.

Configure Your Local Orthanc Server

Update your orthanc setup by replacing and adding the following files:

• Replace/modify the existing orthanc.json in /etc/orthanc directory with the one from this project and restart the Orthanc server.

Note: Please update the port configuration as follows:

• OpenMRS2.x Docker container -> use port 2222

• OpenMRS3.x Docker container -> use port 3030

• Copy the Orthanc worklist script in the folder orthanc:

  cp orthancWorklist.py /etc/orthanc/

• Copy the Python plugin configuration:

  cp python.json /etc/orthanc/

Orthanc Configuration in OpenMrS

To connect with Orthanc, add the following configuration:

• URL: http://host.docker.internal:ORTHANC_PORT

  Note: Not change host.docker.internal

• Proxy URL: Your local orthanc URL
• User: orthanc
• Password: orthanc

Running the Docker Container

Start the Docker container for OpenMRS 2.x:

docker compose -f docker-compose-openmrs2.yml up

Note

• The installation process may take some time.
• In some cases, you may need to stop the container and restart it to complete the setup successfully.

Login to OpenMRSMRS 2.x

• User: admin
• Password: Admin123
• Note: If logging in with Admin123 doesn’t work:
  • Use the password test to log in.
  • After logging in, go to your admin account settings and change the password.

Start the Docker container for OpenMRS 3.x:

docker-compose up

Note

• The installation process may take some time. You can monitor the progress of the setup by visiting

http://localhost:3030/openmrs/initialsetup

![Installation](figures/installProcess.png)

- In some cases, you may need to stop the container and restart it to complete the setup successfully.
- Remove the container
```bash
docker-compose down    

Starting OpenMRS with the imaging module

You have two options for running the Imaging module:

• Running via Docker (micro-frontend image)

  • Start the micro-frontend:

    http://localhost/openmrs/spa

  • Validate backend connection:

    http://localhost:3030/openmrs/

  • Login to OpenMRS 3.x
    • User: admin
    • Password: Admin123

  Note You may experience display issues within the application after importing the new module into Docker or updating to a new release. To resolve these issues, follow these steps:

  • Stop the containers: docker-compose down
  • Restart the containers: docker-compose up
  • If problems persist, clear your browser data:
    • Cookies and site data (e.g., 134 MB)
    • Cached files and pages (e.g., 393 MB)

• Run the frontend locally (using Docker backend):

  You can run run the frontend on your local machine while connecting to the OpenMRS backend running in Docker. First clone the imaging application from [openmrs-esm-patient-imaging-app] https://github.com/sadrezhao/openmrs-esm-patient-imaging-app:

  yarn install
  npm start -- --backend http://localhost:3030/

Login to OpenMRS 3.x

  - User: **admin**
  - Password: **Admin123**

Orthanc configuration in OpenMRS

To connect with Orthanc, add the following configuration:

• URL: http://host.docker.internal:ORTHANC_PORT

  Note: Not change host.docker.internal

• Proxy URL: Your local orthanc URL
• User: orthanc
• Password: orthanc

Upload the imaging and necessay modules:

Once the application is running, you will need to upload the required OpenMRS modules from the 'modules' folder within this project:

• imaging-1.1.6.omod
• appui-1.18.0.omod
• uicommons-2.26.0.omod
• uiframework-4.0.0.omod
• appframework-2.18.0.omod
• webservices.rest-2.50.0.omod

Link: http://localhost:8080/openmrs/admin/modules/module.list#markAllAsRead

Note: You need to click Start All to update all modules.

Deploy the new version of the micro-frontend application to Docker

1. Copy the new version of micro-frontend application into the imaging.
2. Copy the entire contents of the dist file in your project.
3. Update the @zhaosadre/esm-patient-imaging-app section with your updated dist contents and add a "version": "newVersionNumber" property.
4. Update the spa-assemble-config.json file in the imaging folder: Change "@zhaosadre/esm-patient-imaging-app": "1.0.7" to "@zhaosadre/esm-patient-imaging-app": "newVersionNumber"
5. Update the importmap.json file in the imaging folder: Change "@zhaosadre/esm-patient-imaging-app": "./openmrs-esm-patient-imaging-app-1.0.7/openmrs-esm-patient-imaging-app.js" to "@zhaosadre/esm-patient-imaging-app": "./openmrs-esm-patient-imaging-app-newVersionNumber/openmrs-esm-patient-imaging-app.js".

Links:

• Imaging frondend for OpenMRS3.x: https://github.com/sadrezhao/openmrs-esm-patient-imaging-app
• Imaging module (GUI+backend) for OpenMRS2.x: https://github.com/sadrezhao/openmrs-module-imaging
• Orthanc server: https://www.orthanc-server.com/download.php
• Imaging frontend (NPM release): https://www.npmjs.com/package/@zhaosadre/esm-patient-imaging-app
• Imaging backend (release): https://github.com/sadrezhao/openmrs-module-imaging/releases