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
| Official URL: http://smart.who.int/ddcc/StructureDefinition/HCertDCC | Version: 1.0.0 | |||
| Draft as of 2024-10-15 | Computable Name: HCertDCC | |||
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  HCertDCC |
0..* | Base | This is an abstracttype. Payload for Certificate - EU DCC CBOR Web Token Logical Model Instances of this logical model are not marked to be the target of a Reference | |
  1 |
1..1 | BackboneElement | EU Digital COVID Certificate v1 | |
   ver |
1..1 | string | Schema version | |
 nam |
1..1 | BackboneElement | Person name | |
 fn |
0..1 | string | Surname/family name (separate multiple with spaces) | |
| fnt |
1..1 | string | Standardised surname | |
| gn |
0..1 | string | Forename/given name. Skip if no given name. Separate with spaces. | |
 gnt |
0..1 | string | Standardised forename, same approach as fnt. Skip if no given name. | |
| dob |
0..1 | date | Date of birth in YYYY-MM-DD format. Skip if missing. Fill unknown months or days with 'XX'. | |
| v |
C | 0..* | BackboneElement | Vaccination Group (see element details) OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). |
| tg |
1..1 | string | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details) | |
| vp |
1..1 | string | Vaccine or prophylaxis (e.g., 'SARS-CoV-2 mRNA vaccine'; SNOMED or ATC; see element details) | |
| mp |
1..1 | string | Vaccine product (e.g., 'EU/1/20/1528 (Comirnaty)'; see element details) Binding: Vaccine - COVID-19 - EU Union Register of Medicinial Products (preferred) | |
| ma |
1..1 | string | Vaccine marketing authorisation holder or manufacturer (e.g., 'ORG-100030215' (Biontech Manufacturing GmbH)) | |
| dn |
1..1 | positiveInt | Number in a series of doses | |
| sd |
1..1 | positiveInt | The overall number of doses in the series | |
| dt |
1..1 | date | Date of vaccination, YYYY-MM-DD format | |
| co |
1..1 | string | Country where vaccine was administered (two letter ISo-3166) Binding: Iso3166-1-2 (preferred) | |
| is |
1..1 | string | Certificate issuer (organization name) | |
| ci |
1..1 | string | Unique certificate identifier (UVCI) | |
| t |
C | 0..* | BackboneElement | Test Group OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). |
| tg |
1..1 | string | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details) Binding: Lab Test - Pathogen - COVID-19 - SNOMED CT (preferred) | |
| tt |
1..1 | string | Type of test (LOINC code; see element details) Binding: Lab Test - Type - Generic - LOINC (preferred) | |
| nm |
0..1 | string | Name of the nucleic acid amplification test (NAAT) used | |
| ma |
0..1 | string | Rapid antigen test (RAT) device identifier from the JRC database | |
| sc |
1..1 | dateTime | Date and time when test sample was collected in ISO 8601 format | |
| tr |
1..1 | string | Result of the test (preferred: SNOMED CT GPS code) Binding: Lab Test - Qualitative Result - SNOMED CT (preferred) | |
| tc |
0..1 | string | Testing centre or facility | |
| co |
1..1 | string | Country of test (two letter ISo-3166) Binding: Iso3166-1-2 (preferred) | |
| is |
1..1 | string | Certificate issuer | |
| ci |
1..1 | string | Unique Certificate Identifier (UVCI) | |
| r |
C | 0..* | BackboneElement | Recovery Group OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). |
| tg |
1..1 | string | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant) | |
| fr |
1..1 | date | The date when a sample for the NAAT test producing a positive result was collected, in the format YYYY-MM-DD (complete date without time). | |
| co |
1..1 | string | Country of test (two letter ISo-3166) Binding: Iso3166-1-2 (preferred) | |
| is |
0..1 | string | Certificate issuer | |
| df |
1..1 | date | The first date on which the certificate is considered to be valid, in YYYY-MM-DD format (complete date without time). | |
| du |
1..1 | date | The last date on which the certificate is considered to be valid, assigned by the certificate issuer, in YYYY-MM-DD format (complete date without time). | |
| ci |
1..1 | string | Unique certificate identifier (UVCI) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HCertDCC.1.v.mp | preferred | VaccineCovid19EUUnionRegisterValueSethttp://smart.who.int/ddcc/ValueSet/VaccineCovid19EUUnionRegisterValueSetfrom this IG | |
| HCertDCC.1.v.co | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2from the FHIR Standard | |
| HCertDCC.1.t.tg | preferred | LabTestPathogenCovid19SnomedValueSethttp://smart.who.int/ddcc/ValueSet/LabTestPathogenCovid19SnomedValueSetfrom this IG | |
| HCertDCC.1.t.tt | preferred | LabTestTypeLoincValueSethttp://smart.who.int/ddcc/ValueSet/LabTestTypeLoincValueSetfrom this IG | |
| HCertDCC.1.t.tr | preferred | LabTestQualitativeResultSnomedValueSethttp://smart.who.int/ddcc/ValueSet/LabTestQualitativeResultSnomedValueSetfrom this IG | |
| HCertDCC.1.t.co | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2from the FHIR Standard | |
| HCertDCC.1.r.co | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| OnlyOneAllowed | error | HCertDCC.1.v, HCertDCC.1.t, HCertDCC.1.r | Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). : count() <= 1 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HCertDCC |
0..* | Base | This is an abstracttype. Payload for Certificate - EU DCC CBOR Web Token Logical Model Instances of this logical model are not marked to be the target of a Reference | |
| 1 |
1..1 | BackboneElement | EU Digital COVID Certificate v1 | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ver |
1..1 | string | Schema version | |
| nam |
1..1 | BackboneElement | Person name | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| fn |
0..1 | string | Surname/family name (separate multiple with spaces) | |
| fnt |
1..1 | string | Standardised surname | |
| gn |
0..1 | string | Forename/given name. Skip if no given name. Separate with spaces. | |
| gnt |
0..1 | string | Standardised forename, same approach as fnt. Skip if no given name. | |
| dob |
0..1 | date | Date of birth in YYYY-MM-DD format. Skip if missing. Fill unknown months or days with 'XX'. | |
| v |
C | 0..* | BackboneElement | Vaccination Group (see element details) OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| tg |
1..1 | string | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details) | |
| vp |
1..1 | string | Vaccine or prophylaxis (e.g., 'SARS-CoV-2 mRNA vaccine'; SNOMED or ATC; see element details) | |
| mp |
1..1 | string | Vaccine product (e.g., 'EU/1/20/1528 (Comirnaty)'; see element details) Binding: Vaccine - COVID-19 - EU Union Register of Medicinial Products (preferred) | |
| ma |
1..1 | string | Vaccine marketing authorisation holder or manufacturer (e.g., 'ORG-100030215' (Biontech Manufacturing GmbH)) | |
| dn |
1..1 | positiveInt | Number in a series of doses | |
| sd |
1..1 | positiveInt | The overall number of doses in the series | |
| dt |
1..1 | date | Date of vaccination, YYYY-MM-DD format | |
| co |
1..1 | string | Country where vaccine was administered (two letter ISo-3166) Binding: Iso3166-1-2 (preferred) | |
| is |
1..1 | string | Certificate issuer (organization name) | |
| ci |
1..1 | string | Unique certificate identifier (UVCI) | |
| t |
C | 0..* | BackboneElement | Test Group OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| tg |
1..1 | string | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details) Binding: Lab Test - Pathogen - COVID-19 - SNOMED CT (preferred) | |
| tt |
1..1 | string | Type of test (LOINC code; see element details) Binding: Lab Test - Type - Generic - LOINC (preferred) | |
| nm |
0..1 | string | Name of the nucleic acid amplification test (NAAT) used | |
| ma |
0..1 | string | Rapid antigen test (RAT) device identifier from the JRC database | |
| sc |
1..1 | dateTime | Date and time when test sample was collected in ISO 8601 format | |
| tr |
1..1 | string | Result of the test (preferred: SNOMED CT GPS code) Binding: Lab Test - Qualitative Result - SNOMED CT (preferred) | |
| tc |
0..1 | string | Testing centre or facility | |
| co |
1..1 | string | Country of test (two letter ISo-3166) Binding: Iso3166-1-2 (preferred) | |
| is |
1..1 | string | Certificate issuer | |
| ci |
1..1 | string | Unique Certificate Identifier (UVCI) | |
| r |
C | 0..* | BackboneElement | Recovery Group OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| tg |
1..1 | string | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant) | |
| fr |
1..1 | date | The date when a sample for the NAAT test producing a positive result was collected, in the format YYYY-MM-DD (complete date without time). | |
| co |
1..1 | string | Country of test (two letter ISo-3166) Binding: Iso3166-1-2 (preferred) | |
| is |
0..1 | string | Certificate issuer | |
| df |
1..1 | date | The first date on which the certificate is considered to be valid, in YYYY-MM-DD format (complete date without time). | |
| du |
1..1 | date | The last date on which the certificate is considered to be valid, assigned by the certificate issuer, in YYYY-MM-DD format (complete date without time). | |
| ci |
1..1 | string | Unique certificate identifier (UVCI) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HCertDCC.1.v.mp | preferred | VaccineCovid19EUUnionRegisterValueSethttp://smart.who.int/ddcc/ValueSet/VaccineCovid19EUUnionRegisterValueSetfrom this IG | |
| HCertDCC.1.v.co | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2from the FHIR Standard | |
| HCertDCC.1.t.tg | preferred | LabTestPathogenCovid19SnomedValueSethttp://smart.who.int/ddcc/ValueSet/LabTestPathogenCovid19SnomedValueSetfrom this IG | |
| HCertDCC.1.t.tt | preferred | LabTestTypeLoincValueSethttp://smart.who.int/ddcc/ValueSet/LabTestTypeLoincValueSetfrom this IG | |
| HCertDCC.1.t.tr | preferred | LabTestQualitativeResultSnomedValueSethttp://smart.who.int/ddcc/ValueSet/LabTestQualitativeResultSnomedValueSetfrom this IG | |
| HCertDCC.1.t.co | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2from the FHIR Standard | |
| HCertDCC.1.r.co | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| OnlyOneAllowed | error | HCertDCC.1.v, HCertDCC.1.t, HCertDCC.1.r | Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). : count() <= 1 | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HCertDCC |
0..* | Base | This is an abstracttype. Payload for Certificate - EU DCC CBOR Web Token Logical Model Instances of this logical model are not marked to be the target of a Reference | |
| 1 |
1..1 | BackboneElement | EU Digital COVID Certificate v1 | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ver |
1..1 | string | Schema version | |
| nam |
1..1 | BackboneElement | Person name | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| fn |
0..1 | string | Surname/family name (separate multiple with spaces) | |
| fnt |
1..1 | string | Standardised surname | |
| gn |
0..1 | string | Forename/given name. Skip if no given name. Separate with spaces. | |
| gnt |
0..1 | string | Standardised forename, same approach as fnt. Skip if no given name. | |
| dob |
0..1 | date | Date of birth in YYYY-MM-DD format. Skip if missing. Fill unknown months or days with 'XX'. | |
| v |
C | 0..* | BackboneElement | Vaccination Group (see element details) OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| tg |
1..1 | string | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details) | |
| vp |
1..1 | string | Vaccine or prophylaxis (e.g., 'SARS-CoV-2 mRNA vaccine'; SNOMED or ATC; see element details) | |
| mp |
1..1 | string | Vaccine product (e.g., 'EU/1/20/1528 (Comirnaty)'; see element details) Binding: Vaccine - COVID-19 - EU Union Register of Medicinial Products (preferred) | |
| ma |
1..1 | string | Vaccine marketing authorisation holder or manufacturer (e.g., 'ORG-100030215' (Biontech Manufacturing GmbH)) | |
| dn |
1..1 | positiveInt | Number in a series of doses | |
| sd |
1..1 | positiveInt | The overall number of doses in the series | |
| dt |
1..1 | date | Date of vaccination, YYYY-MM-DD format | |
| co |
1..1 | string | Country where vaccine was administered (two letter ISo-3166) Binding: Iso3166-1-2 (preferred) | |
| is |
1..1 | string | Certificate issuer (organization name) | |
| ci |
1..1 | string | Unique certificate identifier (UVCI) | |
| t |
C | 0..* | BackboneElement | Test Group OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| tg |
1..1 | string | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details) Binding: Lab Test - Pathogen - COVID-19 - SNOMED CT (preferred) | |
| tt |
1..1 | string | Type of test (LOINC code; see element details) Binding: Lab Test - Type - Generic - LOINC (preferred) | |
| nm |
0..1 | string | Name of the nucleic acid amplification test (NAAT) used | |
| ma |
0..1 | string | Rapid antigen test (RAT) device identifier from the JRC database | |
| sc |
1..1 | dateTime | Date and time when test sample was collected in ISO 8601 format | |
| tr |
1..1 | string | Result of the test (preferred: SNOMED CT GPS code) Binding: Lab Test - Qualitative Result - SNOMED CT (preferred) | |
| tc |
0..1 | string | Testing centre or facility | |
| co |
1..1 | string | Country of test (two letter ISo-3166) Binding: Iso3166-1-2 (preferred) | |
| is |
1..1 | string | Certificate issuer | |
| ci |
1..1 | string | Unique Certificate Identifier (UVCI) | |
| r |
C | 0..* | BackboneElement | Recovery Group OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| tg |
1..1 | string | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant) | |
| fr |
1..1 | date | The date when a sample for the NAAT test producing a positive result was collected, in the format YYYY-MM-DD (complete date without time). | |
| co |
1..1 | string | Country of test (two letter ISo-3166) Binding: Iso3166-1-2 (preferred) | |
| is |
0..1 | string | Certificate issuer | |
| df |
1..1 | date | The first date on which the certificate is considered to be valid, in YYYY-MM-DD format (complete date without time). | |
| du |
1..1 | date | The last date on which the certificate is considered to be valid, assigned by the certificate issuer, in YYYY-MM-DD format (complete date without time). | |
| ci |
1..1 | string | Unique certificate identifier (UVCI) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HCertDCC.1.v.mp | preferred | VaccineCovid19EUUnionRegisterValueSethttp://smart.who.int/ddcc/ValueSet/VaccineCovid19EUUnionRegisterValueSetfrom this IG | |
| HCertDCC.1.v.co | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2from the FHIR Standard | |
| HCertDCC.1.t.tg | preferred | LabTestPathogenCovid19SnomedValueSethttp://smart.who.int/ddcc/ValueSet/LabTestPathogenCovid19SnomedValueSetfrom this IG | |
| HCertDCC.1.t.tt | preferred | LabTestTypeLoincValueSethttp://smart.who.int/ddcc/ValueSet/LabTestTypeLoincValueSetfrom this IG | |
| HCertDCC.1.t.tr | preferred | LabTestQualitativeResultSnomedValueSethttp://smart.who.int/ddcc/ValueSet/LabTestQualitativeResultSnomedValueSetfrom this IG | |
| HCertDCC.1.t.co | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2from the FHIR Standard | |
| HCertDCC.1.r.co | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| OnlyOneAllowed | error | HCertDCC.1.v, HCertDCC.1.t, HCertDCC.1.r | Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). : count() <= 1 | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Base
Differential View
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HCertDCC |
0..* | Base | This is an abstracttype. Payload for Certificate - EU DCC CBOR Web Token Logical Model Instances of this logical model are not marked to be the target of a Reference | |
| 1 |
1..1 | BackboneElement | EU Digital COVID Certificate v1 | |
| ver |
1..1 | string | Schema version | |
| nam |
1..1 | BackboneElement | Person name | |
| fn |
0..1 | string | Surname/family name (separate multiple with spaces) | |
| fnt |
1..1 | string | Standardised surname | |
| gn |
0..1 | string | Forename/given name. Skip if no given name. Separate with spaces. | |
| gnt |
0..1 | string | Standardised forename, same approach as fnt. Skip if no given name. | |
| dob |
0..1 | date | Date of birth in YYYY-MM-DD format. Skip if missing. Fill unknown months or days with 'XX'. | |
| v |
C | 0..* | BackboneElement | Vaccination Group (see element details) OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). |
| tg |
1..1 | string | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details) | |
| vp |
1..1 | string | Vaccine or prophylaxis (e.g., 'SARS-CoV-2 mRNA vaccine'; SNOMED or ATC; see element details) | |
| mp |
1..1 | string | Vaccine product (e.g., 'EU/1/20/1528 (Comirnaty)'; see element details) Binding: Vaccine - COVID-19 - EU Union Register of Medicinial Products (preferred) | |
| ma |
1..1 | string | Vaccine marketing authorisation holder or manufacturer (e.g., 'ORG-100030215' (Biontech Manufacturing GmbH)) | |
| dn |
1..1 | positiveInt | Number in a series of doses | |
| sd |
1..1 | positiveInt | The overall number of doses in the series | |
| dt |
1..1 | date | Date of vaccination, YYYY-MM-DD format | |
| co |
1..1 | string | Country where vaccine was administered (two letter ISo-3166) Binding: Iso3166-1-2 (preferred) | |
| is |
1..1 | string | Certificate issuer (organization name) | |
| ci |
1..1 | string | Unique certificate identifier (UVCI) | |
| t |
C | 0..* | BackboneElement | Test Group OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). |
| tg |
1..1 | string | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details) Binding: Lab Test - Pathogen - COVID-19 - SNOMED CT (preferred) | |
| tt |
1..1 | string | Type of test (LOINC code; see element details) Binding: Lab Test - Type - Generic - LOINC (preferred) | |
| nm |
0..1 | string | Name of the nucleic acid amplification test (NAAT) used | |
| ma |
0..1 | string | Rapid antigen test (RAT) device identifier from the JRC database | |
| sc |
1..1 | dateTime | Date and time when test sample was collected in ISO 8601 format | |
| tr |
1..1 | string | Result of the test (preferred: SNOMED CT GPS code) Binding: Lab Test - Qualitative Result - SNOMED CT (preferred) | |
| tc |
0..1 | string | Testing centre or facility | |
| co |
1..1 | string | Country of test (two letter ISo-3166) Binding: Iso3166-1-2 (preferred) | |
| is |
1..1 | string | Certificate issuer | |
| ci |
1..1 | string | Unique Certificate Identifier (UVCI) | |
| r |
C | 0..* | BackboneElement | Recovery Group OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). |
| tg |
1..1 | string | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant) | |
| fr |
1..1 | date | The date when a sample for the NAAT test producing a positive result was collected, in the format YYYY-MM-DD (complete date without time). | |
| co |
1..1 | string | Country of test (two letter ISo-3166) Binding: Iso3166-1-2 (preferred) | |
| is |
0..1 | string | Certificate issuer | |
| df |
1..1 | date | The first date on which the certificate is considered to be valid, in YYYY-MM-DD format (complete date without time). | |
| du |
1..1 | date | The last date on which the certificate is considered to be valid, assigned by the certificate issuer, in YYYY-MM-DD format (complete date without time). | |
| ci |
1..1 | string | Unique certificate identifier (UVCI) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HCertDCC.1.v.mp | preferred | VaccineCovid19EUUnionRegisterValueSethttp://smart.who.int/ddcc/ValueSet/VaccineCovid19EUUnionRegisterValueSetfrom this IG | |
| HCertDCC.1.v.co | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2from the FHIR Standard | |
| HCertDCC.1.t.tg | preferred | LabTestPathogenCovid19SnomedValueSethttp://smart.who.int/ddcc/ValueSet/LabTestPathogenCovid19SnomedValueSetfrom this IG | |
| HCertDCC.1.t.tt | preferred | LabTestTypeLoincValueSethttp://smart.who.int/ddcc/ValueSet/LabTestTypeLoincValueSetfrom this IG | |
| HCertDCC.1.t.tr | preferred | LabTestQualitativeResultSnomedValueSethttp://smart.who.int/ddcc/ValueSet/LabTestQualitativeResultSnomedValueSetfrom this IG | |
| HCertDCC.1.t.co | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2from the FHIR Standard | |
| HCertDCC.1.r.co | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| OnlyOneAllowed | error | HCertDCC.1.v, HCertDCC.1.t, HCertDCC.1.r | Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). : count() <= 1 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HCertDCC |
0..* | Base | This is an abstracttype. Payload for Certificate - EU DCC CBOR Web Token Logical Model Instances of this logical model are not marked to be the target of a Reference | |
| 1 |
1..1 | BackboneElement | EU Digital COVID Certificate v1 | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ver |
1..1 | string | Schema version | |
| nam |
1..1 | BackboneElement | Person name | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| fn |
0..1 | string | Surname/family name (separate multiple with spaces) | |
| fnt |
1..1 | string | Standardised surname | |
| gn |
0..1 | string | Forename/given name. Skip if no given name. Separate with spaces. | |
| gnt |
0..1 | string | Standardised forename, same approach as fnt. Skip if no given name. | |
| dob |
0..1 | date | Date of birth in YYYY-MM-DD format. Skip if missing. Fill unknown months or days with 'XX'. | |
| v |
C | 0..* | BackboneElement | Vaccination Group (see element details) OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| tg |
1..1 | string | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details) | |
| vp |
1..1 | string | Vaccine or prophylaxis (e.g., 'SARS-CoV-2 mRNA vaccine'; SNOMED or ATC; see element details) | |
| mp |
1..1 | string | Vaccine product (e.g., 'EU/1/20/1528 (Comirnaty)'; see element details) Binding: Vaccine - COVID-19 - EU Union Register of Medicinial Products (preferred) | |
| ma |
1..1 | string | Vaccine marketing authorisation holder or manufacturer (e.g., 'ORG-100030215' (Biontech Manufacturing GmbH)) | |
| dn |
1..1 | positiveInt | Number in a series of doses | |
| sd |
1..1 | positiveInt | The overall number of doses in the series | |
| dt |
1..1 | date | Date of vaccination, YYYY-MM-DD format | |
| co |
1..1 | string | Country where vaccine was administered (two letter ISo-3166) Binding: Iso3166-1-2 (preferred) | |
| is |
1..1 | string | Certificate issuer (organization name) | |
| ci |
1..1 | string | Unique certificate identifier (UVCI) | |
| t |
C | 0..* | BackboneElement | Test Group OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| tg |
1..1 | string | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details) Binding: Lab Test - Pathogen - COVID-19 - SNOMED CT (preferred) | |
| tt |
1..1 | string | Type of test (LOINC code; see element details) Binding: Lab Test - Type - Generic - LOINC (preferred) | |
| nm |
0..1 | string | Name of the nucleic acid amplification test (NAAT) used | |
| ma |
0..1 | string | Rapid antigen test (RAT) device identifier from the JRC database | |
| sc |
1..1 | dateTime | Date and time when test sample was collected in ISO 8601 format | |
| tr |
1..1 | string | Result of the test (preferred: SNOMED CT GPS code) Binding: Lab Test - Qualitative Result - SNOMED CT (preferred) | |
| tc |
0..1 | string | Testing centre or facility | |
| co |
1..1 | string | Country of test (two letter ISo-3166) Binding: Iso3166-1-2 (preferred) | |
| is |
1..1 | string | Certificate issuer | |
| ci |
1..1 | string | Unique Certificate Identifier (UVCI) | |
| r |
C | 0..* | BackboneElement | Recovery Group OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| tg |
1..1 | string | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant) | |
| fr |
1..1 | date | The date when a sample for the NAAT test producing a positive result was collected, in the format YYYY-MM-DD (complete date without time). | |
| co |
1..1 | string | Country of test (two letter ISo-3166) Binding: Iso3166-1-2 (preferred) | |
| is |
0..1 | string | Certificate issuer | |
| df |
1..1 | date | The first date on which the certificate is considered to be valid, in YYYY-MM-DD format (complete date without time). | |
| du |
1..1 | date | The last date on which the certificate is considered to be valid, assigned by the certificate issuer, in YYYY-MM-DD format (complete date without time). | |
| ci |
1..1 | string | Unique certificate identifier (UVCI) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HCertDCC.1.v.mp | preferred | VaccineCovid19EUUnionRegisterValueSethttp://smart.who.int/ddcc/ValueSet/VaccineCovid19EUUnionRegisterValueSetfrom this IG | |
| HCertDCC.1.v.co | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2from the FHIR Standard | |
| HCertDCC.1.t.tg | preferred | LabTestPathogenCovid19SnomedValueSethttp://smart.who.int/ddcc/ValueSet/LabTestPathogenCovid19SnomedValueSetfrom this IG | |
| HCertDCC.1.t.tt | preferred | LabTestTypeLoincValueSethttp://smart.who.int/ddcc/ValueSet/LabTestTypeLoincValueSetfrom this IG | |
| HCertDCC.1.t.tr | preferred | LabTestQualitativeResultSnomedValueSethttp://smart.who.int/ddcc/ValueSet/LabTestQualitativeResultSnomedValueSetfrom this IG | |
| HCertDCC.1.t.co | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2from the FHIR Standard | |
| HCertDCC.1.r.co | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| OnlyOneAllowed | error | HCertDCC.1.v, HCertDCC.1.t, HCertDCC.1.r | Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). : count() <= 1 | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HCertDCC |
0..* | Base | This is an abstracttype. Payload for Certificate - EU DCC CBOR Web Token Logical Model Instances of this logical model are not marked to be the target of a Reference | |
| 1 |
1..1 | BackboneElement | EU Digital COVID Certificate v1 | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ver |
1..1 | string | Schema version | |
| nam |
1..1 | BackboneElement | Person name | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| fn |
0..1 | string | Surname/family name (separate multiple with spaces) | |
| fnt |
1..1 | string | Standardised surname | |
| gn |
0..1 | string | Forename/given name. Skip if no given name. Separate with spaces. | |
| gnt |
0..1 | string | Standardised forename, same approach as fnt. Skip if no given name. | |
| dob |
0..1 | date | Date of birth in YYYY-MM-DD format. Skip if missing. Fill unknown months or days with 'XX'. | |
| v |
C | 0..* | BackboneElement | Vaccination Group (see element details) OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| tg |
1..1 | string | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details) | |
| vp |
1..1 | string | Vaccine or prophylaxis (e.g., 'SARS-CoV-2 mRNA vaccine'; SNOMED or ATC; see element details) | |
| mp |
1..1 | string | Vaccine product (e.g., 'EU/1/20/1528 (Comirnaty)'; see element details) Binding: Vaccine - COVID-19 - EU Union Register of Medicinial Products (preferred) | |
| ma |
1..1 | string | Vaccine marketing authorisation holder or manufacturer (e.g., 'ORG-100030215' (Biontech Manufacturing GmbH)) | |
| dn |
1..1 | positiveInt | Number in a series of doses | |
| sd |
1..1 | positiveInt | The overall number of doses in the series | |
| dt |
1..1 | date | Date of vaccination, YYYY-MM-DD format | |
| co |
1..1 | string | Country where vaccine was administered (two letter ISo-3166) Binding: Iso3166-1-2 (preferred) | |
| is |
1..1 | string | Certificate issuer (organization name) | |
| ci |
1..1 | string | Unique certificate identifier (UVCI) | |
| t |
C | 0..* | BackboneElement | Test Group OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| tg |
1..1 | string | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details) Binding: Lab Test - Pathogen - COVID-19 - SNOMED CT (preferred) | |
| tt |
1..1 | string | Type of test (LOINC code; see element details) Binding: Lab Test - Type - Generic - LOINC (preferred) | |
| nm |
0..1 | string | Name of the nucleic acid amplification test (NAAT) used | |
| ma |
0..1 | string | Rapid antigen test (RAT) device identifier from the JRC database | |
| sc |
1..1 | dateTime | Date and time when test sample was collected in ISO 8601 format | |
| tr |
1..1 | string | Result of the test (preferred: SNOMED CT GPS code) Binding: Lab Test - Qualitative Result - SNOMED CT (preferred) | |
| tc |
0..1 | string | Testing centre or facility | |
| co |
1..1 | string | Country of test (two letter ISo-3166) Binding: Iso3166-1-2 (preferred) | |
| is |
1..1 | string | Certificate issuer | |
| ci |
1..1 | string | Unique Certificate Identifier (UVCI) | |
| r |
C | 0..* | BackboneElement | Recovery Group OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| tg |
1..1 | string | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant) | |
| fr |
1..1 | date | The date when a sample for the NAAT test producing a positive result was collected, in the format YYYY-MM-DD (complete date without time). | |
| co |
1..1 | string | Country of test (two letter ISo-3166) Binding: Iso3166-1-2 (preferred) | |
| is |
0..1 | string | Certificate issuer | |
| df |
1..1 | date | The first date on which the certificate is considered to be valid, in YYYY-MM-DD format (complete date without time). | |
| du |
1..1 | date | The last date on which the certificate is considered to be valid, assigned by the certificate issuer, in YYYY-MM-DD format (complete date without time). | |
| ci |
1..1 | string | Unique certificate identifier (UVCI) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HCertDCC.1.v.mp | preferred | VaccineCovid19EUUnionRegisterValueSethttp://smart.who.int/ddcc/ValueSet/VaccineCovid19EUUnionRegisterValueSetfrom this IG | |
| HCertDCC.1.v.co | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2from the FHIR Standard | |
| HCertDCC.1.t.tg | preferred | LabTestPathogenCovid19SnomedValueSethttp://smart.who.int/ddcc/ValueSet/LabTestPathogenCovid19SnomedValueSetfrom this IG | |
| HCertDCC.1.t.tt | preferred | LabTestTypeLoincValueSethttp://smart.who.int/ddcc/ValueSet/LabTestTypeLoincValueSetfrom this IG | |
| HCertDCC.1.t.tr | preferred | LabTestQualitativeResultSnomedValueSethttp://smart.who.int/ddcc/ValueSet/LabTestQualitativeResultSnomedValueSetfrom this IG | |
| HCertDCC.1.t.co | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2from the FHIR Standard | |
| HCertDCC.1.r.co | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| OnlyOneAllowed | error | HCertDCC.1.v, HCertDCC.1.t, HCertDCC.1.r | Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). : count() <= 1 | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Base