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/ and changes regularly. See the Directory of published versions
Official URL: http://smart.who.int/ddcc/StructureDefinition/CertICAO | Version: 1.0.0 | |||
Draft as of 2024-10-17 | 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CertICAO | 0..* | Base | This is an abstracttype. Certificate - ICAO Visible Digital Seal Logical Model Instances of this logical model are not marked to be the target of a Reference | |
data | 1..1 | BackboneElement | Data | |
hdr | 1..1 | BackboneElement | Header | |
t | 1..1 | string | Type (either `icao.test` for proof of testing, or `icao.vacc` for proof of vaccination) | |
v | 1..1 | integer | Version | |
is | 1..1 | string | IssuingCountry (ISO-3166 three letter code; see element details) Binding: Iso3166-1-3 (required) | |
msg | 1..1 | BackboneElement | Message | |
pid | 1..1 | BackboneElement | PersonalInformation (more info in element description) | |
n | 1..1 | string | Name (Name of the holder (as specified in Doc 9303-3) MUST be used.) | |
dob | 0..1 | date | Date of Birth (The DOB of the test subject. The [RFC 3339] full date format YYYY-MM- DD MUST be used.) | |
dt | 0..1 | string | ID Document Type of the identity document (see element details) | |
dn | 1..1 | string | ID Document Number of the identity document | |
i | 0..1 | string | Travel Document Number | |
ai | 0..1 | string | Other Document Number | |
sex | 0..1 | string | Sex of the test subject (as specified in Doc 9303-4 Section 4.1.1.1 – Visual Inspection Zone) | |
utci | 0..1 | string | UTCI (Unique Test Certificate Identifier; used for `icao.test` only, not used of `icao.vacc`) | |
sp | 0..1 | BackboneElement | ServiceProvider (Required for `icao.test` only, not used of `icao.vacc`) | |
spn | 1..1 | string | Name of testing facility or service provider | |
ctr | 1..1 | string | Country of test (spec does not indicate code system, but presumably this is ISO-3166 like the other country codes in the certificate) | |
cd | 1..1 | BackboneElement | ContactDetails | |
p | 1..1 | string | PhoneNumber | |
e | 1..1 | string | ||
a | 1..1 | string | Address | |
dat | 0..1 | BackboneElement | DateTimeTestReport (Required for `icao.test` only, not used of `icao.vacc`) | |
sc | 1..1 | dateTime | SpecimenCollection (RFC3339) | |
ri | 1..1 | dateTime | ReportIssuance (RFC3339) | |
tr | 0..1 | BackboneElement | TestResult (Required for `icao.test` only, not used of `icao.vacc`) | |
tc | 1..1 | string | TestConducted Binding: Lab Test - Type - ICAO (required) | |
r | 1..1 | string | Results Binding: Lab Test - Qualitative Result - ICAO (required) | |
m | 0..1 | string | Sampling method Binding: Lab Test - Sample Origin - ICAO (required) | |
opt | 0..1 | string | Optional data issued at the discretion of the issuing authority | |
uvci | 0..1 | string | Unique Vaccination Certificate Identifier (Required for `icao.vacc` only, not used of `icao.test`) | |
ve | 0..* | BackboneElement | VaccinationEvent (Required for `icao.vacc` only, not used of `icao.test`) | |
des | 1..1 | string | Vaccine or Prophylaxis (ICD-11 MMS code descending from http://id.who.int/icd/entity/164949870) Binding: WHO Vaccine List (COVID-19) (required) | |
nam | 1..1 | string | Vaccine Brand (medical product name) | |
dis | 0..1 | string | Disease or agent targeted (ICD-11 code) | |
vd | 1..* | BackboneElement | VaccinationDetails | |
dvc | 1..1 | date | Date of vaccination (see element details) | |
seq | 1..1 | positiveInt | Dose number (vaccine dose number, integer between 1 and 99) | |
ctr | 1..1 | string | Country of vaccination (ISO-3166 three letter code; see element details) Binding: Iso3166-1-3 (required) | |
adm | 1..1 | string | Administering centre (The name or identifier of the vaccination facility) | |
lot | 1..1 | string | Vaccine batch number | |
dvn | 0..1 | date | Due date of next dose (see element details) | |
sig | 0..1 | BackboneElement | Signature | |
alg | 1..1 | string | SignatureAlgo | |
cer | 1..1 | string | Certificate (X.509 signer certificate in base64url [RFC 4648]) | |
sigvl | 1..1 | string | SignatureValue (Signature value signed over the Data in base64url [RFC 4648]) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
CertICAO.data.hdr.is | required | Iso3166-1-3http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard | |
CertICAO.data.msg.tr.tc | required | LabTestTypeIcaoValueSethttp://smart.who.int/ddcc/ValueSet/LabTestTypeIcaoValueSet from this IG | |
CertICAO.data.msg.tr.r | required | LabTestResultIcaoValueSethttp://smart.who.int/ddcc/ValueSet/LabTestResultIcaoValueSet from this IG | |
CertICAO.data.msg.tr.m | required | LabTestSampleOriginIcaoValueSethttp://smart.who.int/ddcc/ValueSet/lab-test-sample-origin-icao from this IG | |
CertICAO.data.msg.ve.des | required | WHODDCCVaccinesCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19 from this IG | |
CertICAO.data.msg.ve.vd.ctr | required | Iso3166-1-3http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CertICAO | 0..* | Base | This is an abstracttype. Certificate - ICAO Visible Digital Seal Logical Model Instances of this logical model are not marked to be the target of a Reference | |
data | 1..1 | BackboneElement | Data | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
hdr | 1..1 | BackboneElement | Header | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
t | 1..1 | string | Type (either `icao.test` for proof of testing, or `icao.vacc` for proof of vaccination) | |
v | 1..1 | integer | Version | |
is | 1..1 | string | IssuingCountry (ISO-3166 three letter code; see element details) Binding: Iso3166-1-3 (required) | |
msg | 1..1 | BackboneElement | Message | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
pid | 1..1 | BackboneElement | PersonalInformation (more info in element description) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
n | 1..1 | string | Name (Name of the holder (as specified in Doc 9303-3) MUST be used.) | |
dob | 0..1 | date | Date of Birth (The DOB of the test subject. The [RFC 3339] full date format YYYY-MM- DD MUST be used.) | |
dt | 0..1 | string | ID Document Type of the identity document (see element details) | |
dn | 1..1 | string | ID Document Number of the identity document | |
i | 0..1 | string | Travel Document Number | |
ai | 0..1 | string | Other Document Number | |
sex | 0..1 | string | Sex of the test subject (as specified in Doc 9303-4 Section 4.1.1.1 – Visual Inspection Zone) | |
utci | 0..1 | string | UTCI (Unique Test Certificate Identifier; used for `icao.test` only, not used of `icao.vacc`) | |
sp | 0..1 | BackboneElement | ServiceProvider (Required for `icao.test` only, not used of `icao.vacc`) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
spn | 1..1 | string | Name of testing facility or service provider | |
ctr | 1..1 | string | Country of test (spec does not indicate code system, but presumably this is ISO-3166 like the other country codes in the certificate) | |
cd | 1..1 | BackboneElement | ContactDetails | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
p | 1..1 | string | PhoneNumber | |
e | 1..1 | string | ||
a | 1..1 | string | Address | |
dat | 0..1 | BackboneElement | DateTimeTestReport (Required for `icao.test` only, not used of `icao.vacc`) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
sc | 1..1 | dateTime | SpecimenCollection (RFC3339) | |
ri | 1..1 | dateTime | ReportIssuance (RFC3339) | |
tr | 0..1 | BackboneElement | TestResult (Required for `icao.test` only, not used of `icao.vacc`) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
tc | 1..1 | string | TestConducted Binding: Lab Test - Type - ICAO (required) | |
r | 1..1 | string | Results Binding: Lab Test - Qualitative Result - ICAO (required) | |
m | 0..1 | string | Sampling method Binding: Lab Test - Sample Origin - ICAO (required) | |
opt | 0..1 | string | Optional data issued at the discretion of the issuing authority | |
uvci | 0..1 | string | Unique Vaccination Certificate Identifier (Required for `icao.vacc` only, not used of `icao.test`) | |
ve | 0..* | BackboneElement | VaccinationEvent (Required for `icao.vacc` only, not used of `icao.test`) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
des | 1..1 | string | Vaccine or Prophylaxis (ICD-11 MMS code descending from http://id.who.int/icd/entity/164949870) Binding: WHO Vaccine List (COVID-19) (required) | |
nam | 1..1 | string | Vaccine Brand (medical product name) | |
dis | 0..1 | string | Disease or agent targeted (ICD-11 code) | |
vd | 1..* | BackboneElement | VaccinationDetails | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
dvc | 1..1 | date | Date of vaccination (see element details) | |
seq | 1..1 | positiveInt | Dose number (vaccine dose number, integer between 1 and 99) | |
ctr | 1..1 | string | Country of vaccination (ISO-3166 three letter code; see element details) Binding: Iso3166-1-3 (required) | |
adm | 1..1 | string | Administering centre (The name or identifier of the vaccination facility) | |
lot | 1..1 | string | Vaccine batch number | |
dvn | 0..1 | date | Due date of next dose (see element details) | |
sig | 0..1 | BackboneElement | Signature | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
alg | 1..1 | string | SignatureAlgo | |
cer | 1..1 | string | Certificate (X.509 signer certificate in base64url [RFC 4648]) | |
sigvl | 1..1 | string | SignatureValue (Signature value signed over the Data in base64url [RFC 4648]) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
CertICAO.data.hdr.is | required | Iso3166-1-3http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard | |
CertICAO.data.msg.tr.tc | required | LabTestTypeIcaoValueSethttp://smart.who.int/ddcc/ValueSet/LabTestTypeIcaoValueSet from this IG | |
CertICAO.data.msg.tr.r | required | LabTestResultIcaoValueSethttp://smart.who.int/ddcc/ValueSet/LabTestResultIcaoValueSet from this IG | |
CertICAO.data.msg.tr.m | required | LabTestSampleOriginIcaoValueSethttp://smart.who.int/ddcc/ValueSet/lab-test-sample-origin-icao from this IG | |
CertICAO.data.msg.ve.des | required | WHODDCCVaccinesCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19 from this IG | |
CertICAO.data.msg.ve.vd.ctr | required | Iso3166-1-3http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CertICAO | 0..* | Base | This is an abstracttype. Certificate - ICAO Visible Digital Seal Logical Model Instances of this logical model are not marked to be the target of a Reference | |
data | 1..1 | BackboneElement | Data | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
hdr | 1..1 | BackboneElement | Header | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
t | 1..1 | string | Type (either `icao.test` for proof of testing, or `icao.vacc` for proof of vaccination) | |
v | 1..1 | integer | Version | |
is | 1..1 | string | IssuingCountry (ISO-3166 three letter code; see element details) Binding: Iso3166-1-3 (required) | |
msg | 1..1 | BackboneElement | Message | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
pid | 1..1 | BackboneElement | PersonalInformation (more info in element description) | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
n | 1..1 | string | Name (Name of the holder (as specified in Doc 9303-3) MUST be used.) | |
dob | 0..1 | date | Date of Birth (The DOB of the test subject. The [RFC 3339] full date format YYYY-MM- DD MUST be used.) | |
dt | 0..1 | string | ID Document Type of the identity document (see element details) | |
dn | 1..1 | string | ID Document Number of the identity document | |
i | 0..1 | string | Travel Document Number | |
ai | 0..1 | string | Other Document Number | |
sex | 0..1 | string | Sex of the test subject (as specified in Doc 9303-4 Section 4.1.1.1 – Visual Inspection Zone) | |
utci | 0..1 | string | UTCI (Unique Test Certificate Identifier; used for `icao.test` only, not used of `icao.vacc`) | |
sp | 0..1 | BackboneElement | ServiceProvider (Required for `icao.test` only, not used of `icao.vacc`) | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
spn | 1..1 | string | Name of testing facility or service provider | |
ctr | 1..1 | string | Country of test (spec does not indicate code system, but presumably this is ISO-3166 like the other country codes in the certificate) | |
cd | 1..1 | BackboneElement | ContactDetails | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
p | 1..1 | string | PhoneNumber | |
e | 1..1 | string | ||
a | 1..1 | string | Address | |
dat | 0..1 | BackboneElement | DateTimeTestReport (Required for `icao.test` only, not used of `icao.vacc`) | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
sc | 1..1 | dateTime | SpecimenCollection (RFC3339) | |
ri | 1..1 | dateTime | ReportIssuance (RFC3339) | |
tr | 0..1 | BackboneElement | TestResult (Required for `icao.test` only, not used of `icao.vacc`) | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
tc | 1..1 | string | TestConducted Binding: Lab Test - Type - ICAO (required) | |
r | 1..1 | string | Results Binding: Lab Test - Qualitative Result - ICAO (required) | |
m | 0..1 | string | Sampling method Binding: Lab Test - Sample Origin - ICAO (required) | |
opt | 0..1 | string | Optional data issued at the discretion of the issuing authority | |
uvci | 0..1 | string | Unique Vaccination Certificate Identifier (Required for `icao.vacc` only, not used of `icao.test`) | |
ve | 0..* | BackboneElement | VaccinationEvent (Required for `icao.vacc` only, not used of `icao.test`) | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
des | 1..1 | string | Vaccine or Prophylaxis (ICD-11 MMS code descending from http://id.who.int/icd/entity/164949870) Binding: WHO Vaccine List (COVID-19) (required) | |
nam | 1..1 | string | Vaccine Brand (medical product name) | |
dis | 0..1 | string | Disease or agent targeted (ICD-11 code) | |
vd | 1..* | BackboneElement | VaccinationDetails | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
dvc | 1..1 | date | Date of vaccination (see element details) | |
seq | 1..1 | positiveInt | Dose number (vaccine dose number, integer between 1 and 99) | |
ctr | 1..1 | string | Country of vaccination (ISO-3166 three letter code; see element details) Binding: Iso3166-1-3 (required) | |
adm | 1..1 | string | Administering centre (The name or identifier of the vaccination facility) | |
lot | 1..1 | string | Vaccine batch number | |
dvn | 0..1 | date | Due date of next dose (see element details) | |
sig | 0..1 | BackboneElement | Signature | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
alg | 1..1 | string | SignatureAlgo | |
cer | 1..1 | string | Certificate (X.509 signer certificate in base64url [RFC 4648]) | |
sigvl | 1..1 | string | SignatureValue (Signature value signed over the Data in base64url [RFC 4648]) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
CertICAO.data.hdr.is | required | Iso3166-1-3http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard | |
CertICAO.data.msg.tr.tc | required | LabTestTypeIcaoValueSethttp://smart.who.int/ddcc/ValueSet/LabTestTypeIcaoValueSet from this IG | |
CertICAO.data.msg.tr.r | required | LabTestResultIcaoValueSethttp://smart.who.int/ddcc/ValueSet/LabTestResultIcaoValueSet from this IG | |
CertICAO.data.msg.tr.m | required | LabTestSampleOriginIcaoValueSethttp://smart.who.int/ddcc/ValueSet/lab-test-sample-origin-icao from this IG | |
CertICAO.data.msg.ve.des | required | WHODDCCVaccinesCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19 from this IG | |
CertICAO.data.msg.ve.vd.ctr | required | Iso3166-1-3http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Base
Differential View
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CertICAO | 0..* | Base | This is an abstracttype. Certificate - ICAO Visible Digital Seal Logical Model Instances of this logical model are not marked to be the target of a Reference | |
data | 1..1 | BackboneElement | Data | |
hdr | 1..1 | BackboneElement | Header | |
t | 1..1 | string | Type (either `icao.test` for proof of testing, or `icao.vacc` for proof of vaccination) | |
v | 1..1 | integer | Version | |
is | 1..1 | string | IssuingCountry (ISO-3166 three letter code; see element details) Binding: Iso3166-1-3 (required) | |
msg | 1..1 | BackboneElement | Message | |
pid | 1..1 | BackboneElement | PersonalInformation (more info in element description) | |
n | 1..1 | string | Name (Name of the holder (as specified in Doc 9303-3) MUST be used.) | |
dob | 0..1 | date | Date of Birth (The DOB of the test subject. The [RFC 3339] full date format YYYY-MM- DD MUST be used.) | |
dt | 0..1 | string | ID Document Type of the identity document (see element details) | |
dn | 1..1 | string | ID Document Number of the identity document | |
i | 0..1 | string | Travel Document Number | |
ai | 0..1 | string | Other Document Number | |
sex | 0..1 | string | Sex of the test subject (as specified in Doc 9303-4 Section 4.1.1.1 – Visual Inspection Zone) | |
utci | 0..1 | string | UTCI (Unique Test Certificate Identifier; used for `icao.test` only, not used of `icao.vacc`) | |
sp | 0..1 | BackboneElement | ServiceProvider (Required for `icao.test` only, not used of `icao.vacc`) | |
spn | 1..1 | string | Name of testing facility or service provider | |
ctr | 1..1 | string | Country of test (spec does not indicate code system, but presumably this is ISO-3166 like the other country codes in the certificate) | |
cd | 1..1 | BackboneElement | ContactDetails | |
p | 1..1 | string | PhoneNumber | |
e | 1..1 | string | ||
a | 1..1 | string | Address | |
dat | 0..1 | BackboneElement | DateTimeTestReport (Required for `icao.test` only, not used of `icao.vacc`) | |
sc | 1..1 | dateTime | SpecimenCollection (RFC3339) | |
ri | 1..1 | dateTime | ReportIssuance (RFC3339) | |
tr | 0..1 | BackboneElement | TestResult (Required for `icao.test` only, not used of `icao.vacc`) | |
tc | 1..1 | string | TestConducted Binding: Lab Test - Type - ICAO (required) | |
r | 1..1 | string | Results Binding: Lab Test - Qualitative Result - ICAO (required) | |
m | 0..1 | string | Sampling method Binding: Lab Test - Sample Origin - ICAO (required) | |
opt | 0..1 | string | Optional data issued at the discretion of the issuing authority | |
uvci | 0..1 | string | Unique Vaccination Certificate Identifier (Required for `icao.vacc` only, not used of `icao.test`) | |
ve | 0..* | BackboneElement | VaccinationEvent (Required for `icao.vacc` only, not used of `icao.test`) | |
des | 1..1 | string | Vaccine or Prophylaxis (ICD-11 MMS code descending from http://id.who.int/icd/entity/164949870) Binding: WHO Vaccine List (COVID-19) (required) | |
nam | 1..1 | string | Vaccine Brand (medical product name) | |
dis | 0..1 | string | Disease or agent targeted (ICD-11 code) | |
vd | 1..* | BackboneElement | VaccinationDetails | |
dvc | 1..1 | date | Date of vaccination (see element details) | |
seq | 1..1 | positiveInt | Dose number (vaccine dose number, integer between 1 and 99) | |
ctr | 1..1 | string | Country of vaccination (ISO-3166 three letter code; see element details) Binding: Iso3166-1-3 (required) | |
adm | 1..1 | string | Administering centre (The name or identifier of the vaccination facility) | |
lot | 1..1 | string | Vaccine batch number | |
dvn | 0..1 | date | Due date of next dose (see element details) | |
sig | 0..1 | BackboneElement | Signature | |
alg | 1..1 | string | SignatureAlgo | |
cer | 1..1 | string | Certificate (X.509 signer certificate in base64url [RFC 4648]) | |
sigvl | 1..1 | string | SignatureValue (Signature value signed over the Data in base64url [RFC 4648]) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
CertICAO.data.hdr.is | required | Iso3166-1-3http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard | |
CertICAO.data.msg.tr.tc | required | LabTestTypeIcaoValueSethttp://smart.who.int/ddcc/ValueSet/LabTestTypeIcaoValueSet from this IG | |
CertICAO.data.msg.tr.r | required | LabTestResultIcaoValueSethttp://smart.who.int/ddcc/ValueSet/LabTestResultIcaoValueSet from this IG | |
CertICAO.data.msg.tr.m | required | LabTestSampleOriginIcaoValueSethttp://smart.who.int/ddcc/ValueSet/lab-test-sample-origin-icao from this IG | |
CertICAO.data.msg.ve.des | required | WHODDCCVaccinesCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19 from this IG | |
CertICAO.data.msg.ve.vd.ctr | required | Iso3166-1-3http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CertICAO | 0..* | Base | This is an abstracttype. Certificate - ICAO Visible Digital Seal Logical Model Instances of this logical model are not marked to be the target of a Reference | |
data | 1..1 | BackboneElement | Data | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
hdr | 1..1 | BackboneElement | Header | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
t | 1..1 | string | Type (either `icao.test` for proof of testing, or `icao.vacc` for proof of vaccination) | |
v | 1..1 | integer | Version | |
is | 1..1 | string | IssuingCountry (ISO-3166 three letter code; see element details) Binding: Iso3166-1-3 (required) | |
msg | 1..1 | BackboneElement | Message | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
pid | 1..1 | BackboneElement | PersonalInformation (more info in element description) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
n | 1..1 | string | Name (Name of the holder (as specified in Doc 9303-3) MUST be used.) | |
dob | 0..1 | date | Date of Birth (The DOB of the test subject. The [RFC 3339] full date format YYYY-MM- DD MUST be used.) | |
dt | 0..1 | string | ID Document Type of the identity document (see element details) | |
dn | 1..1 | string | ID Document Number of the identity document | |
i | 0..1 | string | Travel Document Number | |
ai | 0..1 | string | Other Document Number | |
sex | 0..1 | string | Sex of the test subject (as specified in Doc 9303-4 Section 4.1.1.1 – Visual Inspection Zone) | |
utci | 0..1 | string | UTCI (Unique Test Certificate Identifier; used for `icao.test` only, not used of `icao.vacc`) | |
sp | 0..1 | BackboneElement | ServiceProvider (Required for `icao.test` only, not used of `icao.vacc`) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
spn | 1..1 | string | Name of testing facility or service provider | |
ctr | 1..1 | string | Country of test (spec does not indicate code system, but presumably this is ISO-3166 like the other country codes in the certificate) | |
cd | 1..1 | BackboneElement | ContactDetails | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
p | 1..1 | string | PhoneNumber | |
e | 1..1 | string | ||
a | 1..1 | string | Address | |
dat | 0..1 | BackboneElement | DateTimeTestReport (Required for `icao.test` only, not used of `icao.vacc`) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
sc | 1..1 | dateTime | SpecimenCollection (RFC3339) | |
ri | 1..1 | dateTime | ReportIssuance (RFC3339) | |
tr | 0..1 | BackboneElement | TestResult (Required for `icao.test` only, not used of `icao.vacc`) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
tc | 1..1 | string | TestConducted Binding: Lab Test - Type - ICAO (required) | |
r | 1..1 | string | Results Binding: Lab Test - Qualitative Result - ICAO (required) | |
m | 0..1 | string | Sampling method Binding: Lab Test - Sample Origin - ICAO (required) | |
opt | 0..1 | string | Optional data issued at the discretion of the issuing authority | |
uvci | 0..1 | string | Unique Vaccination Certificate Identifier (Required for `icao.vacc` only, not used of `icao.test`) | |
ve | 0..* | BackboneElement | VaccinationEvent (Required for `icao.vacc` only, not used of `icao.test`) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
des | 1..1 | string | Vaccine or Prophylaxis (ICD-11 MMS code descending from http://id.who.int/icd/entity/164949870) Binding: WHO Vaccine List (COVID-19) (required) | |
nam | 1..1 | string | Vaccine Brand (medical product name) | |
dis | 0..1 | string | Disease or agent targeted (ICD-11 code) | |
vd | 1..* | BackboneElement | VaccinationDetails | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
dvc | 1..1 | date | Date of vaccination (see element details) | |
seq | 1..1 | positiveInt | Dose number (vaccine dose number, integer between 1 and 99) | |
ctr | 1..1 | string | Country of vaccination (ISO-3166 three letter code; see element details) Binding: Iso3166-1-3 (required) | |
adm | 1..1 | string | Administering centre (The name or identifier of the vaccination facility) | |
lot | 1..1 | string | Vaccine batch number | |
dvn | 0..1 | date | Due date of next dose (see element details) | |
sig | 0..1 | BackboneElement | Signature | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
alg | 1..1 | string | SignatureAlgo | |
cer | 1..1 | string | Certificate (X.509 signer certificate in base64url [RFC 4648]) | |
sigvl | 1..1 | string | SignatureValue (Signature value signed over the Data in base64url [RFC 4648]) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
CertICAO.data.hdr.is | required | Iso3166-1-3http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard | |
CertICAO.data.msg.tr.tc | required | LabTestTypeIcaoValueSethttp://smart.who.int/ddcc/ValueSet/LabTestTypeIcaoValueSet from this IG | |
CertICAO.data.msg.tr.r | required | LabTestResultIcaoValueSethttp://smart.who.int/ddcc/ValueSet/LabTestResultIcaoValueSet from this IG | |
CertICAO.data.msg.tr.m | required | LabTestSampleOriginIcaoValueSethttp://smart.who.int/ddcc/ValueSet/lab-test-sample-origin-icao from this IG | |
CertICAO.data.msg.ve.des | required | WHODDCCVaccinesCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19 from this IG | |
CertICAO.data.msg.ve.vd.ctr | required | Iso3166-1-3http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CertICAO | 0..* | Base | This is an abstracttype. Certificate - ICAO Visible Digital Seal Logical Model Instances of this logical model are not marked to be the target of a Reference | |
data | 1..1 | BackboneElement | Data | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
hdr | 1..1 | BackboneElement | Header | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
t | 1..1 | string | Type (either `icao.test` for proof of testing, or `icao.vacc` for proof of vaccination) | |
v | 1..1 | integer | Version | |
is | 1..1 | string | IssuingCountry (ISO-3166 three letter code; see element details) Binding: Iso3166-1-3 (required) | |
msg | 1..1 | BackboneElement | Message | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
pid | 1..1 | BackboneElement | PersonalInformation (more info in element description) | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
n | 1..1 | string | Name (Name of the holder (as specified in Doc 9303-3) MUST be used.) | |
dob | 0..1 | date | Date of Birth (The DOB of the test subject. The [RFC 3339] full date format YYYY-MM- DD MUST be used.) | |
dt | 0..1 | string | ID Document Type of the identity document (see element details) | |
dn | 1..1 | string | ID Document Number of the identity document | |
i | 0..1 | string | Travel Document Number | |
ai | 0..1 | string | Other Document Number | |
sex | 0..1 | string | Sex of the test subject (as specified in Doc 9303-4 Section 4.1.1.1 – Visual Inspection Zone) | |
utci | 0..1 | string | UTCI (Unique Test Certificate Identifier; used for `icao.test` only, not used of `icao.vacc`) | |
sp | 0..1 | BackboneElement | ServiceProvider (Required for `icao.test` only, not used of `icao.vacc`) | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
spn | 1..1 | string | Name of testing facility or service provider | |
ctr | 1..1 | string | Country of test (spec does not indicate code system, but presumably this is ISO-3166 like the other country codes in the certificate) | |
cd | 1..1 | BackboneElement | ContactDetails | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
p | 1..1 | string | PhoneNumber | |
e | 1..1 | string | ||
a | 1..1 | string | Address | |
dat | 0..1 | BackboneElement | DateTimeTestReport (Required for `icao.test` only, not used of `icao.vacc`) | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
sc | 1..1 | dateTime | SpecimenCollection (RFC3339) | |
ri | 1..1 | dateTime | ReportIssuance (RFC3339) | |
tr | 0..1 | BackboneElement | TestResult (Required for `icao.test` only, not used of `icao.vacc`) | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
tc | 1..1 | string | TestConducted Binding: Lab Test - Type - ICAO (required) | |
r | 1..1 | string | Results Binding: Lab Test - Qualitative Result - ICAO (required) | |
m | 0..1 | string | Sampling method Binding: Lab Test - Sample Origin - ICAO (required) | |
opt | 0..1 | string | Optional data issued at the discretion of the issuing authority | |
uvci | 0..1 | string | Unique Vaccination Certificate Identifier (Required for `icao.vacc` only, not used of `icao.test`) | |
ve | 0..* | BackboneElement | VaccinationEvent (Required for `icao.vacc` only, not used of `icao.test`) | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
des | 1..1 | string | Vaccine or Prophylaxis (ICD-11 MMS code descending from http://id.who.int/icd/entity/164949870) Binding: WHO Vaccine List (COVID-19) (required) | |
nam | 1..1 | string | Vaccine Brand (medical product name) | |
dis | 0..1 | string | Disease or agent targeted (ICD-11 code) | |
vd | 1..* | BackboneElement | VaccinationDetails | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
dvc | 1..1 | date | Date of vaccination (see element details) | |
seq | 1..1 | positiveInt | Dose number (vaccine dose number, integer between 1 and 99) | |
ctr | 1..1 | string | Country of vaccination (ISO-3166 three letter code; see element details) Binding: Iso3166-1-3 (required) | |
adm | 1..1 | string | Administering centre (The name or identifier of the vaccination facility) | |
lot | 1..1 | string | Vaccine batch number | |
dvn | 0..1 | date | Due date of next dose (see element details) | |
sig | 0..1 | BackboneElement | Signature | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
alg | 1..1 | string | SignatureAlgo | |
cer | 1..1 | string | Certificate (X.509 signer certificate in base64url [RFC 4648]) | |
sigvl | 1..1 | string | SignatureValue (Signature value signed over the Data in base64url [RFC 4648]) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
CertICAO.data.hdr.is | required | Iso3166-1-3http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard | |
CertICAO.data.msg.tr.tc | required | LabTestTypeIcaoValueSethttp://smart.who.int/ddcc/ValueSet/LabTestTypeIcaoValueSet from this IG | |
CertICAO.data.msg.tr.r | required | LabTestResultIcaoValueSethttp://smart.who.int/ddcc/ValueSet/LabTestResultIcaoValueSet from this IG | |
CertICAO.data.msg.tr.m | required | LabTestSampleOriginIcaoValueSethttp://smart.who.int/ddcc/ValueSet/lab-test-sample-origin-icao from this IG | |
CertICAO.data.msg.ve.des | required | WHODDCCVaccinesCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19 from this IG | |
CertICAO.data.msg.ve.vd.ctr | required | Iso3166-1-3http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Base