WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.0 - CI Build
WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.0 - CI Build
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 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
| Draft as of 2024-10-15 |
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. |
| Short | Certificate - Smart Health Card's JSon Web Token Logical Model |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. CertSHC.iss | |
| Definition | Issuer |
| Short | Issuer |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. CertSHC.sub | |
| Definition | Subject |
| Short | Subject |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. CertSHC.aud | |
| Definition | Audience |
| Short | Audience |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. CertSHC.exp | |
| Definition | Expiration Date |
| Short | Expiration Date |
| Control | 0..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. CertSHC.nbf | |
| Definition | Not before Date |
| Short | Not before Date |
| Control | 0..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. CertSHC.iat | |
| Definition | Issued at Date |
| Short | Issued at Date |
| Control | 0..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. CertSHC.jti | |
| Definition | Credential's Unique Identifier |
| Short | Credential's Unique Identifier |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. CertSHC.vc | |
| Definition | VC - verifiable credential |
| Short | VC - verifiable credential |
| Control | 0..1 |
| Type | BackboneElement |
| 18. CertSHC.vc.type | |
| Definition | Credential Type |
| Short | Credential Type |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. CertSHC.vc.credentialSubject | |
| Definition | Credential Subject |
| Short | Credential Subject |
| Control | 0..1 |
| Type | BackboneElement |
| 22. CertSHC.vc.credentialSubject.fhirVersion | |
| Definition | Fhir Version |
| Short | Fhir Version |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. CertSHC.vc.credentialSubject.fhirBundle | |
| Definition | Fhir Bundle with the signed objects |
| Short | Fhir Bundle with the signed objects |
| Control | 0..1 |
| Type | Bundle |
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. |
| Short | Certificate - Smart Health Card's JSon Web Token Logical Model |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. CertSHC.iss | |
| Definition | Issuer |
| Short | Issuer |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. CertSHC.sub | |
| Definition | Subject |
| Short | Subject |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. CertSHC.aud | |
| Definition | Audience |
| Short | Audience |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. CertSHC.exp | |
| Definition | Expiration Date |
| Short | Expiration Date |
| Control | 0..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. CertSHC.nbf | |
| Definition | Not before Date |
| Short | Not before Date |
| Control | 0..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. CertSHC.iat | |
| Definition | Issued at Date |
| Short | Issued at Date |
| Control | 0..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. CertSHC.jti | |
| Definition | Credential's Unique Identifier |
| Short | Credential's Unique Identifier |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. CertSHC.vc | |
| Definition | VC - verifiable credential |
| Short | VC - verifiable credential |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. 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). |
| Short | Extensions 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 Names | extensions, user content, modifiers |
| Invariants | ele-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()) |
| 20. CertSHC.vc.type | |
| Definition | Credential Type |
| Short | Credential Type |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. CertSHC.vc.credentialSubject | |
| Definition | Credential Subject |
| Short | Credential Subject |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 24. 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). |
| Short | Extensions 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 Names | extensions, user content, modifiers |
| Invariants | ele-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()) |
| 26. CertSHC.vc.credentialSubject.fhirVersion | |
| Definition | Fhir Version |
| Short | Fhir Version |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. CertSHC.vc.credentialSubject.fhirBundle | |
| Definition | Fhir Bundle with the signed objects |
| Short | Fhir Bundle with the signed objects |
| Control | 0..1 |
| Type | Bundle |
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. |
| Short | Certificate - Smart Health Card's JSon Web Token Logical Model |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. CertSHC.iss | |
| Definition | Issuer |
| Short | Issuer |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. CertSHC.sub | |
| Definition | Subject |
| Short | Subject |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. CertSHC.aud | |
| Definition | Audience |
| Short | Audience |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. CertSHC.exp | |
| Definition | Expiration Date |
| Short | Expiration Date |
| Control | 0..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. CertSHC.nbf | |
| Definition | Not before Date |
| Short | Not before Date |
| Control | 0..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. CertSHC.iat | |
| Definition | Issued at Date |
| Short | Issued at Date |
| Control | 0..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. CertSHC.jti | |
| Definition | Credential's Unique Identifier |
| Short | Credential's Unique Identifier |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. CertSHC.vc | |
| Definition | VC - verifiable credential |
| Short | VC - verifiable credential |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-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. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 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. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-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()) |
| Slicing | This element introduces a set of slices on CertSHC.vc.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 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). |
| Short | Extensions 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 Names | extensions, user content, modifiers |
| Invariants | ele-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 |
| Short | Credential Type |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. CertSHC.vc.credentialSubject | |
| Definition | Credential Subject |
| Short | Credential Subject |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-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. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 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. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-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()) |
| Slicing | This element introduces a set of slices on CertSHC.vc.credentialSubject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 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). |
| Short | Extensions 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 Names | extensions, user content, modifiers |
| Invariants | ele-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 |
| Short | Fhir Version |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 36. CertSHC.vc.credentialSubject.fhirBundle | |
| Definition | Fhir Bundle with the signed objects |
| Short | Fhir Bundle with the signed objects |
| Control | 0..1 |
| Type | Bundle |