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

This page is part of the WHO Digital Documentation of COVID-19 Certificates (DDCC) (v1.0.0: releases Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: DDCCCoreDataSetTR - Detailed Descriptions

Draft as of 2024-10-15

Definitions for the DDCCCoreDataSetTR logical model.

Guidance on how to interpret the contents of this table can be found here

0. DDCCCoreDataSet
Definition

Data elements for the DDCC Core Data Set for Test Result.

ShortDDCC Core Data Set Logical Model for Test Result
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. DDCCCoreDataSet.test
Definition

A test event.

ShortTest Event
Control1..1
TypeBackboneElement
4. DDCCCoreDataSet.test.pathogen
Definition

Name of the pathogen being tested for (such as SARS-CoV-2).

ShortPathogen targeted
Control1..1
BindingThe codes SHOULD be taken from WHO Agent Targeted (COVID-19)
(preferred to http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19)
TypeCoding
6. DDCCCoreDataSet.test.type
Definition

Name of the type of test that was conducted e.g. NAAT.

ShortType of test
Control1..1
BindingThe codes SHOULD be taken from WHO Type of Covid-19 Test
(preferred to http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19)
TypeCoding
8. DDCCCoreDataSet.test.brand
Definition

The brand or trade name used to refer to the test conducted.

ShortTest brand
Control0..1
TypeCoding
10. DDCCCoreDataSet.test.manufacturer
Definition

Name of the manufacturer of the test conducted.

ShortTest manufacturer
Control0..1
TypeCoding
12. DDCCCoreDataSet.test.origin
Definition

The type of sample that was taken e.g. Nasopharyngeal swab or Saliva specimen.

ShortSpecimen Sample Origin
Control0..1
BindingThe codes SHOULD be taken from WHO Speciman Sample Origin (COVID-19)
(preferred to http://smart.who.int/ddcc/ValueSet/WHODDCCSampleOriginCOVID19)
TypeCoding
14. DDCCCoreDataSet.test.date
Definition

Date and time when sample was collected.

ShortDate and time of sample collection
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. DDCCCoreDataSet.test.result
Definition

Detected or Not detected presence of SARS-CoV-2 infection.

ShortTest result
Control0..1
BindingThe codes SHOULD be taken from WHO Test Result (COVID-19)
(preferred to http://smart.who.int/ddcc/ValueSet/who-ddcc-test-result-covid-19)
TypeCoding
18. DDCCCoreDataSet.test.centre
Definition

A codable name or identifier of the facility responsible for conducting the test.

ShortTest centre or facility name
Control0..1
TypeCoding
20. DDCCCoreDataSet.test.country
Definition

The country in which the individual has been tested.

ShortTest centre country
Control1..1
BindingThe codes SHOULD be taken from Iso3166-1-3
(preferred to http://hl7.org/fhir/ValueSet/iso3166-1-3)
TypeCoding

Guidance on how to interpret the contents of this table can be found here

0. DDCCCoreDataSet
Definition

Data elements for the DDCC Core Data Set for Test Result.

ShortDDCC Core Data Set Logical Model for Test Result
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. DDCCCoreDataSet.name
Definition

The full name of the person.

ShortName
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. DDCCCoreDataSet.test
Definition

A test event.

ShortTest Event
Control1..1
TypeBackboneElement
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. DDCCCoreDataSet.test.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. DDCCCoreDataSet.test.pathogen
Definition

Name of the pathogen being tested for (such as SARS-CoV-2).

ShortPathogen targeted
Control1..1
BindingThe codes SHOULD be taken from WHO Agent Targeted (COVID-19)
(preferred to http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19)
TypeCoding
Summarytrue
10. DDCCCoreDataSet.test.type
Definition

Name of the type of test that was conducted e.g. NAAT.

ShortType of test
Control1..1
BindingThe codes SHOULD be taken from WHO Type of Covid-19 Test
(preferred to http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19)
TypeCoding
Summarytrue
12. DDCCCoreDataSet.test.brand
Definition

The brand or trade name used to refer to the test conducted.

ShortTest brand
Control0..1
TypeCoding
Summarytrue
14. DDCCCoreDataSet.test.manufacturer
Definition

Name of the manufacturer of the test conducted.

ShortTest manufacturer
Control0..1
TypeCoding
Summarytrue
16. DDCCCoreDataSet.test.origin
Definition

The type of sample that was taken e.g. Nasopharyngeal swab or Saliva specimen.

ShortSpecimen Sample Origin
Control0..1
BindingThe codes SHOULD be taken from WHO Speciman Sample Origin (COVID-19)
(preferred to http://smart.who.int/ddcc/ValueSet/WHODDCCSampleOriginCOVID19)
TypeCoding
Summarytrue
18. DDCCCoreDataSet.test.date
Definition

Date and time when sample was collected.

ShortDate and time of sample collection
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
20. DDCCCoreDataSet.test.result
Definition

Detected or Not detected presence of SARS-CoV-2 infection.

ShortTest result
Control0..1
BindingThe codes SHOULD be taken from WHO Test Result (COVID-19)
(preferred to http://smart.who.int/ddcc/ValueSet/who-ddcc-test-result-covid-19)
TypeCoding
22. DDCCCoreDataSet.test.centre
Definition

A codable name or identifier of the facility responsible for conducting the test.

ShortTest centre or facility name
Control0..1
TypeCoding
24. DDCCCoreDataSet.test.country
Definition

The country in which the individual has been tested.

ShortTest centre country
Control1..1
BindingThe codes SHOULD be taken from Iso3166-1-3
(preferred to http://hl7.org/fhir/ValueSet/iso3166-1-3)
TypeCoding
Summarytrue

Guidance on how to interpret the contents of this table can be found here

0. DDCCCoreDataSet
Definition

Data elements for the DDCC Core Data Set for Test Result.

ShortDDCC Core Data Set Logical Model for Test Result
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. DDCCCoreDataSet.name
Definition

The full name of the person.

ShortName
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. DDCCCoreDataSet.birthDate
Definition

The person's date of birth (DOB) if known. If unknown, use given DOB for administrative purposes

ShortDate of birth
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
6. DDCCCoreDataSet.identifier
Definition

Unique identifier for the person, according to the policies applicable to each country. There can be more than one unique identifier used to link records. (e.g. national ID, health ID, immunization information system ID, medical record ID).

ShortUnique identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
8. DDCCCoreDataSet.certificate
Definition

Metadata associated with the certificate

ShortCertificate Metadata
Control0..1
TypeBackboneElement
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. DDCCCoreDataSet.certificate.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
12. DDCCCoreDataSet.certificate.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DDCCCoreDataSet.certificate.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 14. DDCCCoreDataSet.certificate.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    16. DDCCCoreDataSet.certificate.issuer
    Definition

    Certificate issuer.

    ShortCertificate issuer
    Control1..1
    TypeReference(DDCC Organization)
    Summarytrue
    18. DDCCCoreDataSet.certificate.kid
    Definition

    Key ID

    ShortKey ID used to verify the signature of the certificate
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    20. DDCCCoreDataSet.certificate.hcid
    Definition

    Health certificate identifier (HCID).

    ShortHealth certificate identifier (HCID)
    Control1..1
    TypeIdentifier
    Summarytrue
    22. DDCCCoreDataSet.certificate.ddccid
    Definition

    DDCC Identifier

    ShortDDCC Identifier
    Control0..1
    TypeIdentifier
    Summarytrue
    24. DDCCCoreDataSet.certificate.version
    Definition

    Certificate schema version

    ShortCertificate schema version
    NoteThis is a business version Id, not a resource version Id (see discussion)
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    26. DDCCCoreDataSet.certificate.period
    Definition

    Certificate validity period.

    ShortCertificate Validity Period
    Control0..1
    TypePeriod
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    per-1: If present, start SHALL have a lower value than end (start.hasValue().not() or end.hasValue().not() or (start <= end))
    28. DDCCCoreDataSet.certificate.period.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    30. DDCCCoreDataSet.certificate.period.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on DDCCCoreDataSet.certificate.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 32. DDCCCoreDataSet.certificate.period.start
      Definition

      Start date of certificate validity.

      ShortCertificate valid from
      Comments

      If the low element is missing, the meaning is that the low boundary is not known.

      Control0..1
      This element is affected by the following invariants: per-1
      TypedateTime
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      34. DDCCCoreDataSet.certificate.period.end
      Definition

      End date of certificate validity.

      ShortCertificate valid until
      Comments

      The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

      Control0..1
      This element is affected by the following invariants: per-1
      TypedateTime
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      36. DDCCCoreDataSet.test
      Definition

      A test event.

      ShortTest Event
      Control1..1
      TypeBackboneElement
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      38. DDCCCoreDataSet.test.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      40. DDCCCoreDataSet.test.extension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortAdditional content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on DDCCCoreDataSet.test.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 42. DDCCCoreDataSet.test.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        44. DDCCCoreDataSet.test.pathogen
        Definition

        Name of the pathogen being tested for (such as SARS-CoV-2).

        ShortPathogen targeted
        Control1..1
        BindingThe codes SHOULD be taken from WHO Agent Targeted (COVID-19)
        (preferred to http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19)
        TypeCoding
        Summarytrue
        46. DDCCCoreDataSet.test.type
        Definition

        Name of the type of test that was conducted e.g. NAAT.

        ShortType of test
        Control1..1
        BindingThe codes SHOULD be taken from WHO Type of Covid-19 Test
        (preferred to http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19)
        TypeCoding
        Summarytrue
        48. DDCCCoreDataSet.test.brand
        Definition

        The brand or trade name used to refer to the test conducted.

        ShortTest brand
        Control0..1
        TypeCoding
        Summarytrue
        50. DDCCCoreDataSet.test.manufacturer
        Definition

        Name of the manufacturer of the test conducted.

        ShortTest manufacturer
        Control0..1
        TypeCoding
        Summarytrue
        52. DDCCCoreDataSet.test.origin
        Definition

        The type of sample that was taken e.g. Nasopharyngeal swab or Saliva specimen.

        ShortSpecimen Sample Origin
        Control0..1
        BindingThe codes SHOULD be taken from WHO Speciman Sample Origin (COVID-19)
        (preferred to http://smart.who.int/ddcc/ValueSet/WHODDCCSampleOriginCOVID19)
        TypeCoding
        Summarytrue
        54. DDCCCoreDataSet.test.date
        Definition

        Date and time when sample was collected.

        ShortDate and time of sample collection
        Control1..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        56. DDCCCoreDataSet.test.result
        Definition

        Detected or Not detected presence of SARS-CoV-2 infection.

        ShortTest result
        Control0..1
        BindingThe codes SHOULD be taken from WHO Test Result (COVID-19)
        (preferred to http://smart.who.int/ddcc/ValueSet/who-ddcc-test-result-covid-19)
        TypeCoding
        58. DDCCCoreDataSet.test.centre
        Definition

        A codable name or identifier of the facility responsible for conducting the test.

        ShortTest centre or facility name
        Control0..1
        TypeCoding
        60. DDCCCoreDataSet.test.country
        Definition

        The country in which the individual has been tested.

        ShortTest centre country
        Control1..1
        BindingThe codes SHOULD be taken from Iso3166-1-3
        (preferred to http://hl7.org/fhir/ValueSet/iso3166-1-3)
        TypeCoding
        Summarytrue