WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.1 - release International flag

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. For a full list of available versions, see the Directory of published versions

Logical Model: CertSHC - Detailed Descriptions

Draft as of 2024-12-18

Definitions for the CertSHC logical model.

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

0. CertSHC
Definition

Data elements for the Smart Health Cards Core Data Set.

ShortCertificate - Smart Health Card's JSon Web Token Logical Model
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. CertSHC.iss
Definition

Issuer

ShortIssuer
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. CertSHC.sub
Definition

Subject

ShortSubject
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. CertSHC.aud
Definition

Audience

ShortAudience
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. CertSHC.exp
Definition

Expiration Date

ShortExpiration Date
Control0..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. CertSHC.nbf
Definition

Not before Date

ShortNot before Date
Control0..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. CertSHC.iat
Definition

Issued at Date

ShortIssued at Date
Control0..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. CertSHC.jti
Definition

Credential's Unique Identifier

ShortCredential's Unique Identifier
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. CertSHC.vc
Definition

VC - verifiable credential

ShortVC - verifiable credential
Control0..1
TypeBackboneElement
18. CertSHC.vc.type
Definition

Credential Type

ShortCredential Type
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. CertSHC.vc.credentialSubject
Definition

Credential Subject

ShortCredential Subject
Control0..1
TypeBackboneElement
22. CertSHC.vc.credentialSubject.fhirVersion
Definition

Fhir Version

ShortFhir Version
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. CertSHC.vc.credentialSubject.fhirBundle
Definition

Fhir Bundle with the signed objects

ShortFhir Bundle with the signed objects
Control0..1
TypeBundle

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

0. CertSHC
Definition

Data elements for the Smart Health Cards Core Data Set.

ShortCertificate - Smart Health Card's JSon Web Token Logical Model
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. CertSHC.iss
Definition

Issuer

ShortIssuer
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. CertSHC.sub
Definition

Subject

ShortSubject
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. CertSHC.aud
Definition

Audience

ShortAudience
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. CertSHC.exp
Definition

Expiration Date

ShortExpiration Date
Control0..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. CertSHC.nbf
Definition

Not before Date

ShortNot before Date
Control0..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. CertSHC.iat
Definition

Issued at Date

ShortIssued at Date
Control0..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. CertSHC.jti
Definition

Credential's Unique Identifier

ShortCredential's Unique Identifier
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. CertSHC.vc
Definition

VC - verifiable credential

ShortVC - verifiable credential
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. CertSHC.vc.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
20. CertSHC.vc.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 CertSHC.vc.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 22. CertSHC.vc.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())
    24. CertSHC.vc.type
    Definition

    Credential Type

    ShortCredential Type
    Control0..*
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    26. CertSHC.vc.credentialSubject
    Definition

    Credential Subject

    ShortCredential Subject
    Control0..1
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. CertSHC.vc.credentialSubject.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. CertSHC.vc.credentialSubject.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 CertSHC.vc.credentialSubject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 32. CertSHC.vc.credentialSubject.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())
      34. CertSHC.vc.credentialSubject.fhirVersion
      Definition

      Fhir Version

      ShortFhir Version
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      36. CertSHC.vc.credentialSubject.fhirBundle
      Definition

      Fhir Bundle with the signed objects

      ShortFhir Bundle with the signed objects
      Control0..1
      TypeBundle

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

      0. CertSHC
      Definition

      Data elements for the Smart Health Cards Core Data Set.

      ShortCertificate - Smart Health Card's JSon Web Token Logical Model
      Control0..*
      Is Modifierfalse
      Logical ModelInstances of this logical model are not marked to be the target of a Reference
      2. CertSHC.iss
      Definition

      Issuer

      ShortIssuer
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      4. CertSHC.sub
      Definition

      Subject

      ShortSubject
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      6. CertSHC.aud
      Definition

      Audience

      ShortAudience
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      8. CertSHC.exp
      Definition

      Expiration Date

      ShortExpiration Date
      Control0..1
      Typedecimal
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      10. CertSHC.nbf
      Definition

      Not before Date

      ShortNot before Date
      Control0..1
      Typedecimal
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      12. CertSHC.iat
      Definition

      Issued at Date

      ShortIssued at Date
      Control0..1
      Typedecimal
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      14. CertSHC.jti
      Definition

      Credential's Unique Identifier

      ShortCredential's Unique Identifier
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      16. CertSHC.vc
      Definition

      VC - verifiable credential

      ShortVC - verifiable credential
      Control0..1
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      18. CertSHC.vc.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
      20. CertSHC.vc.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 CertSHC.vc.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 22. CertSHC.vc.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())
        24. CertSHC.vc.type
        Definition

        Credential Type

        ShortCredential Type
        Control0..*
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        26. CertSHC.vc.credentialSubject
        Definition

        Credential Subject

        ShortCredential Subject
        Control0..1
        TypeBackboneElement
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        28. CertSHC.vc.credentialSubject.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. CertSHC.vc.credentialSubject.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 CertSHC.vc.credentialSubject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 32. CertSHC.vc.credentialSubject.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())
          34. CertSHC.vc.credentialSubject.fhirVersion
          Definition

          Fhir Version

          ShortFhir Version
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          36. CertSHC.vc.credentialSubject.fhirBundle
          Definition

          Fhir Bundle with the signed objects

          ShortFhir Bundle with the signed objects
          Control0..1
          TypeBundle