Integration: Health notifications / Self-service portal

Submitting full or partial event applications into OpenCRVS from an external service such as a health institution or public portal.

An Event Notification client can submit full or partial events to an OpenCRVS office.

When Event Notifications are received in OpenCRVS, they receive the status "Notified", are audited and logged as being received from an automated client, and appear within the Notifications workqueue.

Submitting an Event Notification

With an authorised token, first create an event.

This request will return a response containing the event ID in the id field. You must use this eventId in the subsequent request.

Event Notification Requests

Once the event is creaeted, you can submit the notification.

Example API integration: DHIS2 Annual Conference 2026

During a demonstration at the DHIS2 Annual Conference 2026, OpenFN ran a cron job to monitor new "Tracked Entities" in DHIS2 every 24 hours, then transform the entities into an OpenCRVS Event Notification payload.

The demonstration used hardcoded CRVS_OFFICE and HEALTH_FACILITY ids. These can be dynamically retrieved via the OpenCRVS Location API.

This repository contains example code to submit the notification to OpenCRVS.