v1.3.0: Release notes

New in 1.3

OpenCRVS 1.3 represents a major release of new functional features and technical improvements. The following explains in more detail each major feature that has been included in this release.

Marriage registration - BETA

A new vital event can now be registered. Marriages! Customise you marriage form to start registered marriages (Farajaland default captures bride and grooms details, place of event details, informant details, witness details and signatures for up two witnesses aswell as the bride and grooms). As with birth and death. We offer an API search for marriage events and the ability to create a custom marriage certificate.

BETA release Outstanding marriage related functionality to be built includes: - Searching for marriage events in the UI - Marriage performance analytics - Configurable marriage fees - Marriage corrections - Notification of intent to marry form. Due to this, we are releasing marriage registration in "beta", therefore not for production use. You can configure marriage registration in development environments for proof of concept testing.

Track issuance

Printing certificates off in advance of issuance? Now you can track when they have been issued to the informant. It is important to track when a legal document such as a brith certificate has been issued to the informant. So if registration offices are bulk printing certificates in advance of collection by the informant. The issuance of these certificates can be tracked and audited. Providing a proof that paper certificates get into the hands of beneficiaries. A new workqueue. Ready to issue logs all records with a certificate printed off in advance. This feature can bee configured on/off.

If you decide to print in advance ...
...then you can track issuance

Verify a certificate via QR code

Unsure of a paper certificate authenticity? Now you can compare against civil event record, recorded in your Civil Registration database

A unique QR code on the certificate when scanned by an authorised user can view partial record data. This allows them to compare the data recorded on the certificate against the data in the system to validate it's authenticity. The QR code contains a unique identifier, the "recordId", which via the Record Search API can also be programatically validated by trusted external systems, returning vital event records associated.

Informant signature

Capture a digital signature of the informant to get their consent to submit an event declaration

After a declaration has been completed an informant can review the declaration an then an added their signature. As a digital signature directly into the application or an image of a wet signature can be uploaded. You can configure the informant signature capture on and off for birth and death events. By default marriage events require the participant and witness signatures.

Email notifications

Choose between SMS or email to send registration status updates to the informant and users

Informants can now receive email notifications when their declaration has been reviewed, sent for approval and registered. Users can now receive system notification such as two factor authentication codes via email. The email template is completely customisable so you can choose the messaging and the look and feel.

Data visualisation dashboards

View performance data with interactive data visualisations!

In addition to our performance reports that give you the headline indicator of registration rates, completeness rates etc. You can now choose to view and analyse performance with data visualisations. Powered by the OpenSource Business Intelligence engine Metabase.

De-duplication improved

Easily compare side by side a potential duplicate against existing flagged records

The entire de-duplication user experience has been improved, to be able the user to quickly review potential duplicate records side by side along with supporting documentation. In real-time a declaration sent for review can be flagged as a potential duplicate (powered by Elastics). So that it can easily assessed as a duplicate or not.

MOSIP Integration v2 - E-Signet

Validating identity by continuing our close collaboration with MOSIP

Our close collaboration with MOSIP continues in this release with integration from our vital event forms directly into the E-Signet digital identity authentication and consent mechanism.

Using MOSIP E-Signet integration, parents and informants can have their IDs validated, and consent to share demographic information to pre-populate the registration form. By combining OpenCRVS and MOSIP

MOSIP integration via E-Signet

Plus!

More application settings are now configurable

  • Configurable user roles - can be entirely customised even though they are based on common existing permissions.

  • Choose what informant notifications you want to send

  • Choose a background image or colour for your login splash page


Form configuration refactor

Deprecation of the form configuration UI

Responding to country requests to make form configuration more flexible we decided to revert back to a code only approach thus deprecating our form configuration UI.

To read more about why we made this decision, refer to our documentation step 3.2.7 Configure declaration forms

API validation

We have improved the API validation for all of our interoperability endpoints and provided extra parameters to improve the power and flexibility of our APIs.

Dependency upgrades

Many dependencies have been upgraded, improving performance, resilience and resolving dependabot security alerts. Our Node version has been upgraded.

Refactoring the country configuration package

Our country configuration package has been entirely refactored. Highlights include:

  • Clear directory structure

  • Configurable infrastructure and deploy scripts for use on any infrastructure without the requirement to fork opencrvs-core

  • Documentation in the code

  • More robust API endpoints

  • Flexible form configuration via TypeScript - abstraction of complex utilities

  • Rapid database seeding process

  • Removal of core team internal tools such as cypress tests and data-generator

Performance improvements

Many bugs have been resolved and these are individually listed in the Github release notes. Significant improvements have been made to download speed when assigning a record.

Breaking changes

Breaking changes - core Migration scripts will automatically upgrade your OpenCRVS v1.2 data to be supported in v1.3. Breaking changes that are not supported by automated migrations, or that require manual steps are listed below. Follow the Migration Notes to migrate between versions of core

  • Your countryconfig repository needs to be migrated to the new directory structure.

  • Form configuration UI deprecation requires 1.2 users to export their form via JSON and convert to TypeScript using the functions that we provide.

  • We have upgraded the password hashing mechanism therefore all users will be required to change their password on first login after the ugrade completes.

Documentation updates

The following sections in our documentation have been updated due to the requirements of the new features.

2 Gather requirements

3.2 Set-up your own country configuration

3.3 Set-up a server hosted environment

4 Functional configuration

Need help migrating to 1.3?

If you are migrating from an earlier version and if you are working on behalf of a government that is considering implementing OpenCRVS, we can help you to upgrade.

Please contact us at [email protected]

The following content keys have been added or amended in this release that require translation

Last updated