Skip to content
This repository has been archived by the owner on Jul 12, 2023. It is now read-only.

Latest commit

 

History

History
32 lines (26 loc) · 2.61 KB

README.md

File metadata and controls

32 lines (26 loc) · 2.61 KB
Raw

Vaccine encoding instructions

Annex A of the document on “eHealth Network Guidelines on Value Sets for EU Digital COVID Certificates”(eHN, DCC) contains a table that shows the coding combinations of the different vaccine medicinal products with their recommended ATC or SNOMED CT ‘Vaccine’ concept, along with their corresponding marketing authorization holder or manufacturer. The table is included to assist implementation efforts.

Until release version 2.10.0 of the eHN EU DCC value sets the table in this Annex A was not encoded in a JSON format in this repository. Because of ongoing efforts relating to a WHO/G20 pilot, it has become advantageous to encode the table in Annex A. This has resulted in the vaccine-encoding-instructions.json JSON file.

To reduce tedious manual work (which is inherently somewhat error-prone), encoding the table to produce the corresponding JSON value set file has been (somewhat) automated. The steps to perform are:

  1. Perform a textual copy of the table from the guidelines document to the annex-A/table.tsv file. This seems to work best from a .docx version of that document, rather than the published PDF file.
  2. Clean up the annex-A/table.tsv file so that every line in it corresponds to exactly one row in the table. It might be necessary to remove some newlines or other characters for that.
  3. Run the build.sh build script. This should produce the vaccine-encoding-instructions.json JSON file. If derivation of that file fails, then the file is not updated. In principle, you'd expect the top-level valueSetDate field to be updated (to the date of today). You could also inspect that file's metadata to be sure.
  4. Inspect the console. The derivation prints issues (error, warnings, infos) there (if there are any). If there are any manufacturers that are associated with multiple vaccines, a piece of JSON detailing those associations is printed to the console.
  5. Compare the updated file against the last version committed to the Git versioning system. If there are more differences between these versions than expected, you need to have to look at the annex-A/table.tsv file to see whether (and if so, how) that needs to be tweaked. Issues printed to the console by running the script might help as well.

The derivation relies on the Deno runtime for JavaScript/TypeScript. It can be found and downloaded at https://deno.land/.