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

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

Logical Model: Payload for Certificate - EU DCC CBOR Web Token Logical Model ( Abstract )

Official URL: http://smart.who.int/ddcc/StructureDefinition/HCertDCC Version: 1.0.0
Draft as of 2024-01-19 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:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. HCertDCC 0..*BaseThis is an abstract type.
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..1BackboneElementEU Digital COVID Certificate v1
.... ver 1..1stringSchema version
.... nam 1..1BackboneElementPerson name
..... fn 0..1stringSurname/family name (separate multiple with spaces)
..... fnt 1..1stringStandardised surname
..... gn 0..1stringForename/given name. Skip if no given name. Separate with spaces.
..... gnt 0..1stringStandardised forename, same approach as fnt. Skip if no given name.
.... dob 0..1dateDate of birth in YYYY-MM-DD format. Skip if missing. Fill unknown months or days with 'XX'.
.... v C0..*BackboneElementVaccination 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..1stringDisease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details)
..... vp 1..1stringVaccine or prophylaxis (e.g., 'SARS-CoV-2 mRNA vaccine'; SNOMED or ATC; see element details)
..... mp 1..1stringVaccine product (e.g., 'EU/1/20/1528 (Comirnaty)'; see element details)
Binding: Vaccine - COVID-19 - EU Union Register of Medicinial Products (preferred)
..... ma 1..1stringVaccine marketing authorisation holder or manufacturer (e.g., 'ORG-100030215' (Biontech Manufacturing GmbH))
..... dn 1..1positiveIntNumber in a series of doses
..... sd 1..1positiveIntThe overall number of doses in the series
..... dt 1..1dateDate of vaccination, YYYY-MM-DD format
..... co 1..1stringCountry where vaccine was administered (two letter ISo-3166)
Binding: Iso3166-1-2 (preferred)
..... is 1..1stringCertificate issuer (organization name)
..... ci 1..1stringUnique certificate identifier (UVCI)
.... t C0..*BackboneElementTest Group
OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON).
..... tg 1..1stringDisease 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..1stringType of test (LOINC code; see element details)
Binding: Lab Test - Type - Generic - LOINC (preferred)
..... nm 0..1stringName of the nucleic acid amplification test (NAAT) used
..... ma 0..1stringRapid antigen test (RAT) device identifier from the JRC database
..... sc 1..1dateTimeDate and time when test sample was collected in ISO 8601 format
..... tr 1..1stringResult of the test (preferred: SNOMED CT GPS code)
Binding: Lab Test - Qualitative Result - SNOMED CT (preferred)
..... tc 0..1stringTesting centre or facility
..... co 1..1stringCountry of test (two letter ISo-3166)
Binding: Iso3166-1-2 (preferred)
..... is 1..1stringCertificate issuer
..... ci 1..1stringUnique Certificate Identifier (UVCI)
.... r C0..*BackboneElementRecovery Group
OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON).
..... tg 1..1stringDisease or agent targeted (SNOMED CT GPS code for COVID-19 or variant)
..... fr 1..1dateThe 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..1stringCountry of test (two letter ISo-3166)
Binding: Iso3166-1-2 (preferred)
..... is 0..1stringCertificate issuer
..... df 1..1dateThe first date on which the certificate is considered to be valid, in YYYY-MM-DD format (complete date without time).
..... du 1..1dateThe 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..1stringUnique certificate identifier (UVCI)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
HCertDCC.1.v.mppreferredVaccineCovid19EUUnionRegisterValueSet
HCertDCC.1.v.copreferredIso3166-1-2
HCertDCC.1.t.tgpreferredLabTestPathogenCovid19SnomedValueSet
HCertDCC.1.t.ttpreferredLabTestTypeLoincValueSet
HCertDCC.1.t.trpreferredLabTestQualitativeResultSnomedValueSet
HCertDCC.1.t.copreferredIso3166-1-2
HCertDCC.1.r.copreferredIso3166-1-2

Constraints

