Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(#1465): merge all Integrations pages under Building #1766

Merged
merged 6 commits into from
Feb 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions content/en/building/features/integrations/_index.md

This file was deleted.

19 changes: 0 additions & 19 deletions content/en/building/features/integrations/openmrs.md

This file was deleted.

37 changes: 0 additions & 37 deletions content/en/building/features/integrations/oppia.md

This file was deleted.

36 changes: 0 additions & 36 deletions content/en/building/features/integrations/rapidpro.md

This file was deleted.

4 changes: 2 additions & 2 deletions content/en/building/features/supervision/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ keywords: supervisor
relatedContent: >
building/targets/targets-overview
design/best-practices/#targets
building/features/integrations/dhis2
building/integrations/dhis2
building/reference/app-settings/transitions#create_user_for_contacts
exploring/supervisor-reference-app
aliases:
Expand Down Expand Up @@ -121,7 +121,7 @@ The data that can be visualized is highly configurable, and depends on what data

## DHIS2 Data Verification

Supervisors often provide a critical bridge between CHWs and broader health system reporting. Using the CHT’s [DHIS2 integration]({{< relref "building/features/integrations/dhis2" >}}), Supervisors can see the aggregate of each DHIS2 Data Value across all CHWs in their area. By tapping on a target, they can also see each CHW’s contribution towards that total. Once the Supervisor has verified data accuracy with CHWs, they can communicate with Health Records Information Officers to feed data into the national health information system.
Supervisors often provide a critical bridge between CHWs and broader health system reporting. Using the CHT’s [DHIS2 integration]({{< relref "building/integrations/dhis2" >}}), Supervisors can see the aggregate of each DHIS2 Data Value across all CHWs in their area. By tapping on a target, they can also see each CHW’s contribution towards that total. Once the Supervisor has verified data accuracy with CHWs, they can communicate with Health Records Information Officers to feed data into the national health information system.

{{% alert title="Note" %}} DHIS2 integration was introduced in v3.9. {{% /alert %}}

2 changes: 1 addition & 1 deletion content/en/building/guides/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Quick Guides for Implementers"
linkTitle: "Quick Guides"
weight: 11
weight: 15
description: >
These quick guides address focused CHT app development topics
aliases:
Expand Down
11 changes: 0 additions & 11 deletions content/en/building/guides/integrations/_index.md

This file was deleted.

4 changes: 2 additions & 2 deletions content/en/building/guides/messaging/gateways/rapidpro.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ aliases:
---


As of v3.11.0, messages can be sent and received using [RapidPro]({{% ref "building/features/integrations/rapidpro" %}}) as a messaging gateway.
As of v3.11.0, messages can be sent and received using [RapidPro]({{% ref "building/integrations/rapidpro" %}}) as a messaging gateway.

## RapidPro configuration

Expand Down Expand Up @@ -66,7 +66,7 @@ Create a trigger (`/trigger/`) to start the new flow when a message is not handl

![trigger_select](trigger_select.png)

For more details about RapidPro configuration, please consult the [RapidPro integration documentation]({{% ref "building/guides/integrations/rapidpro" %}}).
For more details about RapidPro configuration, please consult the [RapidPro integration documentation]({{% ref "building/integrations/rapidpro" %}}).

## CHT Core configuration

Expand Down
14 changes: 14 additions & 0 deletions content/en/building/integrations/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Integrations
linkTitle: "Integrations"
weight: 12
description: >
How to build integrations with external software and data sources
aliases:
- /building/guides/integrations/
- /building/features/integrations/
- /apps/guides/integrations/
- /apps/guides/integrations/best-practices
- /apps/features/integrations/
---

Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
---
title: "Android"
weight: 1
weight: 2
description: >
Launch the Android App with a link or from another app
relatedContent: >
building/reference/app-settings/token_login
building/reference/app-settings/assetlinks
aliases:
- /apps/features/integrations/android
- /building/features/integrations/android
---

The [CHT Android application](https://github.com/medic/cht-android) can be launched by clicking on a link or invoking an intent in another Android app. This is useful for enabling login by SMS, directing a user to a specific page, and integrating between Android applications.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
title: "Custom"
weight: 1
description: >
Integrate with any system using RESTful APIs
Integrate the CHT with other systems using RESTful APIs
keywords: generic, custom, integrations
aliases:
- /apps/features/integrations/generic/
relatedContent: >
building/features/integrations/dhis2
building/features/integrations/rapidpro
building/features/integrations/openmrs
building/integrations/dhis2
building/integrations/rapidpro
building/integrations/openmrs
aliases:
- /apps/features/integrations/custom
- /building/features/integrations/custom
- /apps/features/integrations/generic/
---

The CHT Core Framework includes functionality that allows sharing data with any API-based system. Developers have configured CHT integrations with OpenMRS, KenyaEMR, Bahmni, DHIS2, RapidPro, Apache NiFi, OpenHIM, custom electronic medical records (EMR), and several other systems.
Expand All @@ -29,7 +29,7 @@ Below are a few example integration use cases:
3. **Contact Tracing**: Similar to Lost to Follow-Up, the EMR generates a list of contacts to be followed up with and this is sent to the CHT so that a tracer can call those contacts to see if they have symptoms.
4. **Interactive Messaging**: Integrate with a messaging platform (such as RapidPro) to allow community members to initiate self-screening assessments, which can then be sent to the CHT for follow-up by a healthworker.

As you design your use cases, creating a [sequence diagram](https://www.websequencediagrams.com/) will be helpful in illustrating what the flow will look like. [Here]({{< ref "building/guides/integrations/rapidpro#sequence-diagrams" >}}) is an example sequence diagram for an integration use case with RapidPro.
As you design your use cases, creating a [sequence diagram](https://www.websequencediagrams.com/) will be helpful in illustrating what the flow will look like. [Here]({{< ref "building/integrations/rapidpro#sequence-diagrams" >}}) is an example sequence diagram for an integration use case with RapidPro.

## Integration Design Patterns

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
---
title: "DHIS2 Aggregate"
linkTitle: "DHIS2 Aggregate"
weight:
weight: 4
description: >
Design considerations and how to configure
Design and configure DHIS2 Aggregate
keywords: dhis2
relatedContent: >
building/features/integrations/dhis2
building/integrations/dhis2
building/reference/app-settings/dhis2
aliases:
- /apps/guides/integrations/dhis2-aggregate
- /building/guides/integrations/dhis2-aggregate
---

One of the first things you’ll need to do is identify the specific [DHIS2 data set](https://docs.dhis2.org/2.34/en/dhis2_implementation_guide/data-sets-and-forms.html#what-is-a-data-set) that you plan to implement. You’ll need a list of all the [data elements](https://docs.dhis2.org/2.34/en/dhis2_implementation_guide/data-elements-and-custom-dimensions.html#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](https://docs.dhis2.org/2.34/en/dhis2_implementation_guide/organisation-units.html) 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](https://docs.dhis2.org/2.34/en/dhis2_implementation_guide/integration-concepts.html#integration-concepts).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
---
title: "DHIS2"
weight: 1
weight: 3
description: >
Send aggregate, patient, and event data to DHIS2
keywords: dhis2
relatedContent: >
building/guides/integrations/dhis2-aggregate
building/integrations/dhis2-aggregate
building/reference/app-settings/dhis2
aliases:
- /apps/features/integrations/dhis2
- /building/features/integrations/dhis2
---

Most health systems have regular reporting requirements for community-level activities. Health workers often carry around heavy logbooks to manually record all relevant activities. When it is time to submit their data, community health workers (CHWs) summarize what was recorded in their logbooks and share this information with their supervisors, who in turn create paper records of these totals across entire community units or health facilities. This paper record is often passed to yet another individual whose responsibility is to manually key in the data into a health information management system, such as DHIS2.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
---
title: "OpenMRS"
linkTitle: "OpenMRS"
weight:
weight: 5
description: >
Exchange patient-level data with systems based on the OpenMRS platform
keywords: openmrs
relatedContent: >
building/features/integrations/custom
building/features/integrations/openmrs
building/integrations/custom
aliases:
- /apps/guides/integrations/openmrs
- /building/guides/integrations/openmrs
- /apps/features/integrations/openmrs
- /building/features/integrations/openmrs
---

[OpenMRS](https://openmrs.org) is an open source electronic medical record system used in dozens of countries. Integrating CHT apps with OpenMRS can open up opportunities to improve health outcomes for patients by promoting better coordination of care. For example, referrals by CHWs in the community can be sent electronically to health facilities using OpenMRS so that nurses and clinicians can prepare for their visit and have full access to the assessment done by a CHW.

Integrating CHT apps with OpenMRS can be achieved using the [OpenMRS REST API](https://rest.openmrs.org/) and following the guidance in the [Custom Integrations]({{< ref "building/features/integrations/custom" >}}) documentation.
Integrating CHT apps with OpenMRS can be achieved by following [this guide]({{< ref "building/integrations/openmrs" >}}), which leverages the [OpenMRS REST API](https://rest.openmrs.org).

## Overview

Expand Down
Loading