1 of 9

Configuration Management Via ETCD

Making changes to DIVOC’s certificate module via etcd

We have added etcd as a configuration management tool for DIVOC. This makes it easier for implementing partners to add new vaccines, edit templates or the QR code payload, as well as add new configurations without deploying any components. Use any etcd client that you like - for example, the . Following are the steps to set up the etcd-manager:

Open the URL:

Adding a New Vaccine and ICD-11 Mapping

There are different International Classification of Diseases (ICD) codes based on the category of vaccines. To add a new vaccine, identify the ICD-11 code to which the vaccine belongs. Once you have mapped the vaccine to the relevant ICD-11 code, you can update the vaccine name and its ICD-11 mapping in etcd.

Steps to update the vaccine name and its ICD-11 mapping:

Go to the Manage keys tab of the etcd-manager app. To add or update mappings, two keys must be updated: “VACCINE_ICD” and “ICD.”
To add the vaccine name, ICD-11 code, and description VACCINE_ICD, go to VACCINE_ICD and click on the Edit key.

- Example of VACCINE_ICD value for Covaxin:

{“vaccineName”: “covaxin”, “icd11Code”: “XM1G90”}

Click on Save. A popup will appear as “operation successful.” Click on Close.

Click on the edit button of the “ICD” key to add ICD-11 code and click on the Edit key.

- Example of ICD value for Covaxin:

{“XM1G90”: {“vaccineType”: “inactivated virus”, “icd11Term”: “COVID-19 vaccine, inactivated virus”}}

Click on Save. A popup will appear as “operation successful.” Click on Close.

Make the certificate generation request call and fetch the certificate to test the changes. Once updated, any new certificate can be issued using the new vaccine name.

All content on this page by is licensed under a .

Adding a New Vaccine and ICD-11 Mapping Using ETCD CLI

Using ETCD CLI, the same can be dynamically updated in two files (VACCINE_ICD.json and ICD.json) without any service deployments.

Steps to update the vaccine name and its ICD-11 mapping:

Go to the specific folder where etcd files are available.
Open the files to add the new vaccine.
Run the command: vim VACCINE_ICD.json.

Run the command: vim ICD.json.

To reflect the change, run the command: ./updateConfigs.sh. It shows "OK OK OK...." This means that the etcd has been updated with new vaccine list successfully.

Create the certificate and generate the PDF with the new vaccine.

All content on this page by is licensed under a .

PDF Template Change for Vaccine Certificates

Any template-related changes can be done by updating the HTML template in the etcd manager. Supported fields include the following:

Beneficiary Details

Vaccination Details

Previous Dose Details

name

vaccine

vaxEvents[].dateOfVax

age

vaccinationDate

vaxEvents[].doseType

Example: Adding a field such as ‘nationality’ to the PDF template.

Steps to add ‘nationality’ to the PDF template:

Go to the Manage keys in the etcd-manager.
Go to the “vaccineCertificateTemplate” key and click on the Edit key to update the template. In this case, the ‘nationality’ field is being added. The value expected for the “vaccineCertificateTemplate” configuration is html and can be customised as per your needs.
The same will be reflected in the PDF of the vaccination certificate. Click on Save. A popup will appear as “operation successful.” Click on Close.

Call “GET VaccineCertificate API,” which will return the PDF certificate template. Verify if the new field ‘nationality’ is getting reflected.

All content on this page by is licensed under a .

PDF Template Change for Vaccine Certificates via ETCD CLI

Any template-related changes can be done by updating the HTML template using ETCD CLI. Before making any change, the PDF template will look like:

Example: Adding a field such as ‘nationality’ to the PDF template.

Steps to add 'nationality' to the PDF template:

Go to the specific path where etcd is configured.
Open the file to add the new field that will get displayed in the template (vim vaccineCertificateTemplate.html).

To reflect the change, run the updateConfigs shell script using the command: ./updateConfigs.sh. It shows "OK OK OK...." This means that etcd has been updated with the new template successfully.

Generate the PDF again using GET API.

All content on this page by is licensed under a .

EU Vaccine Configurations

To add a new vaccine to an EU certificate, a country must identify the EU code to which the vaccine belongs. The coded value sets used in EU vaccination certificates include:

vp: COVID-19 vaccine or prophylaxis
mp: COVID-19 vaccine product
ma: COVID-19 vaccine marketing authorisation holder or manufacturer

Steps to add the extra field in the certificate:

Go to the specific path where etcd is configured.
To add the extra field in the template, go to the Manage keys where etcd is configured.
To add the vaccine code, go to euVaccineCode and click on the Edit key to add the vaccine name and code.

- Example for Covaxin:

{“covaxin”: “Covaxin”}

Click on Save. A popup will appear as “operation successful.” Click on Close.

To add the prophylaxis, go to euVaccineProph and click on the Edit key to add the vaccine name and code.

- Example for Covaxin:

{“covaxin”: “J07BX03”}

Click on Save. A popup will appear as “operation successful.” Click on Close.

To add the manufacturer, go to euVaccineManuf. Click on the Edit key to add the new manufacturer.

- Example for Covaxin:

{“bharat”: “Bharat-Biotech”}

Click on Save. A popup will appear as “operation successful.” Click on Close.

Once the mappings are available in etcd, you can create the certificate and generate the PDF with the new vaccine.

All content on this page by is licensed under a .

Adding a New Vaccine and its Mapping via ETCD CLI

With the ETCD CLI, the same can be dynamically updated in the files (euVaccineProph.json and euVaccineCode.json) without any service deployments.

Steps to add the extra EU vaccine configurations

Go to the specific path where etcd is configured.
Open the files to add the new vaccine or update the existing vaccine.
Run the command: vim euVaccineCode.json.

Run the command:vim euVaccineProph.json.

Run the command:vim .

To reflect the change, run the command: ./updateConfigs.sh. It shows "OK OK OK...."This means that etcd has been updated with the new vaccine list successfully.

Create the certificate and generate the PDF with the new vaccine.

All content on this page by is licensed under a .

Payload Changes in the QR Code

DIVOC certificates are natively digital, verifiable, digitally signed, and also printable with a secure and tamper-proof QR code.
The QR payload structure is based on the W3C verifiable credentials data model.
Previously, any changes in the QR payload required changing it in the certificate-signer service and subsequent deployment.
With DIVOC 2.0, QR payload changes can now be made by changing it in etcd without any deployments.
Currently, only the optional fields that already exist can be removed. New fields cannot be added as of now.
Note: Do not remove the fields.

Steps to remove an optional field:

Go to DDCC_TEMPLATE. Click on the Edit key if you want to remove an optional field.
Click on Save. A popup will appear as “operation successful.” Click on Close.

All content on this page by is licensed under a .

Payload Changes in the QR Code via ETCD CLI

Currently, only the optional fields that already exist can be removed. New fields cannot be added as of now.

Note: Do not remove the mandatory fields.

Steps to remove an optional field:

Run the command: vim DDCC_TEMPLATE.template.

To reflect the change, run the command: ./updateConfigs.sh. It shows "OK OK OK...." This means that etcd has been updated with the new QR Code template successfully.

All content on this page by is licensed under a .