Bahmni - DHIS2 Integration

Please note, this is a contributed module from community. Bahmni, as of v0.92, does not bundle/package this as part of it distribution. Please contact "Possible Health" team for additional information. 

Install and configure DHIS2 integration app

Assuming you have Bahmni installer latest version installed and running successfully. (Tested with 0.89 version, should work with previous version as well)

  1. Download and install dhis-integration rpm from (or build latest yourself from here:

    yum install dhis-integration-1.0-1.noarch.rpm
  2. Update the properties file for DHIS2 integration app, located at '/etc/dhis-integration/dhis-integration.yml', with right configuration.

    openmrs.root.urlUrl to access Openmrs servicehttp://localhost:8050/openmrs/ws/rest/v1
    bahmni.login.urlWhen user isn't logged in, then user is redirected to this url.

    reports.urlBahmni reports url. Used for downloading reports.

    This file contains configurations of DHIS2 reports.

    dhis.config.directoryThis folder contains DHIS2 integration configurations program wise./var/www/bahmni_config/dhis2/
    dhis.urlThe DHIS2 government server instance url.

    Ex. 1:

    Ex. 2:

    Note that the url could be at domain or ip address level (ex1) or could be at a specific path(ex2)

    dhis.userThe username to access DHIS2 instance.


    dhis.passwordThe password for the DHIS2 user.


    openmrs.db.urlMysql connection url to access "openmrs" database. Set valid user and password in the url.


    submission.audit.folderAll DHIS2 submissions are stored in this directory. Ensure the directory exists and "bahmni" user has access to it, or configure a different directory.


    server.portServer config. Port for server to listen to.


    server.context-pathServer config. Mapping incoming requests.


    log4j.config.fileServer config. Properties file for logger of dhis-integration server.

  3. Download and place the ssl.conf file.

    cd /etc/httpd/conf.d/
  4. Configure Bahmni landing page to show DHIS2 integration app.
    Insert the following in "/var/www/bahmni_config/openmrs/apps/home/extension.json" file

    "possible_dhis_2_integration": {
    	"id": "possible.dhis2Integration",
    	"extensionPointId": "org.bahmni.home.dashboard",
    	"type": "link",
    	"label": "DHIS2 integration",
    	"url": "/dhis-integration/index.html",
    	"icon": "fa-book",
    	"order": 11,
    	"requiredPrivilege": "app:reports"
  5. Ensure Bahmni reports service is installed and running successfully.

    service bahmni-reports status ##should be running
  6. Restart ssl and dhis-integration services.

    service httpd restart
    service dhis-integration restart

    Now the DHIS2 integration app is available on landing screen, given that the user has reporting privileges.


           Once you open the app you land on DHIS integration app page, where you select the month and year for given program, type a comment and submit report.


Configure New Program 

  1. Configure the concatenated reports for the program
  2. Put the following configuration in the concatenated report to make it DHIS2 program.

    "DHISProgram": true,

    Example: Safe motherhood program

  3. Create a DHIS configuration file for the program with the name of program under '/var/www/bahmni_config/dhis2/' folder.
    1. To use different folder change '' configuration at '/etc/dhis-integration/dhis-integration.yml'.
  4. DHIS configuration file should have the following structure.

    DHIS Config
      "orgUnit": "<orgUnitId | find it from DHIS instance>",
      "reports": {
        "<name of 1st sub report | find it from reports.json>": {
          "dataValues": [
              "categoryOptionCombo": "<category option combination id | find it from DHIS instance>",
              "dataElement": "<data element id | find it from DHIS instance>",
              "row": <row number of the cell | find it from output of the SQL report>,
              "column": <column number of the cell | find it from output of the SQL report>
              "categoryOptionCombo": "<category option combination id | find it from DHIS instance>",
              "dataElement": "<data element id | find it from DHIS instance>",
              "row": <row number of the cell | find it from output of the SQL report>,
              "column": <column number of the cell | find it from output of the SQL report>
            ............more data element mappings............
        "<name of 2nd sub report | find it from reports.json>": {
    	  "dataValues": [......]
        "<name of 3rd sub report | find it from reports.json>": {
    	  "dataValues": [......]
        ............more sub report mappings............
  5. An example configuration for Safe Motherhood program will look like the following
  6. Example: Safe motherhood program

orgUnitThis is the organisation unit ID from DHIS


This is list of reports which are the inner reports of concatenated report of the program. Each report name is a unique key in this object.

'Antenatal Checkup' is one of the inner reports configured in concatenated report, for example.


This is list of data element mappings. Each mapping maps a cell in SQL output to a dataElement in DHIS.


This is the 'category option combination id' of the dataElement in DHIS.

dataElementThis is the 'data element id' of the dataElement in DHIS.
row and columnThis 'row and column' numbers refers to a particular cell in the output of configured SQL.

Notes: To find out the orgUnit Id, dataElement Id, category option combo Id do the following:

  1. Access the DHIS2 government server in your browser.
  2. Open data entry apps and select appropriate organisation and location.
  3. Once the data entry forms are visible, click on the input boxes where you enter the data.
  4. Right click on the input box and select "Inspect" from the options.
  5. Copy the Id of the html element from window (See image), it would look like the following string: "kSnqP4GPOsQ-kdsirVNKdhm-val".
  6. This string is in the format of "dataElementId - categoryOptionComboId - ...."
  7. These dataElementId and categoryOptionComboId need to be used in DHIS2 configuration file. Refer the below image.

The Bahmni documentation is licensed under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)