SMART ICVP
0.1.0 - ci-build
SMART ICVP, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-icvp/ and changes regularly. See the Directory of published versions
| Draft as of 2024-09-19 |
Definitions for the DVCPayload logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. DVCPayload | |
| Definition | Payload for Digital Vaccination Certificate - DVC CBOR Web Token Logical Model |
| Short | DVC HCERT Payload |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | mustHaveIsOrCn: Either issuer or clinicianName must be present (v.is.exists() or v.cn.exists()) |
| 2. DVCPayload.n | |
| Definition | Person name |
| Short | Person name |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. DVCPayload.dob | |
| Definition | Date of birth in YYYY-MM-DD format |
| Short | Date of birth in YYYY-MM-DD format |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. DVCPayload.s | |
| Definition | Sex |
| Short | Sex |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. DVCPayload.ntl | |
| Definition | Nationality |
| Short | Nationality |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. DVCPayload.nid | |
| Definition | National Identification Document |
| Short | National Identification Document |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. DVCPayload.gn | |
| Definition | Parent or Guardian Name |
| Short | Parent or Guardian Name |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. DVCPayload.v | |
| Definition | Vaccination Group (see element details) |
| Short | Vaccination Group (see element details) |
| Control | 1..1 |
| Type | BackboneElement |
| 16. DVCPayload.v.dn | |
| Definition | Dose Number |
| Short | Dose Number |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. DVCPayload.v.tg | |
| Definition | Name of disease or condition vaccinated or received prophylaxis against |
| Short | Name of disease or condition vaccinated or received prophylaxis against |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. DVCPayload.v.vp | |
| Definition | Vaccine or prophylaxis classification code |
| Short | Vaccine or prophylaxis classification code |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. DVCPayload.v.mp | |
| Definition | Vaccine Trade item id |
| Short | Vaccine Trade item id |
| Control | 0..1 |
| Type | id |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. DVCPayload.v.ma | |
| Definition | manufacturer name |
| Short | manufacturer name |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. DVCPayload.v.mid | |
| Definition | manufacturer id |
| Short | manufacturer id |
| Control | 0..1 |
| Type | id |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. DVCPayload.v.dt | |
| Definition | Date of vaccination, YYYY-MM-DD format |
| Short | Date of vaccination, YYYY-MM-DD format |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. DVCPayload.v.bo | |
| Definition | Batch No |
| Short | Batch No |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. DVCPayload.v.vls | |
| Definition | Certificate Validity periods start date |
| Short | Certificate Validity periods start date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. DVCPayload.v.vle | |
| Definition | Certificate Validity periods end date |
| Short | Certificate Validity periods end date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 36. DVCPayload.v.cn | |
| Definition | Name of supervising clinician |
| Short | Name of supervising clinician |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. DVCPayload.v.is | |
| Definition | Certificate issuer id (referenced organization) |
| Short | Certificate issuer id (referenced organization) |
| Control | 0..1 |
| Type | id |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
| 0. DVCPayload | |
| Definition | Payload for Digital Vaccination Certificate - DVC CBOR Web Token Logical Model |
| Short | DVC HCERT Payload |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | mustHaveIsOrCn: Either issuer or clinicianName must be present (v.is.exists() or v.cn.exists()) |
| 2. DVCPayload.n | |
| Definition | Person name |
| Short | Person name |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. DVCPayload.dob | |
| Definition | Date of birth in YYYY-MM-DD format |
| Short | Date of birth in YYYY-MM-DD format |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. DVCPayload.s | |
| Definition | Sex |
| Short | Sex |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. DVCPayload.ntl | |
| Definition | Nationality |
| Short | Nationality |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. DVCPayload.nid | |
| Definition | National Identification Document |
| Short | National Identification Document |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. DVCPayload.gn | |
| Definition | Parent or Guardian Name |
| Short | Parent or Guardian Name |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. DVCPayload.v | |
| Definition | Vaccination Group (see element details) |
| Short | Vaccination Group (see element details) |
| Control | 1..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. DVCPayload.v.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()) |
| 18. DVCPayload.v.dn | |
| Definition | Dose Number |
| Short | Dose Number |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. DVCPayload.v.tg | |
| Definition | Name of disease or condition vaccinated or received prophylaxis against |
| Short | Name of disease or condition vaccinated or received prophylaxis against |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. DVCPayload.v.vp | |
| Definition | Vaccine or prophylaxis classification code |
| Short | Vaccine or prophylaxis classification code |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. DVCPayload.v.mp | |
| Definition | Vaccine Trade item id |
| Short | Vaccine Trade item id |
| Control | 0..1 |
| Type | id |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. DVCPayload.v.ma | |
| Definition | manufacturer name |
| Short | manufacturer name |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. DVCPayload.v.mid | |
| Definition | manufacturer id |
| Short | manufacturer id |
| Control | 0..1 |
| Type | id |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. DVCPayload.v.dt | |
| Definition | Date of vaccination, YYYY-MM-DD format |
| Short | Date of vaccination, YYYY-MM-DD format |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. DVCPayload.v.bo | |
| Definition | Batch No |
| Short | Batch No |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. DVCPayload.v.vls | |
| Definition | Certificate Validity periods start date |
| Short | Certificate Validity periods start date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 36. DVCPayload.v.vle | |
| Definition | Certificate Validity periods end date |
| Short | Certificate Validity periods end date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. DVCPayload.v.cn | |
| Definition | Name of supervising clinician |
| Short | Name of supervising clinician |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 40. DVCPayload.v.is | |
| Definition | Certificate issuer id (referenced organization) |
| Short | Certificate issuer id (referenced organization) |
| Control | 0..1 |
| Type | id |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
| 0. DVCPayload | |
| Definition | Payload for Digital Vaccination Certificate - DVC CBOR Web Token Logical Model |
| Short | DVC HCERT Payload |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | mustHaveIsOrCn: Either issuer or clinicianName must be present (v.is.exists() or v.cn.exists()) |
| 2. DVCPayload.n | |
| Definition | Person name |
| Short | Person name |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. DVCPayload.dob | |
| Definition | Date of birth in YYYY-MM-DD format |
| Short | Date of birth in YYYY-MM-DD format |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. DVCPayload.s | |
| Definition | Sex |
| Short | Sex |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. DVCPayload.ntl | |
| Definition | Nationality |
| Short | Nationality |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. DVCPayload.nid | |
| Definition | National Identification Document |
| Short | National Identification Document |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. DVCPayload.gn | |
| Definition | Parent or Guardian Name |
| Short | Parent or Guardian Name |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. DVCPayload.v | |
| Definition | Vaccination Group (see element details) |
| Short | Vaccination Group (see element details) |
| Control | 1..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. DVCPayload.v.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 |
| 18. DVCPayload.v.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 DVCPayload.v.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. DVCPayload.v.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()) |
| 22. DVCPayload.v.dn | |
| Definition | Dose Number |
| Short | Dose Number |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. DVCPayload.v.tg | |
| Definition | Name of disease or condition vaccinated or received prophylaxis against |
| Short | Name of disease or condition vaccinated or received prophylaxis against |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. DVCPayload.v.vp | |
| Definition | Vaccine or prophylaxis classification code |
| Short | Vaccine or prophylaxis classification code |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. DVCPayload.v.mp | |
| Definition | Vaccine Trade item id |
| Short | Vaccine Trade item id |
| Control | 0..1 |
| Type | id |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. DVCPayload.v.ma | |
| Definition | manufacturer name |
| Short | manufacturer name |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. DVCPayload.v.mid | |
| Definition | manufacturer id |
| Short | manufacturer id |
| Control | 0..1 |
| Type | id |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. DVCPayload.v.dt | |
| Definition | Date of vaccination, YYYY-MM-DD format |
| Short | Date of vaccination, YYYY-MM-DD format |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 36. DVCPayload.v.bo | |
| Definition | Batch No |
| Short | Batch No |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. DVCPayload.v.vls | |
| Definition | Certificate Validity periods start date |
| Short | Certificate Validity periods start date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 40. DVCPayload.v.vle | |
| Definition | Certificate Validity periods end date |
| Short | Certificate Validity periods end date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 42. DVCPayload.v.cn | |
| Definition | Name of supervising clinician |
| Short | Name of supervising clinician |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 44. DVCPayload.v.is | |
| Definition | Certificate issuer id (referenced organization) |
| Short | Certificate issuer id (referenced organization) |
| Control | 0..1 |
| Type | id |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |