Wiki Spaces


Get Help from Others

Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack


Page tree
Skip to end of metadata
Go to start of metadata

For the latest OpenMRS-DHIS2 integration work, see


About DHIS Integration Module (DIM)

Also known as the DHIS2 Connector module, this module posts aggregate data from OpenMRS to DHIS2, and gives implementers a User Interface for an easier-to-set-up OMRS to DHIS2 pipeline, that doesn’t need manual code fixes every time there’s a change to reporting indicators.

Users gain a Mapping Tool UI, the ability to automatically send data to DHIS2 right away or on a schedule, and to map exports so that you can re-use your mapping work across sites. 

The DHIS Integration module is used to extract/aggregate data from the OpenMRS system. Data is aggregated according to the user specification (CD4 COUNT < 200). Then the OpenMRS feature, the cohort builder, is used to query the database as specified by the user.

After getting the required aggregated data an HL7 message is created and sent to DHIS. The Mirth Messaging module is used to send the message to DHIS.




Mirth Messaging Module

Installing DHIS Integration Module

To install the DHIS Integration Module (DIM), the global property module.allow_web_admin must be set to true. The global properties are found under in Administration/Manage Global Properties. The Global Properties must be saved after any change.

For DIM to be installed, the Mirth Messaging module must be installed and running (Mirth Messaging Module). To install any module, you navigate to Administration>Manage Modules. Under the Manage Modules page, there is an Add Module sub-menu. Browse to the .omod file (OpenMRS module), and click on Add Module. OpenMRS will do the necessary checks to ensure that the module is up and running.

For DIM to run, certain Global Properties need to be defined:

dhismodule.dataSetFile - This specifies the file that has the datasets that need to be sent to the DHIS system. The directory of the file is needed (the file must also be created/exist in that directory).

(ex. C:/Application Data/OpenMRS/DHIS/DHISInput/dataSets.txt)

dhismodule.dhisInput - This specifies the directory where all the inputs for the module are. The directory contains things like the Dataset file.

(ex. C:/Application Data/OpenMRS/DHIS/DHISInput)

dhismodule.HL7Archive - This specifies the directory that will be used to save all HL7 messages sent to DHIS saved by date.

(ex. C:/Application Data/OpenMRS/DHIS/HL7Archive)

Remember to SAVE the global properties after every change.

Before you can use DIM, Mirth ( must be installed and a Mirth channel must be setup. Mirth is use to allow communication between the 2 systems. For information on how to create this channel see Creating a Mirth Channel for the DHIS Connector Module

Using DIM

After uploading DIM, the DIM menu will appear on the Administration page. The menu options will be displayed under DHIS Integration Module.

The DataSets file should contain all the DataSets that need to be made and sent to DHIS (ART Monthly Data for example). The Data Sets and associated descriptions can be found from the DHIS system. Each Data Set has a list of Data Elements in it (Descriptions) that make up that Data Set.

Before exporting Data to DHIS, DataSets and data elements for the DataSets must be defined. The Manage DataSets page is used to create the DataSets and define the descriptions/elements.

Manage Data Sets

The user must define the elements for each data set and select a saved cohort from the ones saved that satisfies the description/element. The definitions must then be saved, which will make that DataSet ready for exporting to DHIS.

NB: It is the responsibility of the user to ensure that the dates that are specified match the period in the cohorts.

After the DataSets have been defined and cohorts selected, the DataSets are ready to be made into an HL7 message and sent to DHIS. Under the DHIS Integration Module, there is a link Export to DHIS, which allows the user to export the “defined†DataSets to DHIS.

Export to DHIS

On the export to DHIS page, the user must specify the Observation period as well as the Organizational Structure. The organizational structure differs from clinic to clinic. It defines a hierarchy of Organizational units like Country, Province, City, Municipality, District etc. Once defined, the user can select the DataSets they want to send to DHIS and click on Export to DHIS.

After any exportation, the Organizational Structure is stored as global properties so that the user will not need to redefine it again.


  • Phumzile Khumalo