IdGradePath(s)DetailsRequirements
OnlyOneAllowederrorHCertDCC.1.v, HCertDCC.1.t, HCertDCC.1.rOnly one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON).
: count() <= 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. HCertDCC 0..*BaseThis is an abstract type.
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..1BackboneElementEU Digital COVID Certificate v1
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ver 1..1stringSchema version
.... nam 1..1BackboneElementPerson name
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... fn 0..1stringSurname/family name (separate multiple with spaces)
..... fnt 1..1stringStandardised surname
..... gn 0..1stringForename/given name. Skip if no given name. Separate with spaces.
..... gnt 0..1stringStandardised forename, same approach as fnt. Skip if no given name.
.... dob 0..1dateDate of birth in YYYY-MM-DD format. Skip if missing. Fill unknown months or days with 'XX'.
.... v C0..*BackboneElementVaccination 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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... tg 1..1stringDisease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details)
..... vp 1..1stringVaccine or prophylaxis (e.g., 'SARS-CoV-2 mRNA vaccine'; SNOMED or ATC; see element details)
..... mp 1..1stringVaccine product (e.g., 'EU/1/20/1528 (Comirnaty)'; see element details)
Binding: Vaccine - COVID-19 - EU Union Register of Medicinial Products (preferred)
..... ma 1..1stringVaccine marketing authorisation holder or manufacturer (e.g., 'ORG-100030215' (Biontech Manufacturing GmbH))
..... dn 1..1positiveIntNumber in a series of doses
..... sd 1..1positiveIntThe overall number of doses in the series
..... dt 1..1dateDate of vaccination, YYYY-MM-DD format
..... co 1..1stringCountry where vaccine was administered (two letter ISo-3166)
Binding: Iso3166-1-2 (preferred)
..... is 1..1stringCertificate issuer (organization name)
..... ci 1..1stringUnique certificate identifier (UVCI)
.... t C0..*BackboneElementTest Group
OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON).
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... tg 1..1stringDisease 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..1stringType of test (LOINC code; see element details)
Binding: Lab Test - Type - Generic - LOINC (preferred)
..... nm 0..1stringName of the nucleic acid amplification test (NAAT) used
..... ma 0..1stringRapid antigen test (RAT) device identifier from the JRC database
..... sc 1..1dateTimeDate and time when test sample was collected in ISO 8601 format
..... tr 1..1stringResult of the test (preferred: SNOMED CT GPS code)
Binding: Lab Test - Qualitative Result - SNOMED CT (preferred)
..... tc 0..1stringTesting centre or facility
..... co 1..1stringCountry of test (two letter ISo-3166)
Binding: Iso3166-1-2 (preferred)
..... is 1..1stringCertificate issuer
..... ci 1..1stringUnique Certificate Identifier (UVCI)
.... r C0..*BackboneElementRecovery Group
OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON).
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... tg 1..1stringDisease or agent targeted (SNOMED CT GPS code for COVID-19 or variant)
..... fr 1..1dateThe 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..1stringCountry of test (two letter ISo-3166)
Binding: Iso3166-1-2 (preferred)
..... is 0..1stringCertificate issuer
..... df 1..1dateThe first date on which the certificate is considered to be valid, in YYYY-MM-DD format (complete date without time).
..... du 1..1dateThe 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..1stringUnique certificate identifier (UVCI)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HCertDCC.1.v.mppreferredVaccineCovid19EUUnionRegisterValueSet
HCertDCC.1.v.copreferredIso3166-1-2
HCertDCC.1.t.tgpreferredLabTestPathogenCovid19SnomedValueSet
HCertDCC.1.t.ttpreferredLabTestTypeLoincValueSet
HCertDCC.1.t.trpreferredLabTestQualitativeResultSnomedValueSet
HCertDCC.1.t.copreferredIso3166-1-2
HCertDCC.1.r.copreferredIso3166-1-2

Constraints

