Skip to main content

OpenIMIS Adaptor

About OpenIMIS​

OpenIMIS (Open Insurance Management Information System) is an open-source software solution designed to manage health financing schemes such as health insurance, results-based financing, and universal health coverage.

Integration Options​

OpenIMIS supports 2 primary integration options with OpenFn:

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

  2. Webhook: OpenIMIS does not natively support webhooks as a standard feature. However, integrations and custom implementations can enable webhook-like behavior. More details can be found on the OpenMRS documentation page​.

Authentication​

  1. See OpenIMIS docs for the latest on supported authentication methods.
  2. When integrating with OpenIMIS 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:

{
  "baseUrl": "https://demo.openimis.org",
  "username": "test@openfn.org",
  "password": "@some(!)Str0ngp4ss0w0rd"
}
  1. OpenIMIS Documentation
  2. API Reference (REST & GraphQL)
  3. Integration Guide

Implementation Examples​

Coming soon!