Skip to content

OpenCRVS - Alpha 3.0

Pre-release
Pre-release
Compare
Choose a tag to compare
@euanmillar euanmillar released this 21 Dec 16:49
· 5679 commits to master since this release

Introduction

OpenCRVS Alpha 3.0 is the final, major Alpha release for OpenCRVS.

This release contains a number of significant and useful new features such as:

  • Legacy civil registration system configuration and validation
  • FHIR standardised Webhooks for notifying external systems of births and deaths - with an example use-case integration with MOSIP - the Modular Open Source Identity Platform
  • Performance and operational dashboards and analytics tools
  • User administration features
  • Integrations with content management systems, such as Contentful.

OpenCRVS Alpha 3.0 also contains a host of bug fixes and UI improvements consolidated from 12 months of live user testing in urban and rural areas in Bangladesh in 2020.. Despite the impact of Covid 19, Plan International have worked extremely hard to successfully pilot OpenCRVS.

The next OpenCRVS release will be an official Beta planned for mid-2021. The Beta may be deemed a full OpenCRVS 1.0, after which point we will begin documenting breaking changes in all future releases.

Major Features

The following features are new in this release and provide a wealth of useful functionality.

Legacy civil registration system configuration and validation

This release contains a configurable "Waiting for external validation" work queue. If OpenCRVS is installed alongside a legacy or 3rd part CRVS system, then it is common that data must be backed up to that system via an API. Depending on the capabilities of the system this may be immediate or batch process. This feature is a work queue and application status that can visualise this step to a registrar. The application is not deemed to be officially registered until it has been "externally validated." It can be optionally enabled using a config variable.

If this config variable is set, OpenHIM will send all new registrations to a batch process queue to be submitted to the legacy system in a configurable format before it is officially registered. Once that legacy system validates successful storage of the registration, the item moves from the "Waiting for external validation" work queue to the CERTIFIED status, a Birth Registration Number is generated (by ether OpenCRVS or the legacy system), and then the registration appears in the "Ready to print" work queue. The birth is registered and a certificate can be printed at any time.

Webhooks and MOSIP integration

This release now contains a new Webhooks microservice. Any registered external system can subscribe and listen to an OpenCRVS event via a Webhook using the W3C WebSub pattern. When a birth or death is registered the webhook contains a payload containing the FHIR Composition ID of the registration, using which you can retrieve all person and event data associated with an event.

To subscribe to a Webhook, register your system with OpenCRVS following these steps.

We have integrated OpenCRVS to MOSIP - the Modular Open Source Identity Platform and configure the birth registration payload to also include all the data required in order to generate a National ID in the FHIR standard.

Follow the detailed documentation to integrate with OpenCRVS Webhooks.

You can see example code for this integration here

New dashboards and performance analytics tools

This release includes new Operational, Audit and Performance Management Reports with various ways to search and filter nationwide analytics. System Administrators can now access and visualise reports to track the success of the national registration programme against estimates. View the time taken to complete applications by individual staff members, and understand trends in any missing data in in-progress applications.

System administrators can understand which registration questions are difficult for Field Agents to get data for from recipients and therefore understand which questions may be holding back registration rates.

Using these tools, administrators can understand where applications are started, view registration rates by status over time and by location.

User administration features

System administrators can audit many user interactions and manage a user's status and access. It is possible to deactivate a user, tracking a reason and blocking all access to the user, then reactivate a user after an all clear. This functionality helps OpenCRVS conform to ISO27001 security standards.

All user details can be updated by a system administrator and It is now possible to recover a lost PIN.

Integrations with content management systems

In this release you can configure an external content management system such as Contentful. We have provided some handy tools to help you import your languages, preview, publish and easily manage all application text and SMS messages in multi-language.

Screenshot 2020-12-21 at 16 13 37

Full Zenhub release report