IdGradePath(s)DetailsRequirements
OnlyOneAllowederrorHCertDCC.1.v, HCertDCC.1.t, HCertDCC.1.rOnly one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON).
: count() <= 1
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. HCertDCC 0..*BaseThis is an abstract type.
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..1BackboneElementEU Digital COVID Certificate v1
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ver 1..1stringSchema version
.... nam 1..1BackboneElementPerson name
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... fn 0..1stringSurname/family name (separate multiple with spaces)
..... fnt 1..1stringStandardised surname
..... gn 0..1stringForename/given name. Skip if no given name. Separate with spaces.
..... gnt 0..1stringStandardised forename, same approach as fnt. Skip if no given name.
.... dob 0..1dateDate of birth in YYYY-MM-DD format. Skip if missing. Fill unknown months or days with 'XX'.
.... v C0..*BackboneElementVaccination 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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... tg 1..1stringDisease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details)
..... vp 1..1stringVaccine or prophylaxis (e.g., 'SARS-CoV-2 mRNA vaccine'; SNOMED or ATC; see element details)
..... mp 1..1stringVaccine product (e.g., 'EU/1/20/1528 (Comirnaty)'; see element details)
Binding: Vaccine - COVID-19 - EU Union Register of Medicinial Products (preferred)
..... ma 1..1stringVaccine marketing authorisation holder or manufacturer (e.g., 'ORG-100030215' (Biontech Manufacturing GmbH))
..... dn 1..1positiveIntNumber in a series of doses
..... sd 1..1positiveIntThe overall number of doses in the series
..... dt 1..1dateDate of vaccination, YYYY-MM-DD format
..... co 1..1stringCountry where vaccine was administered (two letter ISo-3166)
Binding: Iso3166-1-2 (preferred)
..... is 1..1stringCertificate issuer (organization name)
..... ci 1..1stringUnique certificate identifier (UVCI)
.... t C0..*BackboneElementTest Group
OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON).
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... tg 1..1stringDisease 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..1stringType of test (LOINC code; see element details)
Binding: Lab Test - Type - Generic - LOINC (preferred)
..... nm 0..1stringName of the nucleic acid amplification test (NAAT) used
..... ma 0..1stringRapid antigen test (RAT) device identifier from the JRC database
..... sc 1..1dateTimeDate and time when test sample was collected in ISO 8601 format
..... tr 1..1stringResult of the test (preferred: SNOMED CT GPS code)
Binding: Lab Test - Qualitative Result - SNOMED CT (preferred)
..... tc 0..1stringTesting centre or facility
..... co 1..1stringCountry of test (two letter ISo-3166)
Binding: Iso3166-1-2 (preferred)
..... is 1..1stringCertificate issuer
..... ci 1..1stringUnique Certificate Identifier (UVCI)
.... r C0..*BackboneElementRecovery Group
OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON).
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... tg 1..1stringDisease or agent targeted (SNOMED CT GPS code for COVID-19 or variant)
..... fr 1..1dateThe 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..1stringCountry of test (two letter ISo-3166)
Binding: Iso3166-1-2 (preferred)
..... is 0..1stringCertificate issuer
..... df 1..1dateThe first date on which the certificate is considered to be valid, in YYYY-MM-DD format (complete date without time).
..... du 1..1dateThe 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..1stringUnique certificate identifier (UVCI)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HCertDCC.1.v.mppreferredVaccineCovid19EUUnionRegisterValueSet
HCertDCC.1.v.copreferredIso3166-1-2
HCertDCC.1.t.tgpreferredLabTestPathogenCovid19SnomedValueSet
HCertDCC.1.t.ttpreferredLabTestTypeLoincValueSet
HCertDCC.1.t.trpreferredLabTestQualitativeResultSnomedValueSet
HCertDCC.1.t.copreferredIso3166-1-2
HCertDCC.1.r.copreferredIso3166-1-2

Constraints

