APIs

In general, OpenMRS has 2 major API options your team can leverage to call resources as required: 

• 💻 REST API: Thoroughly documented here. To rapidly explore the OpenMRS data model, you can also use this search tool. 

• 🔥 FHIR API: Information here, and FHIR IG here. 

Interoperability Layers

Ozone

• Ozone HIS is an open-source project that enables you to build your HIS (Health Information System) from a flexible ecosystem of apps and features. For example, Ozone helps you rapidly connect and launch OpenMRS 3 with a Lab System, ERP system, Data Visualization system, PACS, and more.

• Ozone HIS is powered by Ozone’s interoperability layer. For OpenMRS, data is directly pulled from a source OpenMRS MySQL database and wired onto Camel routes to integrate OpenMRS with other systems without any use of the OpenMRS Java API or data model. You can also substitute the EMR component for other options such as Bahmni’s EMR. Documentation: More info here. Ozone is maintained and discussed within the OpenMRS community. For discussion go to the OpenMRS Slack and join the #ozone channel!

OpenHIM

• Demo video of OpenMRS integration using OpenHIM here, sample architecture here, and comparison to Apache Kafka here

OpenFn

• OpenFn is an open-source digital public good (DPG) for data integration, interoperability, and workflow automation, used in over 41 countries to move data between systems and automate mission-critical tasks. OpenFn offers a scaleable adaptor that allows you to securely authenticate and connect with any instance of OpenMRS and make HTTP requests through their preconfigured helper functions and endpoints provided by the OpenMRS API. Using OpenFn’s 70+ open source adaptors, you can connect OpenMRS to any application such as HAPI FHIR, CommCare, DHIS2, Kobotoolbox, etc, either moving data in/out of OpenMRS or automating operations such as creating patient records, updating records, and requesting services, etc. 

• Here are a few resources to get started: 

  • OpenMRS (OpenFn) adaptor documentation

    • Example: Creating a patient on OpenMRS via an OpenFn adaptor

    • Adaptor explanation and example: OpenFn's OpenMRS Adaptor v5.0.0 RELEASE !!!

  • Setting up OpenFn in a local environment

Facility-Level Integrations

Billing and Inventory Management

Odoo

• In Ozone: Odoo Config for the Ozone interoperability layer with OpenMRS: repo here, uses Odoo 14.0+ (Community Edition)

• In Bahmni: Odoo 10.0-20190619 (Community Edition) built-in to latest Bahmni release

ERPNext

• An OpenMRS <-> ERPNext integration is supported by the open source Ozone interoperability layer. This is being used in settings including Kenya. See “Ozone” above, or see the supported OpenMRS <> ERPNext flows here.

Crater

• open-source app for expenses, payments, invoices & estimates. Bahmni-Lite is using Crater as a lightweight alternative to Odoo for invoicing & billing. Details here. 

Data Visualization, Reporting, and Flattening

DHIS2 HMIS

• OpenMRS DHIS2 Connector Module: Module here, Demo Video #1 here, Demo Video #2 here

  • OpenMRS <> DHIS2 exchanging patient identifications and individual data (such as observations) through OpenFN – 5 minutes walkthrough video

  • FHIR-related: Members from the DHIS2 and OpenMRS communities are starting to collaborate on a FHIR-based integration strategy. We are seeking your use cases! Please contact grace[a]openmrs.org if you have a use case to share.

Apache Superset

• Superset is an Open Source data visualization tool. Ozone Analytics, a versatile big data pipelines technology, streams data from OpenMRS to a data lake consumed by Apache Superset. More info here. Known OMRS Community Integrations: Cote d’Ivoire’s HIS Technical Working Group, ICRC (see some example ICRC Superset dashboards here).

PowerBI

• Several implementers use SQL scripts to ETL from OpenMRS to a SQL Server where Power BI then consumes the transformed data (eg PIH, EGPAF). For more information consider posting to the OpenMRS Forum at http://talk.openmrs.org  

Open Health Stack: FHIR Data Pipes

• The Analytics Pipeline of Open Health Stack is specifically called fhir-data-pipes. Known Community Member Integrations: Being used for Cote d’Ivoire OpenMRS analytics capture by ITECH. 

• Other Data Extraction Tools:

  • MambaETL: UCSF module for OpenMRS Data Flattening. Details here.

SMS and WhatsApp

• OpenMRS SMS module, documentation here. Connects OpenMRS with SMS service providers, and provides a convenient layer to send SMS/WhatsApp from the OpenMRS. Configuration examples here.

• SMS Notifications in Bahmni Lite: Details here.

Laboratory Information Systems (LIS)

OpenELIS

• See the OpenELIS FHIR IG. Known Community Member Integrations: ITECH (Sigdep3 in Cote d’Ivoire and Isanteplus in Haiti). Prerequisite modules: FHIR2 Module, Lab-on-FHIR Module. Point of contact for OpenELIS integration questions: digit[a]uw.edu See also: the EMR and LIS Data HIE Exchange Knowledge Base

SENAITE

• In Ozone: SENAITE Config for the Ozone interoperability layer with OpenMRS: repo here.

Lab Analyzers and Lab Machines

