DHIS2 Integration Toolkit
Explore our collection of free and open-source tools, reference implementations, and informational resources designed to support DHIS2 integration and interoperability.
Jump to a section on this page
Overview
The DHIS2 Integration Toolkit is a growing collection of open-source resources curated by the integration team at HISP UiO to facilitate integration and interoperability with DHIS2 and support the effective use of global standards like FHIR. It includes several code artefacts that you can download and install on your local systems as well as reference implementations that you can use to guide your local integration patterns.
If you have questions, comments, or contributions, you can share your input in the Interoperability forum on the DHIS2 Community of Practice, or contact the integration team at integration@dhis2.org
Integration Tools & Components
These open-source tools can be used to support various DHIS2 integration use cases.
DHIS2-RapidPro
A stand-alone middleware solution that integrates DHIS2 with RapidPro, allowing for synchronizing users, transferring aggregate data and sending automated reminders.
DHIS2 Java SDK
An Android-compatible Java library that allows you to write code quickly and accurately based on DHIS2 terminology.
Camel DHIS2 Component
An Apache Camel module that allows developers to integrate Camel middleware applications with DHIS2.
Camel Archetype DHIS2
Quickly bootstrap an app with Apache Camel in order to help you get started with your DHIS2 integration software project.
DHIS2 Python Client
The DHIS2 Python Client is a lightweight yet powerful library designed to connect DHIS2 with the wider data science ecosystem.
DHIS2 Climate Tools
An open, collaborative toolkit for accessing, processing, and integrating climate, weather and environmental data into DHIS2 and the Chap Modeling Platform.
Integration Examples
Browse our catalog of code examples for DHIS2 integration. These illustrative examples are meant to offer guidance and can be adapted for local use.
- DHIS2 organisation units, option sets, and tracked entities to their FHIR counterparts: This Apache Camel application shows how DHIS2 resources can be turned into their FHIR counterparts and pushed as bundles to a FHIR server. Explore
- DHIS2 organisation units to its FHIR counterpart using DataSonnet for mapping the resources: This Apache Camel application shows how DHIS2 resources can be mapped into their FHIR counterparts with DataSonnet and pushed as bundles to a FHIR server. Explore
- Data value set synchronization between two DHIS2 instances using the DHIS2 Java SDK: This example leverages the DHIS2 Java SDK to fetch data value sets from a DHIS2 instance and save them to a different DHIS2 instance. Explore
- DHIS2 tracked entities to FHIR questionnaire responses: This Apache Camel application is a proof-of-concept that fetches adverse events following immunization (AEFI) from DHIS2 and turns them into FHIR questionnaire responses before proceeding to push these questionnaire responses onto a FHIR server. Explore
- Automating DHIS2 integration testing: DHIS2 releases are already published as Docker images to Docker Hub. This example demonstrates how a project integrating DHIS2, such as connecting DHIS2 with another data collection tool, can have its tests automated with Docker. Explore
Reference Implementations
A reference implementation is an artefact guiding implementers towards developing their own solutions for common use cases.
Organisation Unit Synchronization
This reference implementation performs one-way synchronization of organisation units, org unit groups, and org unit group sets. It addresses common use-cases and requirements we have heard relating to the recurring challenge of syncing org units between DHIS2 instances as well as non-DHIS2 services.
Civil Registry Lookup
In this reference implementation, we demonstrate a fully functional, self-contained example of a DHIS2 Capture enrollment form that looks up as well as transforms personal identifiable and demographic citizen information from a FHIR-based civil registry, before pre-filling fields with this information in a patient form.
Laboratory Interoperability
This reference implementation presents a working integration between a Laboratory Information System (LIS) and a DHIS2 Tracker program, leveraging FHIR for semantic interoperability, which is designed to support timely lab result reporting for a case-based disease surveillance program. A similar approach could be used to automate entry of lab results into an electronic medical record (EMR) or e-Registry based on DHIS2.
MOSIP-DHIS2 Integration (draft)
This reference implementation demonstrates an integration between MOSIP and DHIS2, where both patients and health care providers can verify their identity with a common ID provider service. It also incorporates a shared electronic health registry (EHR), and demonstrates how using the EHR and a common ID provider across different digital health services can promote continuity of data across the health sector.
Integration Platforms
HISP UiO has developed standalone open-source platforms to support integration with DHIS2 to enhance its functionality for geospatial data analysis and predictive modeling.
- Open Climate Service: An open-source platform to support integration and harmonization of geospatial datasets for DHIS2 and other clients. Explore
- Chap Modeling Platform: A flexible and open platform for connecting and running predictive models with data from DHIS2 and other sources and sending outputs to DHIS2. Explore
Documentation & Resources
The following resources and guidance are available to support DHIS2 integration projects.
- DHIS2 Documentation
- DHIS2 Webinars & Presentations
- DHIS2 Community of Practice