IdGradePath(s)DetailsRequirements
OnlyOneAllowederrorHCertDCC.1.v, HCertDCC.1.t, HCertDCC.1.rOnly one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON).
: count() <= 1
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element (27 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. HCertDCC 0..*BaseThis is an abstract type.
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..1BackboneElementEU Digital COVID Certificate v1
.... ver 1..1stringSchema version
.... nam 1..1BackboneElementPerson name
..... fn 0..1stringSurname/family name (separate multiple with spaces)
..... fnt 1..1stringStandardised surname
..... gn 0..1stringForename/given name. Skip if no given name. Separate with spaces.
..... gnt 0..1stringStandardised forename, same approach as fnt. Skip if no given name.
.... dob 0..1dateDate of birth in YYYY-MM-DD format. Skip if missing. Fill unknown months or days with 'XX'.
.... v C0..*BackboneElementVaccination 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..1stringDisease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details)
..... vp 1..1stringVaccine or prophylaxis (e.g., 'SARS-CoV-2 mRNA vaccine'; SNOMED or ATC; see element details)
..... mp 1..1stringVaccine product (e.g., 'EU/1/20/1528 (Comirnaty)'; see element details)
Binding: Vaccine - COVID-19 - EU Union Register of Medicinial Products (preferred)
..... ma 1..1stringVaccine marketing authorisation holder or manufacturer (e.g., 'ORG-100030215' (Biontech Manufacturing GmbH))
..... dn 1..1positiveIntNumber in a series of doses
..... sd 1..1positiveIntThe overall number of doses in the series
..... dt 1..1dateDate of vaccination, YYYY-MM-DD format
..... co 1..1stringCountry where vaccine was administered (two letter ISo-3166)
Binding: Iso3166-1-2 (preferred)
..... is 1..1stringCertificate issuer (organization name)
..... ci 1..1stringUnique certificate identifier (UVCI)
.... t C0..*BackboneElementTest Group
OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON).
..... tg 1..1stringDisease 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..1stringType of test (LOINC code; see element details)
Binding: Lab Test - Type - Generic - LOINC (preferred)
..... nm 0..1stringName of the nucleic acid amplification test (NAAT) used
..... ma 0..1stringRapid antigen test (RAT) device identifier from the JRC database
..... sc 1..1dateTimeDate and time when test sample was collected in ISO 8601 format
..... tr 1..1stringResult of the test (preferred: SNOMED CT GPS code)
Binding: Lab Test - Qualitative Result - SNOMED CT (preferred)
..... tc 0..1stringTesting centre or facility
..... co 1..1stringCountry of test (two letter ISo-3166)
Binding: Iso3166-1-2 (preferred)
..... is 1..1stringCertificate issuer
..... ci 1..1stringUnique Certificate Identifier (UVCI)
.... r C0..*BackboneElementRecovery Group
OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON).
..... tg 1..1stringDisease or agent targeted (SNOMED CT GPS code for COVID-19 or variant)
..... fr 1..1dateThe 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..1stringCountry of test (two letter ISo-3166)
Binding: Iso3166-1-2 (preferred)
..... is 0..1stringCertificate issuer
..... df 1..1dateThe first date on which the certificate is considered to be valid, in YYYY-MM-DD format (complete date without time).
..... du 1..1dateThe 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..1stringUnique certificate identifier (UVCI)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
HCertDCC.1.v.mppreferredVaccineCovid19EUUnionRegisterValueSet
HCertDCC.1.v.copreferredIso3166-1-2
HCertDCC.1.t.tgpreferredLabTestPathogenCovid19SnomedValueSet
HCertDCC.1.t.ttpreferredLabTestTypeLoincValueSet
HCertDCC.1.t.trpreferredLabTestQualitativeResultSnomedValueSet
HCertDCC.1.t.copreferredIso3166-1-2
HCertDCC.1.r.copreferredIso3166-1-2

Constraints

