WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.1 - release
This page is part of the WHO Digital Documentation of COVID-19 Certificates (DDCC) (v1.0.1: releases Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://smart.who.int/ddcc/StructureDefinition/DDCCCoreDataSetTR | Version: 1.0.1 | |||
Draft as of 2024-12-18 | Computable Name: DDCCCoreDataSetTR |
Data elements for the DDCC Core Data Set for Test Result.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DDCCCoreDataSet
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DDCCCoreDataSet | 0..* | DDCCCoreDataSet | This is an abstracttype. Elements defined in Ancestors:name, birthDate, identifier, certificate DDCC Core Data Set Logical Model for Test Result Instances of this logical model are not marked to be the target of a Reference | |
test | Σ | 1..1 | BackboneElement | Test Event |
pathogen | Σ | 1..1 | Coding | Pathogen targeted Binding: WHO Agent Targeted (COVID-19) (preferred) |
type | Σ | 1..1 | Coding | Type of test Binding: WHO Type of Covid-19 Test (preferred) |
brand | Σ | 0..1 | Coding | Test brand |
manufacturer | Σ | 0..1 | Coding | Test manufacturer |
origin | Σ | 0..1 | Coding | Specimen Sample Origin Binding: WHO Speciman Sample Origin (COVID-19) (preferred) |
date | Σ | 1..1 | dateTime | Date and time of sample collection |
result | 0..1 | Coding | Test result Binding: WHO Test Result (COVID-19) (preferred) | |
centre | 0..1 | Coding | Test centre or facility name | |
country | Σ | 1..1 | Coding | Test centre country Binding: Iso3166-1-3 (preferred) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DDCCCoreDataSet.test.pathogen | preferred | WHODDCCAgentTargetedCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19 from this IG | |
DDCCCoreDataSet.test.type | preferred | WHODDCCTypeofTestCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19 from this IG | |
DDCCCoreDataSet.test.origin | preferred | WHODDCCSampleOriginCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCSampleOriginCOVID19 from this IG | |
DDCCCoreDataSet.test.result | preferred | WHODDCCTestResultCOVID19http://smart.who.int/ddcc/ValueSet/who-ddcc-test-result-covid-19 from this IG | |
DDCCCoreDataSet.test.country | preferred | Iso3166-1-3http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DDCCCoreDataSet | 0..* | DDCCCoreDataSet | This is an abstracttype. Elements defined in Ancestors:name, birthDate, identifier, certificate DDCC Core Data Set Logical Model for Test Result Instances of this logical model are not marked to be the target of a Reference | |
name | Σ | 1..1 | string | Name |
birthDate | Σ | 0..1 | date | Date of birth |
identifier | Σ | 0..1 | Identifier | Unique identifier |
certificate | Σ | 0..1 | BackboneElement | Certificate Metadata ele-1: All FHIR elements must have a @value or children |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
issuer | Σ | 1..1 | Reference(DDCC Organization) | Certificate issuer |
kid | 0..1 | string | Key ID used to verify the signature of the certificate | |
hcid | Σ | 1..1 | Identifier | Health certificate identifier (HCID) |
ddccid | Σ | 0..1 | Identifier | DDCC Identifier |
version | Σ | 1..1 | string | Certificate schema version |
period | C | 0..1 | Period | Certificate Validity Period ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
start | ΣC | 0..1 | dateTime | Certificate valid from ele-1: All FHIR elements must have a @value or children |
end | ΣC | 0..1 | dateTime | Certificate valid until ele-1: All FHIR elements must have a @value or children |
test | Σ | 1..1 | BackboneElement | Test Event ele-1: All FHIR elements must have a @value or children |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pathogen | Σ | 1..1 | Coding | Pathogen targeted Binding: WHO Agent Targeted (COVID-19) (preferred) |
type | Σ | 1..1 | Coding | Type of test Binding: WHO Type of Covid-19 Test (preferred) |
brand | Σ | 0..1 | Coding | Test brand |
manufacturer | Σ | 0..1 | Coding | Test manufacturer |
origin | Σ | 0..1 | Coding | Specimen Sample Origin Binding: WHO Speciman Sample Origin (COVID-19) (preferred) |
date | Σ | 1..1 | dateTime | Date and time of sample collection |
result | 0..1 | Coding | Test result Binding: WHO Test Result (COVID-19) (preferred) | |
centre | 0..1 | Coding | Test centre or facility name | |
country | Σ | 1..1 | Coding | Test centre country Binding: Iso3166-1-3 (preferred) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DDCCCoreDataSet.test.pathogen | preferred | WHODDCCAgentTargetedCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19 from this IG | |
DDCCCoreDataSet.test.type | preferred | WHODDCCTypeofTestCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19 from this IG | |
DDCCCoreDataSet.test.origin | preferred | WHODDCCSampleOriginCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCSampleOriginCOVID19 from this IG | |
DDCCCoreDataSet.test.result | preferred | WHODDCCTestResultCOVID19http://smart.who.int/ddcc/ValueSet/who-ddcc-test-result-covid-19 from this IG | |
DDCCCoreDataSet.test.country | preferred | 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() | |
per-1 | error | DDCCCoreDataSet.certificate.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DDCCCoreDataSet | 0..* | DDCCCoreDataSet | This is an abstracttype. Elements defined in Ancestors:name, birthDate, identifier, certificate DDCC Core Data Set Logical Model for Test Result Instances of this logical model are not marked to be the target of a Reference | |
name | Σ | 1..1 | string | Name |
birthDate | Σ | 0..1 | date | Date of birth |
identifier | Σ | 0..1 | Identifier | Unique identifier |
certificate | Σ | 0..1 | BackboneElement | Certificate Metadata |
@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 |
issuer | Σ | 1..1 | Reference(DDCC Organization) | Certificate issuer |
kid | 0..1 | string | Key ID used to verify the signature of the certificate | |
hcid | Σ | 1..1 | Identifier | Health certificate identifier (HCID) |
ddccid | Σ | 0..1 | Identifier | DDCC Identifier |
version | Σ | 1..1 | string | Certificate schema version |
period | C | 0..1 | Period | Certificate Validity Period per-1: If present, start SHALL have a lower value than end |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
start | ΣC | 0..1 | dateTime | Certificate valid from |
end | ΣC | 0..1 | dateTime | Certificate valid until |
test | Σ | 1..1 | BackboneElement | Test Event |
@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 |
pathogen | Σ | 1..1 | Coding | Pathogen targeted Binding: WHO Agent Targeted (COVID-19) (preferred) |
type | Σ | 1..1 | Coding | Type of test Binding: WHO Type of Covid-19 Test (preferred) |
brand | Σ | 0..1 | Coding | Test brand |
manufacturer | Σ | 0..1 | Coding | Test manufacturer |
origin | Σ | 0..1 | Coding | Specimen Sample Origin Binding: WHO Speciman Sample Origin (COVID-19) (preferred) |
date | Σ | 1..1 | dateTime | Date and time of sample collection |
result | 0..1 | Coding | Test result Binding: WHO Test Result (COVID-19) (preferred) | |
centre | 0..1 | Coding | Test centre or facility name | |
country | Σ | 1..1 | Coding | Test centre country Binding: Iso3166-1-3 (preferred) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DDCCCoreDataSet.test.pathogen | preferred | WHODDCCAgentTargetedCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19 from this IG | |
DDCCCoreDataSet.test.type | preferred | WHODDCCTypeofTestCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19 from this IG | |
DDCCCoreDataSet.test.origin | preferred | WHODDCCSampleOriginCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCSampleOriginCOVID19 from this IG | |
DDCCCoreDataSet.test.result | preferred | WHODDCCTestResultCOVID19http://smart.who.int/ddcc/ValueSet/who-ddcc-test-result-covid-19 from this IG | |
DDCCCoreDataSet.test.country | preferred | 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() | |
per-1 | error | DDCCCoreDataSet.certificate.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) |
This structure is derived from DDCCCoreDataSet
Differential View
This structure is derived from DDCCCoreDataSet
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DDCCCoreDataSet | 0..* | DDCCCoreDataSet | This is an abstracttype. Elements defined in Ancestors:name, birthDate, identifier, certificate DDCC Core Data Set Logical Model for Test Result Instances of this logical model are not marked to be the target of a Reference | |
test | Σ | 1..1 | BackboneElement | Test Event |
pathogen | Σ | 1..1 | Coding | Pathogen targeted Binding: WHO Agent Targeted (COVID-19) (preferred) |
type | Σ | 1..1 | Coding | Type of test Binding: WHO Type of Covid-19 Test (preferred) |
brand | Σ | 0..1 | Coding | Test brand |
manufacturer | Σ | 0..1 | Coding | Test manufacturer |
origin | Σ | 0..1 | Coding | Specimen Sample Origin Binding: WHO Speciman Sample Origin (COVID-19) (preferred) |
date | Σ | 1..1 | dateTime | Date and time of sample collection |
result | 0..1 | Coding | Test result Binding: WHO Test Result (COVID-19) (preferred) | |
centre | 0..1 | Coding | Test centre or facility name | |
country | Σ | 1..1 | Coding | Test centre country Binding: Iso3166-1-3 (preferred) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DDCCCoreDataSet.test.pathogen | preferred | WHODDCCAgentTargetedCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19 from this IG | |
DDCCCoreDataSet.test.type | preferred | WHODDCCTypeofTestCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19 from this IG | |
DDCCCoreDataSet.test.origin | preferred | WHODDCCSampleOriginCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCSampleOriginCOVID19 from this IG | |
DDCCCoreDataSet.test.result | preferred | WHODDCCTestResultCOVID19http://smart.who.int/ddcc/ValueSet/who-ddcc-test-result-covid-19 from this IG | |
DDCCCoreDataSet.test.country | preferred | Iso3166-1-3http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DDCCCoreDataSet | 0..* | DDCCCoreDataSet | This is an abstracttype. Elements defined in Ancestors:name, birthDate, identifier, certificate DDCC Core Data Set Logical Model for Test Result Instances of this logical model are not marked to be the target of a Reference | |
name | Σ | 1..1 | string | Name |
birthDate | Σ | 0..1 | date | Date of birth |
identifier | Σ | 0..1 | Identifier | Unique identifier |
certificate | Σ | 0..1 | BackboneElement | Certificate Metadata ele-1: All FHIR elements must have a @value or children |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
issuer | Σ | 1..1 | Reference(DDCC Organization) | Certificate issuer |
kid | 0..1 | string | Key ID used to verify the signature of the certificate | |
hcid | Σ | 1..1 | Identifier | Health certificate identifier (HCID) |
ddccid | Σ | 0..1 | Identifier | DDCC Identifier |
version | Σ | 1..1 | string | Certificate schema version |
period | C | 0..1 | Period | Certificate Validity Period ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
start | ΣC | 0..1 | dateTime | Certificate valid from ele-1: All FHIR elements must have a @value or children |
end | ΣC | 0..1 | dateTime | Certificate valid until ele-1: All FHIR elements must have a @value or children |
test | Σ | 1..1 | BackboneElement | Test Event ele-1: All FHIR elements must have a @value or children |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pathogen | Σ | 1..1 | Coding | Pathogen targeted Binding: WHO Agent Targeted (COVID-19) (preferred) |
type | Σ | 1..1 | Coding | Type of test Binding: WHO Type of Covid-19 Test (preferred) |
brand | Σ | 0..1 | Coding | Test brand |
manufacturer | Σ | 0..1 | Coding | Test manufacturer |
origin | Σ | 0..1 | Coding | Specimen Sample Origin Binding: WHO Speciman Sample Origin (COVID-19) (preferred) |
date | Σ | 1..1 | dateTime | Date and time of sample collection |
result | 0..1 | Coding | Test result Binding: WHO Test Result (COVID-19) (preferred) | |
centre | 0..1 | Coding | Test centre or facility name | |
country | Σ | 1..1 | Coding | Test centre country Binding: Iso3166-1-3 (preferred) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DDCCCoreDataSet.test.pathogen | preferred | WHODDCCAgentTargetedCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19 from this IG | |
DDCCCoreDataSet.test.type | preferred | WHODDCCTypeofTestCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19 from this IG | |
DDCCCoreDataSet.test.origin | preferred | WHODDCCSampleOriginCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCSampleOriginCOVID19 from this IG | |
DDCCCoreDataSet.test.result | preferred | WHODDCCTestResultCOVID19http://smart.who.int/ddcc/ValueSet/who-ddcc-test-result-covid-19 from this IG | |
DDCCCoreDataSet.test.country | preferred | 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() | |
per-1 | error | DDCCCoreDataSet.certificate.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DDCCCoreDataSet | 0..* | DDCCCoreDataSet | This is an abstracttype. Elements defined in Ancestors:name, birthDate, identifier, certificate DDCC Core Data Set Logical Model for Test Result Instances of this logical model are not marked to be the target of a Reference | |
name | Σ | 1..1 | string | Name |
birthDate | Σ | 0..1 | date | Date of birth |
identifier | Σ | 0..1 | Identifier | Unique identifier |
certificate | Σ | 0..1 | BackboneElement | Certificate Metadata |
@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 |
issuer | Σ | 1..1 | Reference(DDCC Organization) | Certificate issuer |
kid | 0..1 | string | Key ID used to verify the signature of the certificate | |
hcid | Σ | 1..1 | Identifier | Health certificate identifier (HCID) |
ddccid | Σ | 0..1 | Identifier | DDCC Identifier |
version | Σ | 1..1 | string | Certificate schema version |
period | C | 0..1 | Period | Certificate Validity Period per-1: If present, start SHALL have a lower value than end |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
start | ΣC | 0..1 | dateTime | Certificate valid from |
end | ΣC | 0..1 | dateTime | Certificate valid until |
test | Σ | 1..1 | BackboneElement | Test Event |
@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 |
pathogen | Σ | 1..1 | Coding | Pathogen targeted Binding: WHO Agent Targeted (COVID-19) (preferred) |
type | Σ | 1..1 | Coding | Type of test Binding: WHO Type of Covid-19 Test (preferred) |
brand | Σ | 0..1 | Coding | Test brand |
manufacturer | Σ | 0..1 | Coding | Test manufacturer |
origin | Σ | 0..1 | Coding | Specimen Sample Origin Binding: WHO Speciman Sample Origin (COVID-19) (preferred) |
date | Σ | 1..1 | dateTime | Date and time of sample collection |
result | 0..1 | Coding | Test result Binding: WHO Test Result (COVID-19) (preferred) | |
centre | 0..1 | Coding | Test centre or facility name | |
country | Σ | 1..1 | Coding | Test centre country Binding: Iso3166-1-3 (preferred) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DDCCCoreDataSet.test.pathogen | preferred | WHODDCCAgentTargetedCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19 from this IG | |
DDCCCoreDataSet.test.type | preferred | WHODDCCTypeofTestCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19 from this IG | |
DDCCCoreDataSet.test.origin | preferred | WHODDCCSampleOriginCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCSampleOriginCOVID19 from this IG | |
DDCCCoreDataSet.test.result | preferred | WHODDCCTestResultCOVID19http://smart.who.int/ddcc/ValueSet/who-ddcc-test-result-covid-19 from this IG | |
DDCCCoreDataSet.test.country | preferred | 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() | |
per-1 | error | DDCCCoreDataSet.certificate.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) |
This structure is derived from DDCCCoreDataSet