Skip to main content

OpenHIM Adaptor

About OpenHIM​

OpenHIM (Open Health Information Mediator) is an open-source, middleware solution designed to facilitate interoperability between health information systems. It acts as a mediator, handling data transformation, validation, and routing between various systems.

Integration Options​

OpenHIM supports 2 primary integration options with OpenFn:

  1. Rest API: OpenHIM has a REST API that enables external services like OpenFn to pull data from OpenHIM, or push data from external apps to OpenHIM. This option is suited for scheduled, bulk syncs or workflows that must update data in OpenHIM with external information. See functions for more on how to use this adaptor to work with the API.

  2. Webhook: Webhook or Data Forwarding to push data from OpenHIM to external systems (see docs). This option is suited for real-time, event-based data integration.

Authentication​

  1. See OpenHIM docs for the latest on supported authentication methods.
  2. When integrating with OpenHIM via OpenFn, there is one primary authentication method that is supported: Basic Authentication. See this adaptor's Configuration docs for more on the required authentication parameters.

See platform docs on managing credentials for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:

{
  "apiUrl": "http://openhim.com/api"
}
  1. OpenHIM Documentation
  2. OpenHIM API Reference

Implementation Examples​

Coming soon!