IdGradePath(s)DetailsRequirements
OnlyOneAllowederrorHCertDCC.1.v, HCertDCC.1.t, HCertDCC.1.rOnly one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON).
: count() <= 1

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HCertDCC 0..*BaseThis is an abstract type.
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..1BackboneElementEU Digital COVID Certificate v1
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ver 1..1stringSchema version
.... nam 1..1BackboneElementPerson name
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... fn 0..1stringSurname/family name (separate multiple with spaces)
..... fnt 1..1stringStandardised surname
..... gn 0..1stringForename/given name. Skip if no given name. Separate with spaces.
..... gnt 0..1stringStandardised forename, same approach as fnt. Skip if no given name.
.... dob 0..1dateDate of birth in YYYY-MM-DD format. Skip if missing. Fill unknown months or days with 'XX'.
.... v C0..*BackboneElementVaccination 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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... tg 1..1stringDisease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details)
..... vp 1..1stringVaccine or prophylaxis (e.g., 'SARS-CoV-2 mRNA vaccine'; SNOMED or ATC; see element details)
..... mp 1..1stringVaccine product (e.g., 'EU/1/20/1528 (Comirnaty)'; see element details)
Binding: Vaccine - COVID-19 - EU Union Register of Medicinial Products (preferred)
..... ma 1..1stringVaccine marketing authorisation holder or manufacturer (e.g., 'ORG-100030215' (Biontech Manufacturing GmbH))
..... dn 1..1positiveIntNumber in a series of doses
..... sd 1..1positiveIntThe overall number of doses in the series
..... dt 1..1dateDate of vaccination, YYYY-MM-DD format
..... co 1..1stringCountry where vaccine was administered (two letter ISo-3166)
Binding: Iso3166-1-2 (preferred)
..... is 1..1stringCertificate issuer (organization name)
..... ci 1..1stringUnique certificate identifier (UVCI)
.... t C0..*BackboneElementTest Group
OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON).
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... tg 1..1stringDisease 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..1stringType of test (LOINC code; see element details)
Binding: Lab Test - Type - Generic - LOINC (preferred)
..... nm 0..1stringName of the nucleic acid amplification test (NAAT) used
..... ma 0..1stringRapid antigen test (RAT) device identifier from the JRC database
..... sc 1..1dateTimeDate and time when test sample was collected in ISO 8601 format
..... tr 1..1stringResult of the test (preferred: SNOMED CT GPS code)
Binding: Lab Test - Qualitative Result - SNOMED CT (preferred)
..... tc 0..1stringTesting centre or facility
..... co 1..1stringCountry of test (two letter ISo-3166)
Binding: Iso3166-1-2 (preferred)
..... is 1..1stringCertificate issuer
..... ci 1..1stringUnique Certificate Identifier (UVCI)
.... r C0..*BackboneElementRecovery Group
OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON).
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... tg 1..1stringDisease or agent targeted (SNOMED CT GPS code for COVID-19 or variant)
..... fr 1..1dateThe 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..1stringCountry of test (two letter ISo-3166)
Binding: Iso3166-1-2 (preferred)
..... is 0..1stringCertificate issuer
..... df 1..1dateThe first date on which the certificate is considered to be valid, in YYYY-MM-DD format (complete date without time).
..... du 1..1dateThe 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..1stringUnique certificate identifier (UVCI)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HCertDCC.1.v.mppreferredVaccineCovid19EUUnionRegisterValueSet
HCertDCC.1.v.copreferredIso3166-1-2
HCertDCC.1.t.tgpreferredLabTestPathogenCovid19SnomedValueSet
HCertDCC.1.t.ttpreferredLabTestTypeLoincValueSet
HCertDCC.1.t.trpreferredLabTestQualitativeResultSnomedValueSet
HCertDCC.1.t.copreferredIso3166-1-2
HCertDCC.1.r.copreferredIso3166-1-2

Constraints

