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

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/tree/main and changes regularly. See the Directory of published versions

Logical Model: DDCCCoreDataSetVSPoV - Detailed Descriptions

Draft as of 2024-10-17

Definitions for the DDCCCoreDataSetVSPoV 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 - Vaccination Status - Proof of Vaccination.

ShortDDCC Core Data Set Logical Model - Vaccination Status - Proof of Vaccination
Logical ModelInstances of this logical model are not marked to be the target of a Reference

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 - Vaccination Status - Proof of Vaccination.

ShortDDCC Core Data Set Logical Model - Vaccination Status - Proof of Vaccination
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.vaccination
Definition

A vaccination event.

ShortVaccination Event
Control1..1
TypeBackboneElement
Summarytrue
Invariantswho-ddcc-data-1: Manufacturer or Market Authorization Holder SHALL be present (manufacturer.exists() or maholder.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. DDCCCoreDataSet.vaccination.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.vaccination.vaccine
Definition

Generic description of the vaccine or vaccine sub-type. e.g. COVID-19 mRNA vaccine, HPV vaccine.

ShortVaccine or prophylaxis
Control1..1
BindingThe codes SHOULD be taken from WHO Vaccine List (COVID-19)
(preferred to http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19)
TypeCoding
Summarytrue
10. DDCCCoreDataSet.vaccination.brand
Definition

The brand or trade name used to refer to the vaccine received.

ShortVaccine brand
Control1..1
TypeCoding
Summarytrue
12. DDCCCoreDataSet.vaccination.lot
Definition

Lot number or batch number of vaccination.

ShortVaccine lot number
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
14. DDCCCoreDataSet.vaccination.date
Definition

Date in which the vaccine was provided.

ShortDate of vaccination
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
16. DDCCCoreDataSet.vaccination.dose
Definition

Vaccine dose number.

ShortDose number
Control1..1
TypepositiveInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
18. DDCCCoreDataSet.vaccination.country
Definition

The country in which the individual has been vaccinated.

ShortCountry of vaccination
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 - Vaccination Status - Proof of Vaccination.

ShortDDCC Core Data Set Logical Model - Vaccination Status - Proof of Vaccination
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.vaccination
      Definition

      A vaccination event.

      ShortVaccination Event
      Control1..1
      TypeBackboneElement
      Summarytrue
      Invariantswho-ddcc-data-1: Manufacturer or Market Authorization Holder SHALL be present (manufacturer.exists() or maholder.exists())
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      38. DDCCCoreDataSet.vaccination.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.vaccination.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.vaccination.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 42. DDCCCoreDataSet.vaccination.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.vaccination.vaccine
        Definition

        Generic description of the vaccine or vaccine sub-type. e.g. COVID-19 mRNA vaccine, HPV vaccine.

        ShortVaccine or prophylaxis
        Control1..1
        BindingThe codes SHOULD be taken from WHO Vaccine List (COVID-19)
        (preferred to http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19)
        TypeCoding
        Summarytrue
        46. DDCCCoreDataSet.vaccination.brand
        Definition

        The brand or trade name used to refer to the vaccine received.

        ShortVaccine brand
        Control1..1
        TypeCoding
        Summarytrue
        48. DDCCCoreDataSet.vaccination.manufacturer
        Definition

        Name of the manufacturer of the vaccine received. e.g. Serum institute of India, AstraZeneca. If vaccine manufacturer is unknown, market authorization holder is REQUIRED.

        ShortVaccine manufacturer
        Control0..1
        TypeCoding
        Summarytrue
        50. DDCCCoreDataSet.vaccination.maholder
        Definition

        Name of the market authorization holder of the vaccine received. If market authorization holder is unknown, vaccine manufacturer is REQUIRED.

        ShortVaccine market authorization holder
        Control0..1
        TypeCoding
        Summarytrue
        52. DDCCCoreDataSet.vaccination.lot
        Definition

        Lot number or batch number of vaccination.

        ShortVaccine lot number
        Control1..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        54. DDCCCoreDataSet.vaccination.date
        Definition

        Date in which the vaccine was provided.

        ShortDate of vaccination
        Control1..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        56. DDCCCoreDataSet.vaccination.validFrom
        Definition

        Date upon which provided vaccination is considered valid.

        ShortVaccination valid from
        Control0..1
        Typedate
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        58. DDCCCoreDataSet.vaccination.dose
        Definition

        Vaccine dose number.

        ShortDose number
        Control1..1
        TypepositiveInt
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        60. DDCCCoreDataSet.vaccination.totalDoses
        Definition

        Total expected doses as defined by Member State care plan and immunization programme policies.

        ShortTotal doses
        Control0..1
        TypepositiveInt
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        62. DDCCCoreDataSet.vaccination.country
        Definition

        The country in which the individual has been vaccinated.

        ShortCountry of vaccination
        Control1..1
        BindingThe codes SHOULD be taken from Iso3166-1-3
        (preferred to http://hl7.org/fhir/ValueSet/iso3166-1-3)
        TypeCoding
        Summarytrue
        64. DDCCCoreDataSet.vaccination.centre
        Definition

        The name or identifier of the vaccination facility responsible for providing the vaccination.

        ShortAdministering centre
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        66. DDCCCoreDataSet.vaccination.signature
        Definition

        REQUIRED for PAPER vaccination certificates ONLY. The health worker who provided the vaccination or the supervising clinician's hand-written signature.

        ShortSignature of health worker
        Control0..1
        TypeSignature
        68. DDCCCoreDataSet.vaccination.practitioner
        Definition

        OPTIONAL for DIGITAL and PAPER vaccination certificates. The unique identifier for the health worker as determined by the member state. There can be more than one unique identifier used. (e.g. system generated ID, health profession number, cryptographic signature, or any other form of health worker unique identifier). This can be used in lieu of a paper-based signature.

        ShortHealth worker identifier
        Control0..1
        TypeIdentifier
        70. DDCCCoreDataSet.vaccination.disease
        Definition

        Name of disease vaccinated against (such as COVID-19).

        ShortDisease or agent targeted
        Control0..1
        BindingThe codes SHOULD be taken from WHO Disease or Agent Targeted (COVID-19)
        (preferred to http://smart.who.int/ddcc/ValueSet/WHODDCCDiseaseTargetedCOVID19)
        TypeCoding
        72. DDCCCoreDataSet.vaccination.nextDose
        Definition

        Date on which the next vaccination should be administered, if a next dose is REQUIRED.

        ShortDue date of next dose
        Control0..1
        Typedate
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension