Building > Features > Integrations > DHIS2
Send aggregate, patient, and event data to DHIS2
One of the first things you’ll need to do is identify the specific DHIS2 data set that you plan to implement. You’ll need a list of all the data elements on that data set, a detailed understanding of how each is calculated, the frequency in which the data set is submitted (weekly, monthly, etc…), and for which organisation units the data set applies. You’ll also want to identify and engage the appropriate DHIS2 stakeholders to get access to DHIS2 metadata, test environments, and discuss workflows. The DHIS2 documentation site provides additional background and advice here.
There are a few very important considerations related to how you design workflows and set up your CHT application to make sure you will be able to integrate with DHIS2. The main areas are:
These considerations are summarized below.
The CHT relies on your Place hierarchy to determine how data should be aggregated for DHIS2. As such, it’s important that you consider how organization units are configured in the DHIS2 instance that you need to integrate data into. If your CHT Place hierarchy does not align with the DHIS2 organisation unit structure, the CHT will not be able to aggregate data in the way DHIS2 needs it.
See Also: Hierarchies
It’s important to understand each data element on the DHIS2 data set you want to integrate data into and how each data element is calculated. When you are designing your forms in the CHT, you will need to make sure you are capturing information in your forms so that every data element on the chosen DHIS2 data set can be calculated within the CHT.
See Also: Forms
The aggregate data workflow is really designed around 3 key user personas. You’ll need to make sure that your context can support those assumptions and will be able to have access to the appropriate features in the CHT and DHIS2.
Moving data from the CHT to DHIS2 can be done in three main ways.
Once you have designed your hierarchies, forms, calculations, and workflows, there are a few key configurations that need to be made.
For the CHT to be able to export the file for DHIS2, it needs to know the specific name and ID of the data set in DHIS2. You will need to obtain the ID from the test or production DHIS2 environment.
Configure the data set in app_settings.json
.
See Also: DHIS2 in App Settings
Aggregation in the CHT is based on your Place hierarchy. As mentioned in the Hierarchies Design Considerations above, your Places must align with DHIS2 organisation units. You will need to specify the DHIS2 organisation unit’s ID on the Place document in the CHT.
dhis.orgUnit
attribute.See Also: Contact Forms
{
"_id": "my_place",
"type": "health_center",
"dhis": {
"orgUnit": "HJiPOcmziQA"
}
}
Calculations for DHIS2 indicators are done using CHT Target functionality. For each DHIS2 data element, you will need to configure a corresponding CHT Target and specify the ID of the DHIS2 data set and data element. If you do not include the data set, this data element will be included in every data set.
targets.js
, configure one or more data elements by setting the dhis.dataSet
and dhis.dataElement
attributes in the target schema.See Also: Targets
module.export = [
{
id: 'births-this-month',
type: 'count',
icon: 'icon-infant',
translation_key: 'targets.births.title',
subtitle_translation_key: 'targets.this_month.subtitle',
goal: -1,
appliesTo: 'contacts',
appliesToType: ['person'],
appliesIf: contact => !!contact,
date: (contact) => contact.contact.date_of_birth,
dhis: {
dataSet: 'VMuFODsyWaO',
dataElement: 'kB0ZBFisE0e'
}
},
];
For the HRIO role, create a new user role and a new user with that role; or update an existing user role. To export DHIS2 metrics, users need to have the following permissions: can_configure
, can_export_all
, and can_export_dhis
.
See Also: Users
Once your CHT project is configured to integrate with DHIS2, follow these steps to export the data from CHT and import it into DHIS:
Check the UI for any errors. If you get errors you don’t understand or are unable to resolve an error, you can always ask for assistance on the CHT Forum. If there are no errors, you can review the numbers that resulted by reviewing the data set in DHIS2.
Send aggregate, patient, and event data to DHIS2
DHIS2 Integration: Instructions and schema for defining DHIS2 integrations
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.