WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.0 - CI Build International flag

This is the continuous build for version 1.0.0. This version is based on the current content of https://github.com/WorldHealthOrganization/ddcc and changes regularly.

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

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.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide

DDCCGenerateHealthCertificate

Generate one or more signed DDCC Documents based on a DDCC QuestionnaireResponse

DDCCGenerateHealthFolder

Generate a DDCC Folder from an IPS Bundle.

DDCCRevokeHealthCertificate

Revoke a DDCC Document.

Structures: Logical Models

These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.

DDCC Core Data Set Logical Model

Data elements for the DDCC Core Data Set.

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.

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.

EU DCC

EU Digital Covid Certificate

Test Group

Test Group

Vaccination Group

Vaccination Group

Structures: Abstract Profiles

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 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.

DDCC Questionnaire Response

Describes the logical structure for a questionnaire response associacted to a DDCC Questionaire.

Structures: Resource Profiles

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:

  • if the [identifier.assigner](StructureDefinition-DDCCPatient-definitions.html#Patient.identifier] is set then the value of identifier.assigner should be set to reference the DDCC Organization resource associated to the PHA.
  • obeys who-ddcc-patient-1
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:TR Composition

Describes the logical structure for a Digital Documentation of COVID-19 Certificates - Test Result (DDCC:TR).

DDCC:VS Document

A DDCC:VS Document is a document bundle containing the DDCC:VS.

DDCC:TR DocumentSigned

A DDCC:TR Document Signed is a document bundle containing the DDCC:TR that has a digital signature.

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: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 DocumentSigned

A DDCC:VS Document Signed is a document bundle containing the DDCC:VS that has a digital signature.

Immunization (IPS)

This profile represents the constraints applied to the Immunization resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an immunization is represented in the patient summary as an instance of an Immunization resource constrained by this profile. It describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party.

Patient (IPS)

This profile represents the constraints applied to the Patient resource by the International Patient Summary (IPS) FHIR Implementation Guide and describes the minimum expectations for the Patient resource when used in the IPS composition or in one of the referred resources.

Structures: Extension Definitions

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

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide

DDCC Composition Category Codes

Categorization of DDCC Composition

DDCC Device Property Codes

Properties of DDCC devices

DDCC DesignationTypes for Folder

DDCC Designation Types ValueSet for DDCC Folders.

DDCC QR Format Codes

Format of the representation of QR code

DDCC QR Type Codes

Type of QR codes by their business usage

WHO Agent Targeted (COVID-19)

WHO Agent Targeted List (COVID-19) from ICD 11

WHO DDCC Allowed Vaccine List (COVID-19)

WHO DDCC Allowed Vaccine List (COVID-19) for importing from other valuesets. Any not in who-ddcc-vaccines-covid-19 should be included in the ConceptMap so it can be translated into an ICD-11 code.

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

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide

DDCC Composition Category Codes

Possible categories available for composition.

DDCC Device Property Codes

Possible properties available for devices.

DDCC Codes for examples

Example codes for example resources.

DDCC Designation Types for Folder

DDCC Designation Types to use for DDCC Folders.

DDCC Codes for ICD11

ICD11 codes for DDCC so the FHIR server can perform expansions.

DDCC QR Format Codes

Possible formats available for QR data.

DDCC QR Category Usage Codes

Possible formats available for QR usage.

Terminology: Structure Maps

These define transformations to convert between data structures used by systems conforming to this implementation guide

BundleVSToAddBundle
CoreDataSetLibrary
CoreDataSetVSLibrary
CoreDataSetVSToAddBundle
CoreDataSetVSToSHC
DDCCtoCoredataset
DDCCtoEUdcc
IPSToCoreDataSetVS
QRespToVSCoreDataSet
ResourcesToCoreDataSet
ResourcesToVSCoreDataSet
SHCToCoreDataSetVS
CoreDataSetToAddBundle
QRespToCoreDataSet
ResourcesToCoreDataSet
DDCCtoSHC
SHCtoDDCC

Terminology: Concept Maps

These define transformations to convert between codes by systems conforming with this implementation guide

WHO_DDCC_Map_CVX_To_ICD11_Brands

Mapping from CVX to ICD-11 for COVID-19 Brands

WHO_DDCC_Map_CVX_To_ICD11_Vaccines

Mapping from CVX to ICD-11 for COVID-19 Vaccines

WHO_DDCC_Map_ICD11_to_ICD10_Disease_Targeted

Mapping from ICD-11 to ICD-10 for COVID-19 disease.

WHO_DDCC_Map_ICD11_to_SCT_Agent_Targeted

Mapping from ICD-11 to SNOMED CT for COVID-19 Agent Targeted

WHO_DDCC_Map_ICD11_to_SCT_Disease_Targeted

Mapping from ICD-11 to SNOMED CT for COVID-19 disease.

WHO_DDCC_Map_ICD11_to_SCT_Test_Result

Mapping from ICD-11 to SNOMED CT for COVID-19 Test Result

WHO_DDCC_Map_ICD11_to_SCT_Vaccines

Mapping from ICD-11 to SNOMED CT for COVID-19 Vaccines

WHO_DDCC_Map_ICHI_to_LOINC_Type_of_Test

Mapping from ICHI to LOINC for COVID-19 Type of Test

WHO_DDCC_Map_ICHI_to_SCT_Specimen_Origin

Mapping from ICHI to SNOMED CT for COVID-19 Specimen Origin

WHO_DDCC_Map_ICHI_to_SCT_Type_of_Test

Mapping from ICHI to SNOMED CT for COVID-19 Type of Test

WHO_DDCC_Map_LOINC_to_SCT_Type_of_Test

Mapping from LOINC to SNOMED CT for COVID-19 Type of Test

WHO_DDCC_Map_SCT_to_ICHI_Specimen_Origin

Mapping from SNOMED CT to ICHI for COVID-19 Specimen Origin

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like

DDCC-Composition-Example-Arabic
DDCC-Composition-Example-Chinese
DDCC-Composition-Example-English
DDCC-Composition-Example-French
DDCC-Composition-Example-Russian
DDCC-Composition-Example-Spanish
DDCC-Immunization-Arabic
DDCC-Immunization-Chinese
DDCC-Immunization-English
DDCC-Immunization-French
DDCC-Immunization-Russian
DDCC-Immunization-Spanish
DDCC-ImmunizationRecommendation-Arabic
DDCC-ImmunizationRecommendation-Chinese
DDCC-ImmunizationRecommendation-English
DDCC-ImmunizationRecommendation-French
DDCC-ImmunizationRecommendation-Russian
DDCC-ImmunizationRecommendation-Spanish
DDCC-Organization-Arabic
DDCC-Organization-Chinese
DDCC-Organization-English
DDCC-Organization-French
DDCC-Organization-Russian
DDCC-Organization-Spanish
DDCC-Patient-Arabic
DDCC-Patient-Chinese
DDCC-Patient-English
DDCC-Patient-French
DDCC-Patient-Russian
DDCC-Patient-Spanish
DDCC-TX-SHE-bundle-example-1
DDCC-TX-SHE-bundle-example-Arabic
DDCC-TX-SHE-bundle-example-Chinese
DDCC-TX-SHE-bundle-example-French
DDCC-TX-SHE-bundle-example-Russian
DDCC-TX-SHE-bundle-example-Spanish
DDCC-VS-QuestionnaireResponse-Arabic
DDCC-VS-QuestionnaireResponse-Chinese
DDCC-VS-QuestionnaireResponse-Example
DDCC-VS-QuestionnaireResponse-French
DDCC-VS-QuestionnaireResponse-Russian
DDCC-VS-QuestionnaireResponse-Spanish
DDCCHCIDRegistrationQuestionnaire

DDCC HCID Registration Questionnaire

DDCCTRCoreDataSetQuestionnaire

DDCC Questionnaire for a Test event.

DDCCVSCoreDataSetQuestionnaire

DDCC Questionnaire for an Immunization event.

Example-Arabic
Example-Chinese
Example-English
Example-French
Example-Russian
Example-Spanish

Other

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