Open Source reference implementation of OSIA in collaboration with X-Road and UNDP

Description

The use case for the reference implementation revolves around the efficient registration of newborns by the Civil Registry (CR) and its synchronization with the Population Registry (PR). This collaborative effort between the CR and PR ensures proper documentation and sets a solid foundation for the newborn's identity.

More information about this Use Case can be found here

To implement this Use Case the following building blocks are necessary:

• A Population Registry: UNDP provides DGIT as a possible Population Registry. The directory pr-mock contains an implementation of some services from the PR and Data Access interfaces.
• A UIN generator: the directory uin contains an implementation of the OSIA UIN Management interface.
• A notification service: the directory notification contains an implementation of the OSIA notification interface.
• An orchestrator: the directory orchestrator contains a service able to dispatch calls to OSIA interfaces in order to implement a Use Case.
• A Civil Registry: UNDP provides DGIT as a possible Civil Registry. The directory cr-mock contains a set of scripts to simulate a Civil Registry interacting with the different servers according to the birth use case.

To secure the exchanges between the Civil Registry and the Population Registry, X-Road is used. X-Road® is open-source software and ecosystem solution that provides unified and secure data exchange between organisations. The source code is available in GitHub.

All exchanges are compliant with OSIA specifications and are depicted in the following diagram:

Execution

Start the servers with:

docker system prune -f
docker-compose up --build --force-recreate

Start the CR client with:

python3 -m venv .py
source .py/bin/activate
pip install -r requirements.txt
# insert dummy data for the parents
python insert_data.py
# declare a new birth
python cr_birth.py

Check the Population Registry content at http://localhost:8100/pr