WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.0 - CI Build
WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.0 - CI Build
This page is part of the WHO Digital Documentation of COVID-19 Certificates (DDCC) (v1.0.0: releases Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.
| WHO DDCC Generator |
CapabilityStatement for WHO DDCC Generator actor. |
| WHO DDCC Registry Service |
CapabilityStatement for WHO DDCC Registry Service actor. |
These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.
| OperationDefinition for generating a health certificate (DDCC) that is signed. |
Generate one or more signed DDCC Documents based on a DDCC QuestionnaireResponse |
| OperationDefinition for generating a health folder (DDCCFolder). |
Generate a DDCC Folder from an IPS Bundle. |
| OperationDefinition for revoking a health certificate (DDCC). |
Revoke a DDCC Document. |
These define logic, asset collections and other libraries as part of content in this implementation guide.
| AnyDosePass |
DDCC-compliant rule to evaluate if patients have a completed immunization schedule or just a single dose |
| DDCCPass |
DDCC-compliant rule to evaluate if patients have a completed immunization schedule |
| ModernaOrPfizerPass |
DDCC-compliant rule to evaluate if patients have an immunization from Moderna or Pfizer |
These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.
| Certificate - DIVOC Verifiable Credential Logical Model |
Data elements for the DIVOC Core Data Set. The official DIVOC documentation appears to be at <https://divoc.digit.org>. However, this does not include a full list of elements included in DIVOC certificates. There is a JSON-LD context referenced in DIVOC certificate examples ( It was not possible to find any online documentation regarding DIVOC proof of testing. Information on this was provided by the DIVOC team via email. Some element descriptions in this logical model provide details that are not in publicly available DIVOC documentation. |
| Certificate - ICAO Visible Digital Seal Logical Model |
Data elements for the ICAO Visible Digital Seal Core Data Set. Based on <https://www.icao.int/vdsnc-spec> as of 2023-02-02. |
| Certificate - Smart Health Card's JSon Web Token Logical Model |
Data elements for the Smart Health Cards Core Data Set. |
| DDCC Core Data Set Logical Model |
Data elements for the DDCC Core Data Set. |
| DDCC Core Data Set Logical Model - Vaccination Status - Continuity of Care |
Data elements for the DDCC Core Data Set - Vaccination Status - Continuity of Care. |
| DDCC Core Data Set Logical Model - Vaccination Status - Proof of Vaccination |
Data elements for the DDCC Core Data Set - Vaccination Status - Proof of Vaccination. |
| DDCC Core Data Set Logical Model for Test Result |
Data elements for the DDCC Core Data Set for Test Result. |
| DDCC Core Data Set Logical Model for Vaccination Status |
Data elements for the DDCC Core Data Set for Vaccination Status. |
| Payload for Certificate - EU DCC CBOR Web Token Logical Model |
Data elements for the EU Digital COVID Certificate Core Data Set. Based on the official specification for COVID-19-related payloads <https://health.ec.europa.eu/system/files/2021-06/covid-certificate_json_specification_en_0.pdf> as of 2023-01-31, and Implementing Decision (EU) 2021/1073, Annex 1 <https://eur-lex.europa.eu/legal-content/EN/TXT/HTML/?uri=CELEX:32021D1073&from=EN#d1e34-35-1>. |
These define forms used by systems conforming to this implementation guide to capture or expose data to end users.
| DDCC HCID Registration Questionnaire |
DDCC HCID Registration Questionnaire |
| DDCC:TR Core Data Set Questionnaire |
DDCC Questionnaire for a Test event. |
| DDCC:VS Core Data Set Questionnaire |
DDCC Questionnaire for an Immunization event. |
These are profiles on resources or data types that describe patterns used by other profiles, but cannot be instantiated directly. I.e. instances can conform to profiles based on these abstract profiles, but do not declare conformance to the abstract profiles themselves.
| DDCC Questionnaire Response |
Describes the logical structure for a questionnaire response associacted to a DDCC Questionaire. |
| DDCC Questionniare |
Describes the logical structure for a questionnaire associacted to a DDCC which includes a Structure Map to generate the relevant DDCC from a given DDCC QuestionnaireResponse which responds to the DDCC Questionnaire. |
These define constraints on FHIR resources for systems conforming to this implementation guide.
| DDCC Composition |
Describes the logical structure for a Digital Documentation of COVID-19 Certificates (DDCC). |
| DDCC Diagnostic Report |
A DDCC Diagnostic Report contains the content corresponding to a row in the Test Events section of a Paper DDCC. While this is not a further profile of the International Patient Summary (IPS) DiagnosticReport resouce, this is intended to map into an IPS DiagnosticReport resource. |
| DDCC Document |
A DDCC Document is a document bundle containing the DDCC. |
| DDCC Document Reference |
A DDCC Document Reference is a document reference to a DDCC Document containing the DDCC. The content attachment url will point to a DDCC Document. |
| DDCC DocumentReference return for QR |
DDCC DocumentReference for QR codes including the QR image and the serialized content. |
| DDCC DocumentSigned |
A DDCC Document Signed is a document bundle containing the DDCC that has a digital signature. |
| DDCC Folder |
DDCC Folder of the Paper Certificate |
| DDCC Generate Health Certificate Parameters |
Parameters for the DDCC Generate Health Certificate Operation. |
| DDCC Generate Health Folder Parameters |
Parameters for the DDCC Generate Health Folder Operation. |
| DDCC Immunization |
A DDCC Immunization contains the content corresponding to a row in the Vaccination Events section of a Paper DDCC. While this is not a further profile of the International Patient Summary (IPS) Immunization resouce, this is intended to map into an IPS Immunization resource. |
| DDCC Immunization Recommendation |
A DDCC Immunization Recommendation contains the content corresponding to when a patient should return for a booster shot. |
| DDCC Observation |
A DDCC Observation contains the content corresponding to a row in the Test Events section of a Paper DDCC. While this is not a further profile of the International Patient Summary (IPS) Observation resouce, this is intended to map into an IPS Observation resource. |
| DDCC Organization |
Abstraction for a DDCC Organization. There should be a DDCC Organization associated to each public health authortiy (PHA) |
| DDCC Patient |
A DDCCPatient should:
|
| DDCC Practitioner |
Container for an DDCC Practitioner, which is a Practitioner authorized by the PHA to vaccinate an DDCC Patient. |
| DDCC Practitioner Role |
Association of an DDCC Practitioner to a managing DDCC Organization, indicating that an DDCC Practitioner is authorized by the public health authority (PHA) to vaccinate an DDCC Patient. |
| DDCC Procedure |
A DDCC Procedure contains the content corresponding to a row in the Test Events section of a Paper DDCC. While this is not a further profile of the International Patient Summary (IPS) Procedure resouce, this is intended to map into an IPS Procedure resource. |
| DDCC Provide Document Bundle |
DDCC Provide Document Bundle for ITI-65 |
| DDCC Questionnaire based on SDC |
DDCC Questionniare based on SDC Populatable Questionnaire with additional extension |
| DDCC Revoke Health Certificate Parameters |
Parameters for the DDCC Revoke Health Certificate Operation. |
| DDCC Specimen |
A DDCC Specimen contains the content corresponding to a row in the Test Events section of a Paper DDCC. While this is not a further profile of the International Patient Summary (IPS) Specimen resouce, this is intended to map into an IPS Specimen resource. |
| DDCC Submission Set |
DDCC Submission Set for ITI-65 |
| DDCC Submit Health Event Request |
An DDCC Submit Health Event Request is a transaction bundle containing the content of health events which are being submitted under the Submit Health Event transaction. |
| DDCC Submit Health Event Response |
A DDCC Submit Health Event Response](StructureDefinition-DDCCSubmitHealthEventRespose.html) is a transaction reponse bundle containing the operation outcomes for the submission of one or more health certificates under the Submit Health Event transaction. |
| DDCC Test |
A DDCC Test contains the content corresponding to a row in the Test Events section of a Paper DDCC. While this is not a further profile of the International Patient Summary (IPS) Device resouce, this is intended to map into an IPS Device resource. |
| DDCC:TR Composition |
Describes the logical structure for a Digital Documentation of COVID-19 Certificates - Test Result (DDCC:TR). |
| DDCC:TR DocumentSigned |
A DDCC:TR Document Signed is a document bundle containing the DDCC:TR that has a digital signature. |
| DDCC:VS Add Bundle |
Bundle to be transformed to from the DDCC:VS QuestionnaireResponse to add on the DDCC generator. |
| DDCC:VS Composition |
Describes the logical structure for a Digital Documentation of COVID-19 Certificates - Vaccination Status (DDCC:VS). |
| DDCC:VS Document |
A DDCC:VS Document is a document bundle containing the DDCC:VS. |
| DDCC:VS Document |
A DDCC:VS Document is a document bundle containing the DDCC:VS. |
| DDCC:VS DocumentSigned |
A DDCC:VS Document Signed is a document bundle containing the DDCC:VS that has a digital signature. |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| DDCC Country Of Event for Immunization |
DDCC Country Of Event for Immunization |
| DDCC Event Brand for Immunization |
DDCC Event Brand for Immunization |
| DDCC Vaccine Market Authorization for Immunization |
DDCC Vaccine Market Authorization for Immunization |
| DDCC Vaccine Valid From |
Date upon which provided vaccination is considered valid |
These define sets of codes used by systems conforming to this implementation guide.
| COVID-19 Vaccine Codes for DIVOC |
COVID-19 Vaccine codes for DIVOC so the FHIR server can perform expansions. |
| DDCC Codes for ICAO Vaccines |
ICAO vaccines codes for DDCC so the FHIR server can perform expansions. |
| DDCC Composition Category Codes |
Categorization of DDCC Composition |
| DDCC DesignationTypes for Folder |
DDCC Designation Types ValueSet for DDCC Folders. |
| DDCC Device Property Codes |
Properties of DDCC devices |
| DDCC QR Format Codes |
Format of the representation of QR code |
| DDCC QR Type Codes |
Type of QR codes by their business usage |
| EU DCC Allowed Vaccine List (COVID-19) |
EU DCC Allowed Vaccine List (COVID-19). |
| Lab Test - Pathogen - COVID-19 - SNOMED CT |
This is a one-time snapshot of the allowed values for pathogens in EUDCC, retrieved in February 2023 from https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=uriserv%3AOJ.L_.2021.230.01.0032.01.ENG. Contents may need to be updated and readers should consult the credential's documentation. |
| Lab Test - Pathogen - DIVOC |
This is a one-time snapshot of the allowed values for pathogens, retrieved in February 2023. Contents may need to be updated and readers should consult the credential's documentation. Some information on DIVOC's test certificate can be found at https://github.com/egovernments/DIVOC/blob/main/test-certificate-context/test-certificate-context.js. Additional information on DIVOC can be found at <https://divoc.digit.org/platform/divocs-verifiable-certificate-features> |
| Lab Test - Qualitative Result - DIVOC |
This is a one-time snapshot of the allowed values for lab test results, retrieved in February 2023. Contents may need to be updated and readers should consult the credential's documentation. Some information on DIVOC's test certificate can be found at https://github.com/egovernments/DIVOC/blob/main/test-certificate-context/test-certificate-context.js. Additional information on DIVOC can be found at <https://divoc.digit.org/platform/divocs-verifiable-certificate-features> |
| Lab Test - Qualitative Result - ICAO |
This is a one-time snapshot of the allowed values for lab test results in ICAO, retrieved in February 2023 from https://www.icao.int/Security/FAL/TRIP/PublishingImages/Pages/Publications/Visible%20Digital%20Seal%20for%20non-constrained%20environments%20%28VDS-NC%29.pdf. Contents may need to be updated and readers should consult the credential's documentation. |
| Lab Test - Qualitative Result - SNOMED CT |
This is a one-time snapshot of the allowed values for lab test results in EUDCC and SMART Health Cards, retrieved in February 2023 from https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=uriserv%3AOJ.L_.2021.230.01.0032.01.ENG and <http://build.fhir.org/ig/HL7/fhir-shc-vaccination-ig/ValueSet-vaccine-snomed.html> respectively. Contents may need to be updated and readers should consult the original documentation. |
| Lab Test - Sample Origin - DIVOC |
This is a one-time snapshot of the allowed values for lab test sample origins, retrieved in February 2023. Contents may need to be updated and readers should consult the credential's documentation. Some information on DIVOC's test certificate is at https://github.com/egovernments/DIVOC/blob/main/test-certificate-context/test-certificate-context.js. Additional information on DIVOC can be found at <https://divoc.digit.org/platform/divocs-verifiable-certificate-features> |
| Lab Test - Sample Origin - ICAO |
This is a one-time snapshot of the allowed values for lab test sample origins in ICAO, retrieved in February 2023 from https://www.icao.int/Security/FAL/TRIP/PublishingImages/Pages/Publications/Visible%20Digital%20Seal%20for%20non-constrained%20environments%20%28VDS-NC%29.pdf. Contents may need to be updated and readers should consult the credential's documentation. |
| Lab Test - Type - COVID-19 - LOINC |
This is a one-time snapshot of the allowed values for COVID-19 specific lab tests in EUDCC, retrieved in February 2023 from https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=uriserv%3AOJ.L_.2021.230.01.0032.01.ENG. Contents may need to be updated and readers should consult the credential's documentation. |
| Lab Test - Type - DIVOC |
This is a one-time snapshot of the allowed values for lab test types, retrieved in February 2023. Contents may need to be updated and readers should consult the credential's documentation. Some information on DIVOC's test certificate can be found at https://github.com/egovernments/DIVOC/blob/main/test-certificate-context/test-certificate-context.js. Additional information on DIVOC can be found at <https://divoc.digit.org/platform/divocs-verifiable-certificate-features> |
| Lab Test - Type - Generic - LOINC |
This is a one-time snapshot of the allowed values for generic lab tests in EUDCC, retrieved in February 2023 from https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=uriserv%3AOJ.L_.2021.230.01.0032.01.ENG. Contents may need to be updated and readers should consult the credential's documentation. |
| Lab Test - Type - ICAO |
This is a one-time snapshot of the allowed values for lab test types in ICAO, retrieved in February 2023 from https://www.icao.int/Security/FAL/TRIP/PublishingImages/Pages/Publications/Visible%20Digital%20Seal%20for%20non-constrained%20environments%20%28VDS-NC%29.pdf. Contents may need to be updated and readers should consult the credential's documentation. |
| Vaccine - COVID-19 - CVX |
This is a one-time snapshot of the allowed CVX codes for vaccines, retrieved in February 2023. Contents may need to be updated and readers should consult the credential documentation, found here http://hl7.org/fhir/uv/shc-vaccination/2021Sep/ValueSet-vaccine-cvx.html. More information on the CVX value set can be found here, <https://www2a.cdc.gov/vaccines/iis/iisstandards/vaccines.asp?rpt=cvx> |
| Vaccine - COVID-19 - EU Union Register of Medicinial Products |
Union Register of medicinal products for vaccines with EU-wide authorisation. The Union Register is found at <https://ec.europa.eu/health/documents/community-register/html/index_en.htm>. However, the contents of this ValueSet are based on v1.14 (2023-01-25) of the EU DCC value set guidelines. |
| Vaccine - COVID-19 - Icd11 |
tbd |
| Vaccine - COVID-19 - SNOMED CT |
This is a one-time snapshot of the allowed SNOMED values for vaccines, retrieved in February 2023. Contents may need to be updated and readers should consult the documentation, found here http://hl7.org/fhir/uv/shc-vaccination/2021Sep/ValueSet-vaccine-snomed.html |
| WHO Agent Targeted (COVID-19) |
WHO Agent Targeted List (COVID-19) from ICD 11 |
| WHO DDCC Brand List (COVID-19) |
WHO DDCC Brand List (COVID-19) from ICD 11 |
| WHO Disease or Agent Targeted (COVID-19) |
WHO Disease or Agent Targeted List (COVID-19) from ICD 11 |
| WHO Speciman Sample Origin (COVID-19) |
WHO Speciman Sample Origin List (COVID-19) |
| WHO Test Result (COVID-19) |
WHO COVID-19 Test Result from ICD 11 |
| WHO Type of Covid-19 Test |
WHO Type of COVID-19 Test |
| WHO Vaccine List (COVID-19) |
WHO Vaccine List (COVID-19) from ICD 11 |
These define new code systems used by systems conforming to this implementation guide.
| COVID-19 Vaccine Codes for DIVOC |
COVID-19 Vaccine codes for DIVOC so the FHIR server can perform expansions. |
| CVX codes used in this IG |
All CVX codes from |
| DDCC Codes for ICAO Vaccines |
ICAO vaccines codes for DDCC so the FHIR server can perform expansions. |
| DDCC Codes for ICD11 |
ICD11 codes for DDCC so the FHIR server can perform expansions. |
| DDCC Codes for examples |
Example codes for example resources. |
| DDCC Composition Category Codes |
Possible categories available for composition. |
| DDCC Designation Types for Folder |
DDCC Designation Types to use for DDCC Folders. |
| DDCC Device Property Codes |
Possible properties available for devices. |
| DDCC QR Category Usage Codes |
Possible formats available for QR usage. |
| DDCC QR Format Codes |
Possible formats available for QR data. |
| DIVOC lab test origin codes used in this IG |
All DIVOC lab test origin codes from its internally defined code system used in this IG. Provided so the FHIR server can perform expansions. |
| DIVOC lab test pathogen codes used in this IG |
All DIVOC lab test pathogen codes from its internally defined code system used in this IG. Provided so the FHIR server can perform expansions. |
| DIVOC lab test result codes used in this IG |
All DIVOC lab test result codes from its internally defined code system used in this IG. Provided so the FHIR server can perform expansions. |
| DIVOC lab test type codes used in this IG |
All DIVOC lab test type codes from its internally defined code system used in this IG. Provided so the FHIR server can perform expansions. |
| EUUR codes used in this IG |
All EUUR codes from |
| ICAO lab test origin codes used in this IG |
All ICAO lab test origin codes from its internally defined code system used in this IG. Provided so the FHIR server can perform expansions. |
| ICAO lab test result codes used in this IG |
All ICAO lab test result codes from its internally defined code system used in this IG. Provided so the FHIR server can perform expansions. |
| ICAO lab test type codes used in this IG |
All ICAO lab test type codes from its internally defined code system used in this IG. Provided so the FHIR server can perform expansions. |
| LOINC codes used in this IG |
All LOINC codes from |
| SNOMED codes used in this IG |
All SNOMED codes from |
These define transformations to convert between data structures used by systems conforming to this implementation guide.
These define transformations to convert between codes by systems conforming with this implementation guide.
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
These are resources that are used within this implementation guide that do not fit into one of the other categories.
| IPS-Immunization-Example-Bundle-01 |
| SHCVaccinationBundleDM-Example-English-From-ddcc-to-shc |