WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.0 - CI Build
WHO Digital Documentation of COVID-19 Certificates (DDCC), published by WHO. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/ddcc/tree/main and changes regularly. See the Directory of published versions
Draft as of 2024-10-11 |
Definitions for the HCertDCC logical model.
Guidance on how to interpret the contents of this table can be found here
0. HCertDCC | |
Definition | 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. |
Short | Payload for Certificate - EU DCC CBOR Web Token Logical Model |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. HCertDCC.1 | |
Definition | EU Digital COVID Certificate v1 |
Short | EU Digital COVID Certificate v1 |
Control | 1..1 |
Type | BackboneElement |
4. HCertDCC.1.ver | |
Definition | Schema version |
Short | Schema version |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
6. HCertDCC.1.nam | |
Definition | Person name |
Short | Person name |
Control | 1..1 |
Type | BackboneElement |
8. HCertDCC.1.nam.fn | |
Definition | Surname/family name (separate multiple with spaces) |
Short | Surname/family name (separate multiple with spaces) |
Comments | Example from spec: "Musterfrau-Gößinger Müller" |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. HCertDCC.1.nam.fnt | |
Definition | Standardised surname |
Short | Standardised surname |
Comments | "Surname(s) of the holder transliterated using the same convention as the one used in the holder’s machine readable travel documents (such as the rules defined in ICAO Doc 9303 Part 3). Exactly 1 (one) non-empty field MUST be provided, only including characters A-Z and <. Maximum length: 80 characters (as per ICAO 9303 specification)." |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
12. HCertDCC.1.nam.gn | |
Definition | Forename/given name. Skip if no given name. Separate with spaces. |
Short | Forename/given name. Skip if no given name. Separate with spaces. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. HCertDCC.1.nam.gnt | |
Definition | Standardised forename, same approach as fnt. Skip if no given name. |
Short | Standardised forename, same approach as fnt. Skip if no given name. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
16. HCertDCC.1.dob | |
Definition | Date of birth in YYYY-MM-DD format. Skip if missing. Fill unknown months or days with 'XX'. |
Short | Date of birth in YYYY-MM-DD format. Skip if missing. Fill unknown months or days with 'XX'. |
Control | 0..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
18. HCertDCC.1.v | |
Definition | Vaccination Group (see element details) |
Short | Vaccination Group (see element details) |
Comments | According to the spec, "Vaccination group, if present, MUST contain exactly 1 (one) entry describing exactly one vaccination event. All elements of the vaccination group are mandatory, empty values are not supported." It appears this means the maximum cardinality of the |
Control | 0..* |
Type | BackboneElement |
Invariants | OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). (count() <= 1 ) |
20. HCertDCC.1.v.tg | |
Definition | The selected codes shall refer to COVID-19 or, if more detailed information on the genetic variant of SARS-CoV-2 is needed, to these variants if such detailed information is needed due to epidemiological reasons. Example of a code that should be used is the SNOMED CT code |
Short | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
22. HCertDCC.1.v.vp | |
Definition | Preferred Code System: SNOMED CT or ATC Classification. Examples of codes that should be used from the preferred code systems are the SNOMED CT code 1119305005 (SARS-CoV-2 antigen vaccine), 1119349007 (SARS-CoV-2 mRNA vaccine) or J07BX03 (covid-19 vaccines). The value set should be extended when new vaccine types are developed and put into use. |
Short | Vaccine or prophylaxis (e.g., 'SARS-CoV-2 mRNA vaccine'; SNOMED or ATC; see element details) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
24. HCertDCC.1.v.mp | |
Definition | Preferred Code Systems (in the order of preference):
|
Short | Vaccine product (e.g., 'EU/1/20/1528 (Comirnaty)'; see element details) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Vaccine - COVID-19 - EU Union Register of Medicinial Products (preferred to http://smart.who.int/ddcc/ValueSet/VaccineCovid19EUUnionRegisterValueSet ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. HCertDCC.1.v.ma | |
Definition | Preferred Code System:
If the name includes whitespaces, these should be replaced by a hyphen (-).If marketing authorisation holder is not available, this will be the manufacturer. |
Short | Vaccine marketing authorisation holder or manufacturer (e.g., 'ORG-100030215' (Biontech Manufacturing GmbH)) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. HCertDCC.1.v.dn | |
Definition | Number in a series of doses |
Short | Number in a series of doses |
Control | 1..1 |
Type | positiveInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
30. HCertDCC.1.v.sd | |
Definition | The overall number of doses in the series |
Short | The overall number of doses in the series |
Control | 1..1 |
Type | positiveInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
32. HCertDCC.1.v.dt | |
Definition | Date of vaccination, YYYY-MM-DD format |
Short | Date of vaccination, YYYY-MM-DD format |
Control | 1..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
34. HCertDCC.1.v.co | |
Definition | Country where vaccine was administered (two letter ISo-3166) |
Short | Country where vaccine was administered (two letter ISo-3166) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Iso3166-1-2 (preferred to http://hl7.org/fhir/ValueSet/iso3166-1-2 ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
36. HCertDCC.1.v.is | |
Definition | Certificate issuer (organization name) |
Short | Certificate issuer (organization name) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
38. HCertDCC.1.v.ci | |
Definition | Unique certificate identifier (UVCI) |
Short | Unique certificate identifier (UVCI) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. HCertDCC.1.t | |
Definition | Test Group |
Short | Test Group |
Comments | "Test group, if present, MUST contain exactly 1 (one) entry describing exactly one test result." |
Control | 0..* |
Type | BackboneElement |
Invariants | OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). (count() <= 1 ) |
42. HCertDCC.1.t.tg | |
Definition | The selected codes shall refer to COVID-19 or, if more detailed information on the genetic variant of SARS-CoV-2 is needed, to these variants if such detailed information is needed due to epidemiological reasons. Example of a code that should be used is the SNOMED CT code |
Short | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Lab Test - Pathogen - COVID-19 - SNOMED CT (preferred to http://smart.who.int/ddcc/ValueSet/LabTestPathogenCovid19SnomedValueSet ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
44. HCertDCC.1.t.tt | |
Definition | The codes in this value set shall refer to the method of the test and shall be selected at least to separate the NAAT tests from RAT tests as expressed in Regulation (EU) 2021/953. An example of a code that should be used from the preferred code system is LP217198-3 (Rapid immunoassay). |
Short | Type of test (LOINC code; see element details) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Lab Test - Type - Generic - LOINC (preferred to http://smart.who.int/ddcc/ValueSet/LabTestTypeLoincValueSet ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
46. HCertDCC.1.t.nm | |
Definition | Name of the nucleic acid amplification test (NAAT) used |
Short | Name of the nucleic acid amplification test (NAAT) used |
Comments | From the spec: "The name should include the name of the test manufacturer and the commercial name of the test, separated by a comma." Omit element for RAT test. MUST not be empty. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
48. HCertDCC.1.t.ma | |
Definition | Rapid antigen test (RAT) device identifier from the JRC database |
Short | Rapid antigen test (RAT) device identifier from the JRC database |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
50. HCertDCC.1.t.sc | |
Definition | Date and time when test sample was collected in ISO 8601 format |
Short | Date and time when test sample was collected in ISO 8601 format |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
52. HCertDCC.1.t.tr | |
Definition | The codes selected shall allow distinguishing between positive and negative test results (detected or not detected). Additional values (like undetermined) may be added if the use cases do require this. Examples of codes that should be used from the preferred code system are |
Short | Result of the test (preferred: SNOMED CT GPS code) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Lab Test - Qualitative Result - SNOMED CT (preferred to http://smart.who.int/ddcc/ValueSet/LabTestQualitativeResultSnomedValueSet ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
54. HCertDCC.1.t.tc | |
Definition | Testing centre or facility |
Short | Testing centre or facility |
Comments | Required for NAAT tests. Optional for RAT tests. MUST not be empty (omit instead). |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
56. HCertDCC.1.t.co | |
Definition | Country of test (two letter ISo-3166) |
Short | Country of test (two letter ISo-3166) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Iso3166-1-2 (preferred to http://hl7.org/fhir/ValueSet/iso3166-1-2 ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
58. HCertDCC.1.t.is | |
Definition | Certificate issuer |
Short | Certificate issuer |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
60. HCertDCC.1.t.ci | |
Definition | Unique Certificate Identifier (UVCI) |
Short | Unique Certificate Identifier (UVCI) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
62. HCertDCC.1.r | |
Definition | Recovery Group |
Short | Recovery Group |
Comments | "Recovery group, if present, MUST contain exactly 1 (one) entry describing exactly one recovery statement." |
Control | 0..* |
Type | BackboneElement |
Invariants | OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). (count() <= 1 ) |
64. HCertDCC.1.r.tg | |
Definition | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant) |
Short | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
66. HCertDCC.1.r.fr | |
Definition | 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). |
Short | 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). |
Control | 1..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
68. HCertDCC.1.r.co | |
Definition | Country of test (two letter ISo-3166) |
Short | Country of test (two letter ISo-3166) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Iso3166-1-2 (preferred to http://hl7.org/fhir/ValueSet/iso3166-1-2 ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
70. HCertDCC.1.r.is | |
Definition | Certificate issuer |
Short | Certificate issuer |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
72. HCertDCC.1.r.df | |
Definition | The first date on which the certificate is considered to be valid, in YYYY-MM-DD format (complete date without time). |
Short | The first date on which the certificate is considered to be valid, in YYYY-MM-DD format (complete date without time). |
Control | 1..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
74. HCertDCC.1.r.du | |
Definition | 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). |
Short | 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). |
Control | 1..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
76. HCertDCC.1.r.ci | |
Definition | Unique certificate identifier (UVCI) |
Short | Unique certificate identifier (UVCI) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
0. HCertDCC | |
Definition | 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. |
Short | Payload for Certificate - EU DCC CBOR Web Token Logical Model |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. HCertDCC.1 | |
Definition | EU Digital COVID Certificate v1 |
Short | EU Digital COVID Certificate v1 |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
4. HCertDCC.1.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
6. HCertDCC.1.ver | |
Definition | Schema version |
Short | Schema version |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
8. HCertDCC.1.nam | |
Definition | Person name |
Short | Person name |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
10. HCertDCC.1.nam.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
12. HCertDCC.1.nam.fn | |
Definition | Surname/family name (separate multiple with spaces) |
Short | Surname/family name (separate multiple with spaces) |
Comments | Example from spec: "Musterfrau-Gößinger Müller" |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. HCertDCC.1.nam.fnt | |
Definition | Standardised surname |
Short | Standardised surname |
Comments | "Surname(s) of the holder transliterated using the same convention as the one used in the holder’s machine readable travel documents (such as the rules defined in ICAO Doc 9303 Part 3). Exactly 1 (one) non-empty field MUST be provided, only including characters A-Z and <. Maximum length: 80 characters (as per ICAO 9303 specification)." |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
16. HCertDCC.1.nam.gn | |
Definition | Forename/given name. Skip if no given name. Separate with spaces. |
Short | Forename/given name. Skip if no given name. Separate with spaces. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
18. HCertDCC.1.nam.gnt | |
Definition | Standardised forename, same approach as fnt. Skip if no given name. |
Short | Standardised forename, same approach as fnt. Skip if no given name. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
20. HCertDCC.1.dob | |
Definition | Date of birth in YYYY-MM-DD format. Skip if missing. Fill unknown months or days with 'XX'. |
Short | Date of birth in YYYY-MM-DD format. Skip if missing. Fill unknown months or days with 'XX'. |
Control | 0..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
22. HCertDCC.1.v | |
Definition | Vaccination Group (see element details) |
Short | Vaccination Group (see element details) |
Comments | According to the spec, "Vaccination group, if present, MUST contain exactly 1 (one) entry describing exactly one vaccination event. All elements of the vaccination group are mandatory, empty values are not supported." It appears this means the maximum cardinality of the |
Control | 0..* |
Type | BackboneElement |
Invariants | OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). (count() <= 1 )ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) ) |
24. HCertDCC.1.v.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
26. HCertDCC.1.v.tg | |
Definition | The selected codes shall refer to COVID-19 or, if more detailed information on the genetic variant of SARS-CoV-2 is needed, to these variants if such detailed information is needed due to epidemiological reasons. Example of a code that should be used is the SNOMED CT code |
Short | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. HCertDCC.1.v.vp | |
Definition | Preferred Code System: SNOMED CT or ATC Classification. Examples of codes that should be used from the preferred code systems are the SNOMED CT code 1119305005 (SARS-CoV-2 antigen vaccine), 1119349007 (SARS-CoV-2 mRNA vaccine) or J07BX03 (covid-19 vaccines). The value set should be extended when new vaccine types are developed and put into use. |
Short | Vaccine or prophylaxis (e.g., 'SARS-CoV-2 mRNA vaccine'; SNOMED or ATC; see element details) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
30. HCertDCC.1.v.mp | |
Definition | Preferred Code Systems (in the order of preference):
|
Short | Vaccine product (e.g., 'EU/1/20/1528 (Comirnaty)'; see element details) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Vaccine - COVID-19 - EU Union Register of Medicinial Products (preferred to http://smart.who.int/ddcc/ValueSet/VaccineCovid19EUUnionRegisterValueSet ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
32. HCertDCC.1.v.ma | |
Definition | Preferred Code System:
If the name includes whitespaces, these should be replaced by a hyphen (-).If marketing authorisation holder is not available, this will be the manufacturer. |
Short | Vaccine marketing authorisation holder or manufacturer (e.g., 'ORG-100030215' (Biontech Manufacturing GmbH)) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
34. HCertDCC.1.v.dn | |
Definition | Number in a series of doses |
Short | Number in a series of doses |
Control | 1..1 |
Type | positiveInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
36. HCertDCC.1.v.sd | |
Definition | The overall number of doses in the series |
Short | The overall number of doses in the series |
Control | 1..1 |
Type | positiveInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
38. HCertDCC.1.v.dt | |
Definition | Date of vaccination, YYYY-MM-DD format |
Short | Date of vaccination, YYYY-MM-DD format |
Control | 1..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. HCertDCC.1.v.co | |
Definition | Country where vaccine was administered (two letter ISo-3166) |
Short | Country where vaccine was administered (two letter ISo-3166) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Iso3166-1-2 (preferred to http://hl7.org/fhir/ValueSet/iso3166-1-2 ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
42. HCertDCC.1.v.is | |
Definition | Certificate issuer (organization name) |
Short | Certificate issuer (organization name) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
44. HCertDCC.1.v.ci | |
Definition | Unique certificate identifier (UVCI) |
Short | Unique certificate identifier (UVCI) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
46. HCertDCC.1.t | |
Definition | Test Group |
Short | Test Group |
Comments | "Test group, if present, MUST contain exactly 1 (one) entry describing exactly one test result." |
Control | 0..* |
Type | BackboneElement |
Invariants | OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). (count() <= 1 )ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) ) |
48. HCertDCC.1.t.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
50. HCertDCC.1.t.tg | |
Definition | The selected codes shall refer to COVID-19 or, if more detailed information on the genetic variant of SARS-CoV-2 is needed, to these variants if such detailed information is needed due to epidemiological reasons. Example of a code that should be used is the SNOMED CT code |
Short | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Lab Test - Pathogen - COVID-19 - SNOMED CT (preferred to http://smart.who.int/ddcc/ValueSet/LabTestPathogenCovid19SnomedValueSet ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
52. HCertDCC.1.t.tt | |
Definition | The codes in this value set shall refer to the method of the test and shall be selected at least to separate the NAAT tests from RAT tests as expressed in Regulation (EU) 2021/953. An example of a code that should be used from the preferred code system is LP217198-3 (Rapid immunoassay). |
Short | Type of test (LOINC code; see element details) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Lab Test - Type - Generic - LOINC (preferred to http://smart.who.int/ddcc/ValueSet/LabTestTypeLoincValueSet ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
54. HCertDCC.1.t.nm | |
Definition | Name of the nucleic acid amplification test (NAAT) used |
Short | Name of the nucleic acid amplification test (NAAT) used |
Comments | From the spec: "The name should include the name of the test manufacturer and the commercial name of the test, separated by a comma." Omit element for RAT test. MUST not be empty. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
56. HCertDCC.1.t.ma | |
Definition | Rapid antigen test (RAT) device identifier from the JRC database |
Short | Rapid antigen test (RAT) device identifier from the JRC database |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
58. HCertDCC.1.t.sc | |
Definition | Date and time when test sample was collected in ISO 8601 format |
Short | Date and time when test sample was collected in ISO 8601 format |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
60. HCertDCC.1.t.tr | |
Definition | The codes selected shall allow distinguishing between positive and negative test results (detected or not detected). Additional values (like undetermined) may be added if the use cases do require this. Examples of codes that should be used from the preferred code system are |
Short | Result of the test (preferred: SNOMED CT GPS code) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Lab Test - Qualitative Result - SNOMED CT (preferred to http://smart.who.int/ddcc/ValueSet/LabTestQualitativeResultSnomedValueSet ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
62. HCertDCC.1.t.tc | |
Definition | Testing centre or facility |
Short | Testing centre or facility |
Comments | Required for NAAT tests. Optional for RAT tests. MUST not be empty (omit instead). |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
64. HCertDCC.1.t.co | |
Definition | Country of test (two letter ISo-3166) |
Short | Country of test (two letter ISo-3166) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Iso3166-1-2 (preferred to http://hl7.org/fhir/ValueSet/iso3166-1-2 ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
66. HCertDCC.1.t.is | |
Definition | Certificate issuer |
Short | Certificate issuer |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
68. HCertDCC.1.t.ci | |
Definition | Unique Certificate Identifier (UVCI) |
Short | Unique Certificate Identifier (UVCI) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
70. HCertDCC.1.r | |
Definition | Recovery Group |
Short | Recovery Group |
Comments | "Recovery group, if present, MUST contain exactly 1 (one) entry describing exactly one recovery statement." |
Control | 0..* |
Type | BackboneElement |
Invariants | OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). (count() <= 1 )ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) ) |
72. HCertDCC.1.r.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
74. HCertDCC.1.r.tg | |
Definition | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant) |
Short | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
76. HCertDCC.1.r.fr | |
Definition | 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). |
Short | 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). |
Control | 1..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
78. HCertDCC.1.r.co | |
Definition | Country of test (two letter ISo-3166) |
Short | Country of test (two letter ISo-3166) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Iso3166-1-2 (preferred to http://hl7.org/fhir/ValueSet/iso3166-1-2 ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
80. HCertDCC.1.r.is | |
Definition | Certificate issuer |
Short | Certificate issuer |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
82. HCertDCC.1.r.df | |
Definition | The first date on which the certificate is considered to be valid, in YYYY-MM-DD format (complete date without time). |
Short | The first date on which the certificate is considered to be valid, in YYYY-MM-DD format (complete date without time). |
Control | 1..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
84. HCertDCC.1.r.du | |
Definition | 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). |
Short | 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). |
Control | 1..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
86. HCertDCC.1.r.ci | |
Definition | Unique certificate identifier (UVCI) |
Short | Unique certificate identifier (UVCI) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
0. HCertDCC | |
Definition | 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. |
Short | Payload for Certificate - EU DCC CBOR Web Token Logical Model |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. HCertDCC.1 | |
Definition | EU Digital COVID Certificate v1 |
Short | EU Digital COVID Certificate v1 |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
4. HCertDCC.1.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
6. HCertDCC.1.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on HCertDCC.1.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
8. HCertDCC.1.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
10. HCertDCC.1.ver | |
Definition | Schema version |
Short | Schema version |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
12. HCertDCC.1.nam | |
Definition | Person name |
Short | Person name |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
14. HCertDCC.1.nam.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
16. HCertDCC.1.nam.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on HCertDCC.1.nam.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
18. HCertDCC.1.nam.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
20. HCertDCC.1.nam.fn | |
Definition | Surname/family name (separate multiple with spaces) |
Short | Surname/family name (separate multiple with spaces) |
Comments | Example from spec: "Musterfrau-Gößinger Müller" |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
22. HCertDCC.1.nam.fnt | |
Definition | Standardised surname |
Short | Standardised surname |
Comments | "Surname(s) of the holder transliterated using the same convention as the one used in the holder’s machine readable travel documents (such as the rules defined in ICAO Doc 9303 Part 3). Exactly 1 (one) non-empty field MUST be provided, only including characters A-Z and <. Maximum length: 80 characters (as per ICAO 9303 specification)." |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
24. HCertDCC.1.nam.gn | |
Definition | Forename/given name. Skip if no given name. Separate with spaces. |
Short | Forename/given name. Skip if no given name. Separate with spaces. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. HCertDCC.1.nam.gnt | |
Definition | Standardised forename, same approach as fnt. Skip if no given name. |
Short | Standardised forename, same approach as fnt. Skip if no given name. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. HCertDCC.1.dob | |
Definition | Date of birth in YYYY-MM-DD format. Skip if missing. Fill unknown months or days with 'XX'. |
Short | Date of birth in YYYY-MM-DD format. Skip if missing. Fill unknown months or days with 'XX'. |
Control | 0..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
30. HCertDCC.1.v | |
Definition | Vaccination Group (see element details) |
Short | Vaccination Group (see element details) |
Comments | According to the spec, "Vaccination group, if present, MUST contain exactly 1 (one) entry describing exactly one vaccination event. All elements of the vaccination group are mandatory, empty values are not supported." It appears this means the maximum cardinality of the |
Control | 0..* |
Type | BackboneElement |
Invariants | OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). (count() <= 1 )ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) ) |
32. HCertDCC.1.v.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
34. HCertDCC.1.v.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on HCertDCC.1.v.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
36. HCertDCC.1.v.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
38. HCertDCC.1.v.tg | |
Definition | The selected codes shall refer to COVID-19 or, if more detailed information on the genetic variant of SARS-CoV-2 is needed, to these variants if such detailed information is needed due to epidemiological reasons. Example of a code that should be used is the SNOMED CT code |
Short | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. HCertDCC.1.v.vp | |
Definition | Preferred Code System: SNOMED CT or ATC Classification. Examples of codes that should be used from the preferred code systems are the SNOMED CT code 1119305005 (SARS-CoV-2 antigen vaccine), 1119349007 (SARS-CoV-2 mRNA vaccine) or J07BX03 (covid-19 vaccines). The value set should be extended when new vaccine types are developed and put into use. |
Short | Vaccine or prophylaxis (e.g., 'SARS-CoV-2 mRNA vaccine'; SNOMED or ATC; see element details) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
42. HCertDCC.1.v.mp | |
Definition | Preferred Code Systems (in the order of preference):
|
Short | Vaccine product (e.g., 'EU/1/20/1528 (Comirnaty)'; see element details) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Vaccine - COVID-19 - EU Union Register of Medicinial Products (preferred to http://smart.who.int/ddcc/ValueSet/VaccineCovid19EUUnionRegisterValueSet ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
44. HCertDCC.1.v.ma | |
Definition | Preferred Code System:
If the name includes whitespaces, these should be replaced by a hyphen (-).If marketing authorisation holder is not available, this will be the manufacturer. |
Short | Vaccine marketing authorisation holder or manufacturer (e.g., 'ORG-100030215' (Biontech Manufacturing GmbH)) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
46. HCertDCC.1.v.dn | |
Definition | Number in a series of doses |
Short | Number in a series of doses |
Control | 1..1 |
Type | positiveInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
48. HCertDCC.1.v.sd | |
Definition | The overall number of doses in the series |
Short | The overall number of doses in the series |
Control | 1..1 |
Type | positiveInt |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
50. HCertDCC.1.v.dt | |
Definition | Date of vaccination, YYYY-MM-DD format |
Short | Date of vaccination, YYYY-MM-DD format |
Control | 1..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
52. HCertDCC.1.v.co | |
Definition | Country where vaccine was administered (two letter ISo-3166) |
Short | Country where vaccine was administered (two letter ISo-3166) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Iso3166-1-2 (preferred to http://hl7.org/fhir/ValueSet/iso3166-1-2 ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
54. HCertDCC.1.v.is | |
Definition | Certificate issuer (organization name) |
Short | Certificate issuer (organization name) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
56. HCertDCC.1.v.ci | |
Definition | Unique certificate identifier (UVCI) |
Short | Unique certificate identifier (UVCI) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
58. HCertDCC.1.t | |
Definition | Test Group |
Short | Test Group |
Comments | "Test group, if present, MUST contain exactly 1 (one) entry describing exactly one test result." |
Control | 0..* |
Type | BackboneElement |
Invariants | OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). (count() <= 1 )ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) ) |
60. HCertDCC.1.t.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
62. HCertDCC.1.t.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on HCertDCC.1.t.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
64. HCertDCC.1.t.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
66. HCertDCC.1.t.tg | |
Definition | The selected codes shall refer to COVID-19 or, if more detailed information on the genetic variant of SARS-CoV-2 is needed, to these variants if such detailed information is needed due to epidemiological reasons. Example of a code that should be used is the SNOMED CT code |
Short | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Lab Test - Pathogen - COVID-19 - SNOMED CT (preferred to http://smart.who.int/ddcc/ValueSet/LabTestPathogenCovid19SnomedValueSet ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
68. HCertDCC.1.t.tt | |
Definition | The codes in this value set shall refer to the method of the test and shall be selected at least to separate the NAAT tests from RAT tests as expressed in Regulation (EU) 2021/953. An example of a code that should be used from the preferred code system is LP217198-3 (Rapid immunoassay). |
Short | Type of test (LOINC code; see element details) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Lab Test - Type - Generic - LOINC (preferred to http://smart.who.int/ddcc/ValueSet/LabTestTypeLoincValueSet ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
70. HCertDCC.1.t.nm | |
Definition | Name of the nucleic acid amplification test (NAAT) used |
Short | Name of the nucleic acid amplification test (NAAT) used |
Comments | From the spec: "The name should include the name of the test manufacturer and the commercial name of the test, separated by a comma." Omit element for RAT test. MUST not be empty. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
72. HCertDCC.1.t.ma | |
Definition | Rapid antigen test (RAT) device identifier from the JRC database |
Short | Rapid antigen test (RAT) device identifier from the JRC database |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
74. HCertDCC.1.t.sc | |
Definition | Date and time when test sample was collected in ISO 8601 format |
Short | Date and time when test sample was collected in ISO 8601 format |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
76. HCertDCC.1.t.tr | |
Definition | The codes selected shall allow distinguishing between positive and negative test results (detected or not detected). Additional values (like undetermined) may be added if the use cases do require this. Examples of codes that should be used from the preferred code system are |
Short | Result of the test (preferred: SNOMED CT GPS code) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Lab Test - Qualitative Result - SNOMED CT (preferred to http://smart.who.int/ddcc/ValueSet/LabTestQualitativeResultSnomedValueSet ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
78. HCertDCC.1.t.tc | |
Definition | Testing centre or facility |
Short | Testing centre or facility |
Comments | Required for NAAT tests. Optional for RAT tests. MUST not be empty (omit instead). |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
80. HCertDCC.1.t.co | |
Definition | Country of test (two letter ISo-3166) |
Short | Country of test (two letter ISo-3166) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Iso3166-1-2 (preferred to http://hl7.org/fhir/ValueSet/iso3166-1-2 ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
82. HCertDCC.1.t.is | |
Definition | Certificate issuer |
Short | Certificate issuer |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
84. HCertDCC.1.t.ci | |
Definition | Unique Certificate Identifier (UVCI) |
Short | Unique Certificate Identifier (UVCI) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
86. HCertDCC.1.r | |
Definition | Recovery Group |
Short | Recovery Group |
Comments | "Recovery group, if present, MUST contain exactly 1 (one) entry describing exactly one recovery statement." |
Control | 0..* |
Type | BackboneElement |
Invariants | OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON). (count() <= 1 )ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) ) |
88. HCertDCC.1.r.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
90. HCertDCC.1.r.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on HCertDCC.1.r.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
92. HCertDCC.1.r.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
94. HCertDCC.1.r.tg | |
Definition | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant) |
Short | Disease or agent targeted (SNOMED CT GPS code for COVID-19 or variant) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
96. HCertDCC.1.r.fr | |
Definition | 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). |
Short | 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). |
Control | 1..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
98. HCertDCC.1.r.co | |
Definition | Country of test (two letter ISo-3166) |
Short | Country of test (two letter ISo-3166) |
Control | 1..1 |
Binding | The codes SHOULD be taken from Iso3166-1-2 (preferred to http://hl7.org/fhir/ValueSet/iso3166-1-2 ) |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
100. HCertDCC.1.r.is | |
Definition | Certificate issuer |
Short | Certificate issuer |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
102. HCertDCC.1.r.df | |
Definition | The first date on which the certificate is considered to be valid, in YYYY-MM-DD format (complete date without time). |
Short | The first date on which the certificate is considered to be valid, in YYYY-MM-DD format (complete date without time). |
Control | 1..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
104. HCertDCC.1.r.du | |
Definition | 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). |
Short | 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). |
Control | 1..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
106. HCertDCC.1.r.ci | |
Definition | Unique certificate identifier (UVCI) |
Short | Unique certificate identifier (UVCI) |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |