An introduction describing how OpenCRVS interoperates
OpenCRVS has been technically architected from conception to interoperate with other e-Gov systems in a standardised, safe and secure way.
We have demonstrated how easy it is to interoperate with OpenCRVS in the past by:
Using the OpenCRVS v1.2.* Integrations GUI to configure a webhook client
As of OpenCRVS v1.2.* we now provide a simple GUI to set up, enable and disable integrating clients that generates and refreshes API keys.
There are 4 common interoperability use cases you can easily take advantage of using our new GUI and specific API Gateway endpoints in JSON and GraphQL.
- 1.Event Notification: Allow any other service to POST full or partial civil registration event applications to OpenCRVS - referred to in civil registration nomenclature as a "notification". Most commonly these are submitted by hospitals, but you could also use this functionality to enable application submission from a social protection system or a public portal.
- 2.National ID: Ensure a National ID system is notified by a webhook whenever an event (birth or death) is registered in OpenCRVS. Use this to create or deactivate National ID numbers, or use it to authenticate citizens before allowing them to register an event.
- 3.Record Search: Allow any other service to perform an advanced search of civil registration records. Use this to help support social protection systems, check the existence of civil registration records or check citizen demographics.
- 4.Webhook: Allow any other system to subscribe to event in OpenCRVS and retrieve a customisable payload of registration data. Allow any system to react immediately when a birth or death is registered.
The following sections will describe step-by-step instructions regarding how to configure these integrations as well as show you how you can expose OpenHIM to have full interoperability control over OpenCRVS.
Other ways to interoperate
OpenCRVS' database layer for all registration data is expressed in JSON as FHIR in MongoDB and exposed via a FHIR database server called Hearth. This means that our schema is automatically thoroughly documented in the HL7 FHIR specification. We have made some customisations to support the civil registration context hat are documented in the standards section. We knew how important it would be for health institutions to be able to send us birth and death notifications from the beginning, hence our early adoption of FHIR as our interoperability standard. This also makes it easy for interoperating systems to understand our data.
We expose some FHIR APIs directly via our API Gateway, specifically for performing CRUD actions on FHIR Locations which we use for administrative structure, civil registration and health office buildings where registrations occur. When OpenCRVS is running you can view Swagger documentation in this Gateway.
OpenCRVS stack includes OpenHIM. The Open Health Information Mediator is a middleware component designed to ease interoperability between disparate information systems. Both OpenHIM and Hearth are OpenSource projects developed by Jembi Health Systems. It is possible to expose direct access to OpenHIM in OpenCRVS Core, should you wish to interoperate with it.