IdGradePath(s)DetailsRequirements
OnlyOneAllowederrorHCertDCC.1.v, HCertDCC.1.t, HCertDCC.1.rOnly one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON).
: count() <= 1
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HCertDCC 0..*BaseThis is an abstract type.
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..1BackboneElementEU Digital COVID Certificate v1
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ver 1..1stringSchema version
.... nam 1..1BackboneElementPerson name
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... fn 0..1stringSurname/family name (separate multiple with spaces)
..... fnt 1..1stringStandardised surname
..... gn 0..1stringForename/given name. Skip if no given name. Separate with spaces.
..... gnt 0..1stringStandardised forename, same approach as fnt. Skip if no given name.
.... dob 0..1dateDate of birth in YYYY-MM-DD format. Skip if missing. Fill unknown months or days with 'XX'.
.... v C0..*BackboneElementVaccination 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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... tg 1..1stringDisease or agent targeted (SNOMED CT GPS code for COVID-19 or variant; see element details)
..... vp 1..1stringVaccine or prophylaxis (e.g., 'SARS-CoV-2 mRNA vaccine'; SNOMED or ATC; see element details)
..... mp 1..1stringVaccine product (e.g., 'EU/1/20/1528 (Comirnaty)'; see element details)
Binding: Vaccine - COVID-19 - EU Union Register of Medicinial Products (preferred)
..... ma 1..1stringVaccine marketing authorisation holder or manufacturer (e.g., 'ORG-100030215' (Biontech Manufacturing GmbH))
..... dn 1..1positiveIntNumber in a series of doses
..... sd 1..1positiveIntThe overall number of doses in the series
..... dt 1..1dateDate of vaccination, YYYY-MM-DD format
..... co 1..1stringCountry where vaccine was administered (two letter ISo-3166)
Binding: Iso3166-1-2 (preferred)
..... is 1..1stringCertificate issuer (organization name)
..... ci 1..1stringUnique certificate identifier (UVCI)
.... t C0..*BackboneElementTest Group
OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON).
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... tg 1..1stringDisease 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..1stringType of test (LOINC code; see element details)
Binding: Lab Test - Type - Generic - LOINC (preferred)
..... nm 0..1stringName of the nucleic acid amplification test (NAAT) used
..... ma 0..1stringRapid antigen test (RAT) device identifier from the JRC database
..... sc 1..1dateTimeDate and time when test sample was collected in ISO 8601 format
..... tr 1..1stringResult of the test (preferred: SNOMED CT GPS code)
Binding: Lab Test - Qualitative Result - SNOMED CT (preferred)
..... tc 0..1stringTesting centre or facility
..... co 1..1stringCountry of test (two letter ISo-3166)
Binding: Iso3166-1-2 (preferred)
..... is 1..1stringCertificate issuer
..... ci 1..1stringUnique Certificate Identifier (UVCI)
.... r C0..*BackboneElementRecovery Group
OnlyOneAllowed: Only one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON).
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... tg 1..1stringDisease or agent targeted (SNOMED CT GPS code for COVID-19 or variant)
..... fr 1..1dateThe 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..1stringCountry of test (two letter ISo-3166)
Binding: Iso3166-1-2 (preferred)
..... is 0..1stringCertificate issuer
..... df 1..1dateThe first date on which the certificate is considered to be valid, in YYYY-MM-DD format (complete date without time).
..... du 1..1dateThe 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..1stringUnique certificate identifier (UVCI)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HCertDCC.1.v.mppreferredVaccineCovid19EUUnionRegisterValueSet
HCertDCC.1.v.copreferredIso3166-1-2
HCertDCC.1.t.tgpreferredLabTestPathogenCovid19SnomedValueSet
HCertDCC.1.t.ttpreferredLabTestTypeLoincValueSet
HCertDCC.1.t.trpreferredLabTestQualitativeResultSnomedValueSet
HCertDCC.1.t.copreferredIso3166-1-2
HCertDCC.1.r.copreferredIso3166-1-2

Constraints

IdGradePath(s)DetailsRequirements
OnlyOneAllowederrorHCertDCC.1.v, HCertDCC.1.t, HCertDCC.1.rOnly one allowed (cardinality of 0..* is necessary because this element is an array in the EU DCC JSON).
: count() <= 1
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element (27 nested mandatory elements)

 

Other representations of profile: CSV, Excel