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: Certificate - ICAO Visible Digital Seal Logical Model ( Abstract )

Official URL: http://smart.who.int/ddcc/StructureDefinition/CertICAOVDS Version: 1.0.0
Draft as of 2024-01-19 Computable Name: CertICAO

Data elements for the ICAO Visible Digital Seal Core Data Set. Based on https://www.icao.int/vdsnc-spec as of 2023-02-02.

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
.. CertICAOVDS 0..*BaseThis is an abstract type.
Certificate - ICAO Visible Digital Seal Logical Model
Instances of this logical model are not marked to be the target of a Reference
... data 1..1BackboneElementData
.... hdr 1..1BackboneElementHeader
..... t 1..1stringType (either `icao.test` for proof of testing, or `icao.vacc` for proof of vaccination)
..... v 1..1integerVersion
..... is 1..1stringIssuingCountry (ISO-3166 three letter code; see element details)
Binding: Iso3166-1-3 (required)
.... msg 1..1BackboneElementMessage
..... pid 1..1BackboneElementPersonalInformation (more info in element description)
...... n 1..1stringName (Name of the holder (as specified in Doc 9303-3) MUST be used.)
...... dob 0..1dateDate of Birth (The DOB of the test subject. The [RFC 3339] full date format YYYY-MM- DD MUST be used.)
...... dt 0..1stringID Document Type of the identity document (see element details)
...... dn 1..1stringID Document Number of the identity document
...... i 0..1stringTravel Document Number
...... ai 0..1stringOther Document Number
...... sex 0..1stringSex of the test subject (as specified in Doc 9303-4 Section 4.1.1.1 – Visual Inspection Zone)
..... utci 0..1stringUTCI (Unique Test Certificate Identifier; used for `icao.test` only, not used of `icao.vacc`)
..... sp 0..1BackboneElementServiceProvider (Required for `icao.test` only, not used of `icao.vacc`)
...... spn 1..1stringName of testing facility or service provider
...... ctr 1..1stringCountry of test (spec does not indicate code system, but presumably this is ISO-3166 like the other country codes in the certificate)
...... cd 1..1BackboneElementContactDetails
....... p 1..1stringPhoneNumber
....... e 1..1stringEmail
....... a 1..1stringAddress
..... dat 0..1BackboneElementDateTimeTestReport (Required for `icao.test` only, not used of `icao.vacc`)
...... sc 1..1dateTimeSpecimenCollection (RFC3339)
...... ri 1..1dateTimeReportIssuance (RFC3339)
..... tr 0..1BackboneElementTestResult (Required for `icao.test` only, not used of `icao.vacc`)
...... tc 1..1stringTestConducted
Binding: Lab Test - Type - ICAO (required)
...... r 1..1stringResults
Binding: Lab Test - Qualitative Result - ICAO (required)
...... m 0..1stringSampling method
Binding: Lab Test - Sample Origin - ICAO (required)
..... opt 0..1stringOptional data issued at the discretion of the issuing authority
..... uvci 0..1stringUnique Vaccination Certificate Identifier (Required for `icao.vacc` only, not used of `icao.test`)
..... ve 0..*BackboneElementVaccinationEvent (Required for `icao.vacc` only, not used of `icao.test`)
...... des 1..1stringVaccine or Prophylaxis (ICD-11 MMS code descending from http://id.who.int/icd/entity/164949870)
Binding: WHO Vaccine List (COVID-19) (required)
...... nam 1..1stringVaccine Brand (medical product name)
...... dis 0..1stringDisease or agent targeted (ICD-11 code)
...... vd 1..*BackboneElementVaccinationDetails
....... dvc 1..1dateDate of vaccination (see element details)
....... seq 1..1positiveIntDose number (vaccine dose number, integer between 1 and 99)
....... ctr 1..1stringCountry of vaccination (ISO-3166 three letter code; see element details)
Binding: Iso3166-1-3 (required)
....... adm 1..1stringAdministering centre (The name or identifier of the vaccination facility)
....... lot 1..1stringVaccine batch number
....... dvn 0..1dateDue date of next dose (see element details)
... sig 0..1BackboneElementSignature
.... alg 1..1stringSignatureAlgo
.... cer 1..1stringCertificate (X.509 signer certificate in base64url [RFC 4648])
.... sigvl 1..1stringSignatureValue (Signature value signed over the Data in base64url [RFC 4648])

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
CertICAOVDS.data.hdr.isrequiredIso3166-1-3
CertICAOVDS.data.msg.tr.tcrequiredLabTestTypeIcaoValueSet
CertICAOVDS.data.msg.tr.rrequiredLabTestResultIcaoValueSet
CertICAOVDS.data.msg.tr.mrequiredLabTestSampleOriginIcaoValueSet
CertICAOVDS.data.msg.ve.desrequiredWHO_DDCC_Vaccines_COVID_19
CertICAOVDS.data.msg.ve.vd.ctrrequiredIso3166-1-3
NameFlagsCard.TypeDescription & Constraintsdoco
.. CertICAOVDS 0..*BaseThis is an abstract type.
Certificate - ICAO Visible Digital Seal Logical Model
Instances of this logical model are not marked to be the target of a Reference
... data 1..1BackboneElementData
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... hdr 1..1BackboneElementHeader
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... t 1..1stringType (either `icao.test` for proof of testing, or `icao.vacc` for proof of vaccination)
..... v 1..1integerVersion
..... is 1..1stringIssuingCountry (ISO-3166 three letter code; see element details)
Binding: Iso3166-1-3 (required)
.... msg 1..1BackboneElementMessage
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... pid 1..1BackboneElementPersonalInformation (more info in element description)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... n 1..1stringName (Name of the holder (as specified in Doc 9303-3) MUST be used.)
...... dob 0..1dateDate of Birth (The DOB of the test subject. The [RFC 3339] full date format YYYY-MM- DD MUST be used.)
...... dt 0..1stringID Document Type of the identity document (see element details)
...... dn 1..1stringID Document Number of the identity document
...... i 0..1stringTravel Document Number
...... ai 0..1stringOther Document Number
...... sex 0..1stringSex of the test subject (as specified in Doc 9303-4 Section 4.1.1.1 – Visual Inspection Zone)
..... utci 0..1stringUTCI (Unique Test Certificate Identifier; used for `icao.test` only, not used of `icao.vacc`)
..... sp 0..1BackboneElementServiceProvider (Required for `icao.test` only, not used of `icao.vacc`)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... spn 1..1stringName of testing facility or service provider
...... ctr 1..1stringCountry of test (spec does not indicate code system, but presumably this is ISO-3166 like the other country codes in the certificate)
...... cd 1..1BackboneElementContactDetails
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... p 1..1stringPhoneNumber
....... e 1..1stringEmail
....... a 1..1stringAddress
..... dat 0..1BackboneElementDateTimeTestReport (Required for `icao.test` only, not used of `icao.vacc`)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... sc 1..1dateTimeSpecimenCollection (RFC3339)
...... ri 1..1dateTimeReportIssuance (RFC3339)
..... tr 0..1BackboneElementTestResult (Required for `icao.test` only, not used of `icao.vacc`)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... tc 1..1stringTestConducted
Binding: Lab Test - Type - ICAO (required)
...... r 1..1stringResults
Binding: Lab Test - Qualitative Result - ICAO (required)
...... m 0..1stringSampling method
Binding: Lab Test - Sample Origin - ICAO (required)
..... opt 0..1stringOptional data issued at the discretion of the issuing authority
..... uvci 0..1stringUnique Vaccination Certificate Identifier (Required for `icao.vacc` only, not used of `icao.test`)
..... ve 0..*BackboneElementVaccinationEvent (Required for `icao.vacc` only, not used of `icao.test`)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... des 1..1stringVaccine or Prophylaxis (ICD-11 MMS code descending from http://id.who.int/icd/entity/164949870)
Binding: WHO Vaccine List (COVID-19) (required)
...... nam 1..1stringVaccine Brand (medical product name)
...... dis 0..1stringDisease or agent targeted (ICD-11 code)
...... vd 1..*BackboneElementVaccinationDetails
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... dvc 1..1dateDate of vaccination (see element details)
....... seq 1..1positiveIntDose number (vaccine dose number, integer between 1 and 99)
....... ctr 1..1stringCountry of vaccination (ISO-3166 three letter code; see element details)
Binding: Iso3166-1-3 (required)
....... adm 1..1stringAdministering centre (The name or identifier of the vaccination facility)
....... lot 1..1stringVaccine batch number
....... dvn 0..1dateDue date of next dose (see element details)
... sig 0..1BackboneElementSignature
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... alg 1..1stringSignatureAlgo
.... cer 1..1stringCertificate (X.509 signer certificate in base64url [RFC 4648])
.... sigvl 1..1stringSignatureValue (Signature value signed over the Data in base64url [RFC 4648])

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CertICAOVDS.data.hdr.isrequiredIso3166-1-3
CertICAOVDS.data.msg.tr.tcrequiredLabTestTypeIcaoValueSet
CertICAOVDS.data.msg.tr.rrequiredLabTestResultIcaoValueSet
CertICAOVDS.data.msg.tr.mrequiredLabTestSampleOriginIcaoValueSet
CertICAOVDS.data.msg.ve.desrequiredWHO_DDCC_Vaccines_COVID_19
CertICAOVDS.data.msg.ve.vd.ctrrequiredIso3166-1-3

Constraints

IdGradePath(s)DetailsRequirements
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
.. CertICAOVDS 0..*BaseThis is an abstract type.
Certificate - ICAO Visible Digital Seal Logical Model
Instances of this logical model are not marked to be the target of a Reference
... data 1..1BackboneElementData
.... @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
.... hdr 1..1BackboneElementHeader
..... @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
..... t 1..1stringType (either `icao.test` for proof of testing, or `icao.vacc` for proof of vaccination)
..... v 1..1integerVersion
..... is 1..1stringIssuingCountry (ISO-3166 three letter code; see element details)
Binding: Iso3166-1-3 (required)
.... msg 1..1BackboneElementMessage
..... @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
..... pid 1..1BackboneElementPersonalInformation (more info in element description)
...... @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
...... n 1..1stringName (Name of the holder (as specified in Doc 9303-3) MUST be used.)
...... dob 0..1dateDate of Birth (The DOB of the test subject. The [RFC 3339] full date format YYYY-MM- DD MUST be used.)
...... dt 0..1stringID Document Type of the identity document (see element details)
...... dn 1..1stringID Document Number of the identity document
...... i 0..1stringTravel Document Number
...... ai 0..1stringOther Document Number
...... sex 0..1stringSex of the test subject (as specified in Doc 9303-4 Section 4.1.1.1 – Visual Inspection Zone)
..... utci 0..1stringUTCI (Unique Test Certificate Identifier; used for `icao.test` only, not used of `icao.vacc`)
..... sp 0..1BackboneElementServiceProvider (Required for `icao.test` only, not used of `icao.vacc`)
...... @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
...... spn 1..1stringName of testing facility or service provider
...... ctr 1..1stringCountry of test (spec does not indicate code system, but presumably this is ISO-3166 like the other country codes in the certificate)
...... cd 1..1BackboneElementContactDetails
....... @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
....... p 1..1stringPhoneNumber
....... e 1..1stringEmail
....... a 1..1stringAddress
..... dat 0..1BackboneElementDateTimeTestReport (Required for `icao.test` only, not used of `icao.vacc`)
...... @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
...... sc 1..1dateTimeSpecimenCollection (RFC3339)
...... ri 1..1dateTimeReportIssuance (RFC3339)
..... tr 0..1BackboneElementTestResult (Required for `icao.test` only, not used of `icao.vacc`)
...... @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
...... tc 1..1stringTestConducted
Binding: Lab Test - Type - ICAO (required)
...... r 1..1stringResults
Binding: Lab Test - Qualitative Result - ICAO (required)
...... m 0..1stringSampling method
Binding: Lab Test - Sample Origin - ICAO (required)
..... opt 0..1stringOptional data issued at the discretion of the issuing authority
..... uvci 0..1stringUnique Vaccination Certificate Identifier (Required for `icao.vacc` only, not used of `icao.test`)
..... ve 0..*BackboneElementVaccinationEvent (Required for `icao.vacc` only, not used of `icao.test`)
...... @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
...... des 1..1stringVaccine or Prophylaxis (ICD-11 MMS code descending from http://id.who.int/icd/entity/164949870)
Binding: WHO Vaccine List (COVID-19) (required)
...... nam 1..1stringVaccine Brand (medical product name)
...... dis 0..1stringDisease or agent targeted (ICD-11 code)
...... vd 1..*BackboneElementVaccinationDetails
....... @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
....... dvc 1..1dateDate of vaccination (see element details)
....... seq 1..1positiveIntDose number (vaccine dose number, integer between 1 and 99)
....... ctr 1..1stringCountry of vaccination (ISO-3166 three letter code; see element details)
Binding: Iso3166-1-3 (required)
....... adm 1..1stringAdministering centre (The name or identifier of the vaccination facility)
....... lot 1..1stringVaccine batch number
....... dvn 0..1dateDue date of next dose (see element details)
... sig 0..1BackboneElementSignature
.... @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
.... alg 1..1stringSignatureAlgo
.... cer 1..1stringCertificate (X.509 signer certificate in base64url [RFC 4648])
.... sigvl 1..1stringSignatureValue (Signature value signed over the Data in base64url [RFC 4648])

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CertICAOVDS.data.hdr.isrequiredIso3166-1-3
CertICAOVDS.data.msg.tr.tcrequiredLabTestTypeIcaoValueSet
CertICAOVDS.data.msg.tr.rrequiredLabTestResultIcaoValueSet
CertICAOVDS.data.msg.tr.mrequiredLabTestSampleOriginIcaoValueSet
CertICAOVDS.data.msg.ve.desrequiredWHO_DDCC_Vaccines_COVID_19
CertICAOVDS.data.msg.ve.vd.ctrrequiredIso3166-1-3

Constraints

IdGradePath(s)DetailsRequirements
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 (30 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. CertICAOVDS 0..*BaseThis is an abstract type.
Certificate - ICAO Visible Digital Seal Logical Model
Instances of this logical model are not marked to be the target of a Reference
... data 1..1BackboneElementData
.... hdr 1..1BackboneElementHeader
..... t 1..1stringType (either `icao.test` for proof of testing, or `icao.vacc` for proof of vaccination)
..... v 1..1integerVersion
..... is 1..1stringIssuingCountry (ISO-3166 three letter code; see element details)
Binding: Iso3166-1-3 (required)
.... msg 1..1BackboneElementMessage
..... pid 1..1BackboneElementPersonalInformation (more info in element description)
...... n 1..1stringName (Name of the holder (as specified in Doc 9303-3) MUST be used.)
...... dob 0..1dateDate of Birth (The DOB of the test subject. The [RFC 3339] full date format YYYY-MM- DD MUST be used.)
...... dt 0..1stringID Document Type of the identity document (see element details)
...... dn 1..1stringID Document Number of the identity document
...... i 0..1stringTravel Document Number
...... ai 0..1stringOther Document Number
...... sex 0..1stringSex of the test subject (as specified in Doc 9303-4 Section 4.1.1.1 – Visual Inspection Zone)
..... utci 0..1stringUTCI (Unique Test Certificate Identifier; used for `icao.test` only, not used of `icao.vacc`)
..... sp 0..1BackboneElementServiceProvider (Required for `icao.test` only, not used of `icao.vacc`)
...... spn 1..1stringName of testing facility or service provider
...... ctr 1..1stringCountry of test (spec does not indicate code system, but presumably this is ISO-3166 like the other country codes in the certificate)
...... cd 1..1BackboneElementContactDetails
....... p 1..1stringPhoneNumber
....... e 1..1stringEmail
....... a 1..1stringAddress
..... dat 0..1BackboneElementDateTimeTestReport (Required for `icao.test` only, not used of `icao.vacc`)
...... sc 1..1dateTimeSpecimenCollection (RFC3339)
...... ri 1..1dateTimeReportIssuance (RFC3339)
..... tr 0..1BackboneElementTestResult (Required for `icao.test` only, not used of `icao.vacc`)
...... tc 1..1stringTestConducted
Binding: Lab Test - Type - ICAO (required)
...... r 1..1stringResults
Binding: Lab Test - Qualitative Result - ICAO (required)
...... m 0..1stringSampling method
Binding: Lab Test - Sample Origin - ICAO (required)
..... opt 0..1stringOptional data issued at the discretion of the issuing authority
..... uvci 0..1stringUnique Vaccination Certificate Identifier (Required for `icao.vacc` only, not used of `icao.test`)
..... ve 0..*BackboneElementVaccinationEvent (Required for `icao.vacc` only, not used of `icao.test`)
...... des 1..1stringVaccine or Prophylaxis (ICD-11 MMS code descending from http://id.who.int/icd/entity/164949870)
Binding: WHO Vaccine List (COVID-19) (required)
...... nam 1..1stringVaccine Brand (medical product name)
...... dis 0..1stringDisease or agent targeted (ICD-11 code)
...... vd 1..*BackboneElementVaccinationDetails
....... dvc 1..1dateDate of vaccination (see element details)
....... seq 1..1positiveIntDose number (vaccine dose number, integer between 1 and 99)
....... ctr 1..1stringCountry of vaccination (ISO-3166 three letter code; see element details)
Binding: Iso3166-1-3 (required)
....... adm 1..1stringAdministering centre (The name or identifier of the vaccination facility)
....... lot 1..1stringVaccine batch number
....... dvn 0..1dateDue date of next dose (see element details)
... sig 0..1BackboneElementSignature
.... alg 1..1stringSignatureAlgo
.... cer 1..1stringCertificate (X.509 signer certificate in base64url [RFC 4648])
.... sigvl 1..1stringSignatureValue (Signature value signed over the Data in base64url [RFC 4648])

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
CertICAOVDS.data.hdr.isrequiredIso3166-1-3
CertICAOVDS.data.msg.tr.tcrequiredLabTestTypeIcaoValueSet
CertICAOVDS.data.msg.tr.rrequiredLabTestResultIcaoValueSet
CertICAOVDS.data.msg.tr.mrequiredLabTestSampleOriginIcaoValueSet
CertICAOVDS.data.msg.ve.desrequiredWHO_DDCC_Vaccines_COVID_19
CertICAOVDS.data.msg.ve.vd.ctrrequiredIso3166-1-3

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CertICAOVDS 0..*BaseThis is an abstract type.
Certificate - ICAO Visible Digital Seal Logical Model
Instances of this logical model are not marked to be the target of a Reference
... data 1..1BackboneElementData
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... hdr 1..1BackboneElementHeader
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... t 1..1stringType (either `icao.test` for proof of testing, or `icao.vacc` for proof of vaccination)
..... v 1..1integerVersion
..... is 1..1stringIssuingCountry (ISO-3166 three letter code; see element details)
Binding: Iso3166-1-3 (required)
.... msg 1..1BackboneElementMessage
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... pid 1..1BackboneElementPersonalInformation (more info in element description)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... n 1..1stringName (Name of the holder (as specified in Doc 9303-3) MUST be used.)
...... dob 0..1dateDate of Birth (The DOB of the test subject. The [RFC 3339] full date format YYYY-MM- DD MUST be used.)
...... dt 0..1stringID Document Type of the identity document (see element details)
...... dn 1..1stringID Document Number of the identity document
...... i 0..1stringTravel Document Number
...... ai 0..1stringOther Document Number
...... sex 0..1stringSex of the test subject (as specified in Doc 9303-4 Section 4.1.1.1 – Visual Inspection Zone)
..... utci 0..1stringUTCI (Unique Test Certificate Identifier; used for `icao.test` only, not used of `icao.vacc`)
..... sp 0..1BackboneElementServiceProvider (Required for `icao.test` only, not used of `icao.vacc`)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... spn 1..1stringName of testing facility or service provider
...... ctr 1..1stringCountry of test (spec does not indicate code system, but presumably this is ISO-3166 like the other country codes in the certificate)
...... cd 1..1BackboneElementContactDetails
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... p 1..1stringPhoneNumber
....... e 1..1stringEmail
....... a 1..1stringAddress
..... dat 0..1BackboneElementDateTimeTestReport (Required for `icao.test` only, not used of `icao.vacc`)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... sc 1..1dateTimeSpecimenCollection (RFC3339)
...... ri 1..1dateTimeReportIssuance (RFC3339)
..... tr 0..1BackboneElementTestResult (Required for `icao.test` only, not used of `icao.vacc`)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... tc 1..1stringTestConducted
Binding: Lab Test - Type - ICAO (required)
...... r 1..1stringResults
Binding: Lab Test - Qualitative Result - ICAO (required)
...... m 0..1stringSampling method
Binding: Lab Test - Sample Origin - ICAO (required)
..... opt 0..1stringOptional data issued at the discretion of the issuing authority
..... uvci 0..1stringUnique Vaccination Certificate Identifier (Required for `icao.vacc` only, not used of `icao.test`)
..... ve 0..*BackboneElementVaccinationEvent (Required for `icao.vacc` only, not used of `icao.test`)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... des 1..1stringVaccine or Prophylaxis (ICD-11 MMS code descending from http://id.who.int/icd/entity/164949870)
Binding: WHO Vaccine List (COVID-19) (required)
...... nam 1..1stringVaccine Brand (medical product name)
...... dis 0..1stringDisease or agent targeted (ICD-11 code)
...... vd 1..*BackboneElementVaccinationDetails
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... dvc 1..1dateDate of vaccination (see element details)
....... seq 1..1positiveIntDose number (vaccine dose number, integer between 1 and 99)
....... ctr 1..1stringCountry of vaccination (ISO-3166 three letter code; see element details)
Binding: Iso3166-1-3 (required)
....... adm 1..1stringAdministering centre (The name or identifier of the vaccination facility)
....... lot 1..1stringVaccine batch number
....... dvn 0..1dateDue date of next dose (see element details)
... sig 0..1BackboneElementSignature
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... alg 1..1stringSignatureAlgo
.... cer 1..1stringCertificate (X.509 signer certificate in base64url [RFC 4648])
.... sigvl 1..1stringSignatureValue (Signature value signed over the Data in base64url [RFC 4648])

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CertICAOVDS.data.hdr.isrequiredIso3166-1-3
CertICAOVDS.data.msg.tr.tcrequiredLabTestTypeIcaoValueSet
CertICAOVDS.data.msg.tr.rrequiredLabTestResultIcaoValueSet
CertICAOVDS.data.msg.tr.mrequiredLabTestSampleOriginIcaoValueSet
CertICAOVDS.data.msg.ve.desrequiredWHO_DDCC_Vaccines_COVID_19
CertICAOVDS.data.msg.ve.vd.ctrrequiredIso3166-1-3

Constraints

IdGradePath(s)DetailsRequirements
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
.. CertICAOVDS 0..*BaseThis is an abstract type.
Certificate - ICAO Visible Digital Seal Logical Model
Instances of this logical model are not marked to be the target of a Reference
... data 1..1BackboneElementData
.... @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
.... hdr 1..1BackboneElementHeader
..... @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
..... t 1..1stringType (either `icao.test` for proof of testing, or `icao.vacc` for proof of vaccination)
..... v 1..1integerVersion
..... is 1..1stringIssuingCountry (ISO-3166 three letter code; see element details)
Binding: Iso3166-1-3 (required)
.... msg 1..1BackboneElementMessage
..... @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
..... pid 1..1BackboneElementPersonalInformation (more info in element description)
...... @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
...... n 1..1stringName (Name of the holder (as specified in Doc 9303-3) MUST be used.)
...... dob 0..1dateDate of Birth (The DOB of the test subject. The [RFC 3339] full date format YYYY-MM- DD MUST be used.)
...... dt 0..1stringID Document Type of the identity document (see element details)
...... dn 1..1stringID Document Number of the identity document
...... i 0..1stringTravel Document Number
...... ai 0..1stringOther Document Number
...... sex 0..1stringSex of the test subject (as specified in Doc 9303-4 Section 4.1.1.1 – Visual Inspection Zone)
..... utci 0..1stringUTCI (Unique Test Certificate Identifier; used for `icao.test` only, not used of `icao.vacc`)
..... sp 0..1BackboneElementServiceProvider (Required for `icao.test` only, not used of `icao.vacc`)
...... @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
...... spn 1..1stringName of testing facility or service provider
...... ctr 1..1stringCountry of test (spec does not indicate code system, but presumably this is ISO-3166 like the other country codes in the certificate)
...... cd 1..1BackboneElementContactDetails
....... @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
....... p 1..1stringPhoneNumber
....... e 1..1stringEmail
....... a 1..1stringAddress
..... dat 0..1BackboneElementDateTimeTestReport (Required for `icao.test` only, not used of `icao.vacc`)
...... @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
...... sc 1..1dateTimeSpecimenCollection (RFC3339)
...... ri 1..1dateTimeReportIssuance (RFC3339)
..... tr 0..1BackboneElementTestResult (Required for `icao.test` only, not used of `icao.vacc`)
...... @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
...... tc 1..1stringTestConducted
Binding: Lab Test - Type - ICAO (required)
...... r 1..1stringResults
Binding: Lab Test - Qualitative Result - ICAO (required)
...... m 0..1stringSampling method
Binding: Lab Test - Sample Origin - ICAO (required)
..... opt 0..1stringOptional data issued at the discretion of the issuing authority
..... uvci 0..1stringUnique Vaccination Certificate Identifier (Required for `icao.vacc` only, not used of `icao.test`)
..... ve 0..*BackboneElementVaccinationEvent (Required for `icao.vacc` only, not used of `icao.test`)
...... @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
...... des 1..1stringVaccine or Prophylaxis (ICD-11 MMS code descending from http://id.who.int/icd/entity/164949870)
Binding: WHO Vaccine List (COVID-19) (required)
...... nam 1..1stringVaccine Brand (medical product name)
...... dis 0..1stringDisease or agent targeted (ICD-11 code)
...... vd 1..*BackboneElementVaccinationDetails
....... @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
....... dvc 1..1dateDate of vaccination (see element details)
....... seq 1..1positiveIntDose number (vaccine dose number, integer between 1 and 99)
....... ctr 1..1stringCountry of vaccination (ISO-3166 three letter code; see element details)
Binding: Iso3166-1-3 (required)
....... adm 1..1stringAdministering centre (The name or identifier of the vaccination facility)
....... lot 1..1stringVaccine batch number
....... dvn 0..1dateDue date of next dose (see element details)
... sig 0..1BackboneElementSignature
.... @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
.... alg 1..1stringSignatureAlgo
.... cer 1..1stringCertificate (X.509 signer certificate in base64url [RFC 4648])
.... sigvl 1..1stringSignatureValue (Signature value signed over the Data in base64url [RFC 4648])

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CertICAOVDS.data.hdr.isrequiredIso3166-1-3
CertICAOVDS.data.msg.tr.tcrequiredLabTestTypeIcaoValueSet
CertICAOVDS.data.msg.tr.rrequiredLabTestResultIcaoValueSet
CertICAOVDS.data.msg.tr.mrequiredLabTestSampleOriginIcaoValueSet
CertICAOVDS.data.msg.ve.desrequiredWHO_DDCC_Vaccines_COVID_19
CertICAOVDS.data.msg.ve.vd.ctrrequiredIso3166-1-3

Constraints

IdGradePath(s)DetailsRequirements
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 (30 nested mandatory elements)

 

Other representations of profile: CSV, Excel