OpenMRS-DHIS2 Integration Module - User Guide
Understanding the Reporting module's terminology
This module is completely integrated with the reporting module and hence interacts with it very closely. To understand what is happening in this module, the user needs to have some basic knowledge of reporting module.
Let us take an example and understand the working : consider we need two sample reports such as (a) People in WHO stages disaggregated by sex and age. (b) New patients disaggregated by CD4 count.
WHO Stage 1 – Disaggregated by [Sex-Age][Male, Female – Child, Teen, Middle, Old]
WHO Stage 2 – Disaggregated by [Sex-Age] [Male, Female – Child, Teen, Middle, Old]
New Patients – Disaggregated by [CD4 count][CD4>250,CD4<250]
Each case is finally a report in OpenMRS and for creating the report there are some basic blocks such as Indicators , Dimensions, Data Set Definitions and Base cohort. The following image will explain how each part is divided and how they constitute a report.
As indicated in the above diagram.
WHO stages and New patients which constitute the main part of the report are categorized as indicator cohorts.
The Combo's such as [Sex-Age] and [CD4 count] are categorized as Data set definitions.
Each individual component in the combo's such as Sex, Age , CD4 count are grouped as Dimensions. They in turn are divided into Dimension options such as [Male, Female] for Sex, [Child, Teen, Middle Aged, Senior Citizens ] for Age and [CD4>250, CD4<250] for CD4 count.
The parameters such as Location , Start and End date are usually considered as Base cohort reducing the report base. Which can be customized to a specific cohort based on user preference.
What is actually happening?
OpenMRS objects are colored blue.
DHIS2 objects are colored yellow.
The arrows indicate sets of DHIS2 and OpenMRS objects that relate to each other.
The places where the user interaction is necessary is mapping
Org unit mapping to OpenMRS locations
Data elements to Indicator Cohorts
Options to Dimension value Cohorts
Mapping the base cohort(optional)
Entering the parameters for the report.
The interactions such as reports generation , report data transmission and mapping of sets not mentioned above are done automatically using the API.
Module Usage Guide
The following are the screenshots of the module and they describe the usage and different functions available for the user to perform.
1.Server Administration page :
To Add a Server :
Click on "Add New" button. A new window will open on the screen to enter the details as shown in the below figure.
2. Enter the valid details as shown in the below figure. Name Must be unique as it will separate each DHIS server. The url, username and password are the details of the DHIS server. Transport is where the results/reporting data will be sent.
3. Click on Save and the server is created.
To Edit a Server :
Click on the (paper and pencil) symbol under the Actions column in the server Administration page to edit the server.
Change the details you would like to and click on save.
To Test the connection details :
Use this option right after entering the details of the server and confirm if the details are valid.
Click on (lightning) symbol under the actions column.
The connection status will be shown.
To Update the metadata :
Use this option right after you enter the server details and test the connection. And if there is any change in the data structure of the DHIS server.
Click on(download) symbol under the actions column.
The data will be updated.(or the error details will be displayed)
To Delete the Server :
Click on (trash can) symbol to delete the server.
Click on OK on the confirmation message.
2. Location Mapping page(Click on (map icon) in the Server Administration Page) :
Description :
Left side list represents the list of Org units.
Right side list represents list of OpenMRS locations.
The table in between the lists is where the mapping is managed.
Mapping an Org unit to OpenMRS locations :
To a single Org Unit multiple OpenMRS locations can be mapped.
Select the org unit you would like to map from the list of Org units.
Click on the Right side pointing arrow in between the org unit list(left side list) and the Location Mapping table.
The Org unit will get added to the list. By default the latest added org unit will be auto selected and the radio button would be selected right beside it.
Now select the OpenMRS location from the OpenMRS location list (right side list) you would like to map to the org unit.
Click on the Left side pointing arrow in between the Locations list(right side list) and the locations mapping table.The location will be added in the right side column of the corresponding cell of the Org Unit.