• OpenHIE Lab Information Sysytems COP and the Decoupled Analyzer Interface System (DAIS) – Community built middleware to connect clinical lab analyzers and convert their output to FHIR resources. 

• Analyzer Interface Manuals: shared Folder here (e.g. ASTM, HL7v2 guides for common Lab Analyzers, since these guides are often difficult to find or even only available in CDROM)

Imaging, PACS (Picture Archiving and Communication System), DICOM (Digital Imaging and Communications in Medicine), and RIS (Radiology Information System)

DCM4CHEE

• Currently in Bahmni. Soon to come for Ozone.

Orthanc

• Demo and further information of integration with OpenMRS 2: _________

• Orthanc integration is also supported in Ozone’s FOSS Integration layer.

System Monitoring

• Grafana & Prometheus: Helpful with deployment of upgrades, application up-time and hard-drive health monitoring, backup monitoring, sync monitoring. See all servers where application is down so you can proactively contact those sites. (Prometheus listens for this information; Grafana helps you visualize them.) Used by ITECH Cote d’Ivoire: monitoring to manage 500 locally stored instances and pull up in local fhir store. Deployment and updates; remote management and monitoring tools – could work on data center or locally installed. E.g. can show you which sites did not yet upgrade and may need a manual intervention. Contact: digit[a]uw.edu (Similar to CHT’s WatchDog setup).

CHW Community Health Worker Apps

Community Health Toolkit (CHT)

• The CHT can exchange data with OpenMRS in both integration (see the CHT Integration Guide for OpenMRS) and OpenHIE architecture-based interoperability (see the CHT Interoperability Guide for OpenMRS) scenarios.  Community Orgs with known integrations: Partners in Health; KenyaEMR/Palladium (eCHIS). Community Orgs with CHT <> OpenMRS interoperability initiatives: SunyaEK.

Open Health Stack: Android FHIR SDK

• See this demo Android Smart Phone application built using Android FHIR SDK to connect with an OpenMRS instance using the FHIR2 omod. Code location. Demo slides and O2 <–> Android App Sync video.

OpenSRP (OpenSRP2)

• Because OpenSRP2 is FHIR-native, this works well with OpenMRS' FHIR2 Module. Worldwide, there are OpenMRS v2 and v3 implementations that have used the FHIR2 Module to integrate well with OpenSRP 2, such as mPower in Bangladesh. Ona’s OpenSRP2 website is here.

  • If you are using OpenSRP v1, see the old Integration Guide Here. However, note that OpenSRP 2 is the recommended up-to-date version.

CommCare (Dimagi)

• CommCare’s Data Integration Layer product can be used to exchange data with OpenMRS. Some implementers are using the CommCare FHIR API.

Paper-Related Tools

OCR & Scan Paper Forms for Data Entry

QED.ai’s ScanForm

• QED has set up an integration with OpenMRSv2 that allows data entered on structured paper forms to be automatically entered into the Patient Chart in O2 from taking a photo of the completed form with the QED Mobile App. For information, see: About

National-Level Integrations (e.g. HIE, NDR)

Message Syncing from OpenMRS to a National HIE

OpenMRS EIP Module

OpenHIM

ActiveMQ

Terminology Service / Terminology Registry / Dictionary Manager

OCL (Open Concept Lab)

• OCL serves as a terminology management service that can host OpenMRS concept dictionaries, prepare them for integration with your system(s), and manage them over time. OCL also serves as the home for the CIEL interface terminology, which can be adapted and reused for your OpenMRS concept dictionaries.

  • OpenMRS Open Concept Lab Module: This module unlocks OpenMRS and OCL integration. Get started here. 

    • Video of 1-hr tutorial about OCL and OpenMRS

  • Using OCL for OpenMRS Concept Dictionary Management

  • OCL Getting Started Materials

  • Brief OCL demonstration using a CIEL/OpenMRS Use Case

  • Details About OCL’s involvement in the OpenMRS Community

  • Regular OCL + OpenMRS Squad Calls: call that anyone can join with questions or to share experiences. Call detail at: om.rs/cal

Insurance, UHC, and Claim Management

openIMIS

• openIMIS FHIR IG

•  Out-of-the-box Integration Layer between OpenMRS v3 and openIMIS coming soon to Ozone (~end of April 2024).  

Facility Registry

GOFR 

• (Facility Registry) – Uses FHIR’s MCSD profiles so OpenMRS can query those FHIR stores for the desired facility information. Known Community Member Integrations: ITECH 

Geoprism

• Uses FHIR’s MCSD profiles so OpenMRS can query those FHIR stores for the desired facility information. 

Client Registry

OpenEMPI

• Integration steps documented here.

OpenCR

• Demo Video of OMRS and OpenCR integration, with installation guides and repository links, available here. Known Community Member Integrations: ITECH (Sigdep3 in Cote d’Ivoire and Isanteplus in Haiti). 

SanteMPI

• SanteMPI Client OpenMRS Module

JeMPI

• The OpenMRS – JeMPI Integration Guide is coming soon: _____.

Didn’t find what you’re looking for? Please share your use case by posting in the OpenMRS forum at: https://talk.openmrs.org 

Still need help?

The OpenMRS Community is here for you!