You are viewing functional documentation that reflects OpenCRVS configured for the Zambia and Bangladesh contexts. In order to use OpenCRVS in your country you will need to configure your own Resources Package that will make OpenCRVS work for you e.g. show the right form fields, include the right users, show the right reference data, and conduct the right client-side validations on things like phone numbers.

What you need to configure OpenCRVS in your country#

To configure your resources package, follow the technical documentation and the instructions detailed in GitHub for an example configuration for Zambia.

The resources package allows you to edit the following items:

  • Default, factory settings database backup zips containing development users, facilities and administrative locations for the nation saved as FHIR resources.
  • Birth and Death registration form configuration as JSON
  • Birth and Death certificate PDF templates as JSON
  • Internationalised text as JSON
  • SMS gateway provider selection between Clickatell & Infobip
  • Country specific environment variables in Docker compose files
  • Country specific client config variables in .js files
  • Logo for the Civil Registrar department that appears on the certificates and on the review page of the UI
  • Any 3rd party API interoperability integrations you require into your OpenCRVS core from

How to get ready for configuration#

Before you configure OpenCRVS for your context, we suggest spending some time to understand your country's needs and shape your requirements for your version of OpenCRVS around that. A good way of doing this is:

1. Use the CRVS Digitisation Guidebook to analyse and design your digitized CRVS system.

2. Conduct a Proof of Concept

A proof of concept (PoC) is a demonstration, the purpose of which is to verify that certain concepts or theories have the potential for real-world application. The OpenCRVS PoC is therefore a version of OpenCRVS that is designed for you to determine applicability for your context. It requires 3-4 months (depending on your requirements) and the result is a version of OpenCRVS ready for testing in your country. The country configuration will be based on:

  • Design research: speak to a range of civil registration service providers, stakeholders and customers to establish how the civil registration system should work for them. Civil registration needs to be easy.
  • Requirements: these are outlined in the resources package above.