Civil Registry Lookup in Capture – Reference Implementation

A common need when entering individual data in DHIS2 is to look up a person in a civil registry and autofill information from the registry in the DHIS2 entry form. This can help make data entry faster, easier, and more consistent across services. By default, the Capture app doesn’t include such a feature, but the plugin extension point in data entry forms enables us to build in a “mini app” to do this lookup.

To support implementations wanting to implement such an interface and integration, the DHIS2 core team created a reference implementation of an integration between DHIS2 and a civil registry that uses a Capture form field plugin, a mediator component to communicate with the external registry, and an Route to communicate from the plugin to the mediator.

This reference implementation is designed to model effective integration practices and comes with thorough documentation, including about particular considerations when setting up such an integration for real use cases. It’s been reviewed for security robustness and includes guidance in that area as well. The reference also comes with a ready-to-run Docker setup with an example civil registry and authorization server to show the end-to-end functionality.

In this webinar, we’ll walk through the reference implementation and give a demo, describe the decisions and considerations that went into it, and share how it can be a launching point for implementations wanting to implement such an integration themselves.

This pattern also works for other integrations from the Capture app to external services; come learn and be inspired!

Register Now