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/tree/main and changes regularly. See the Directory of published versions
Official URL: http://smart.who.int/icvp/StructureDefinition/DVCPayload | Version: 0.1.0 | |||
Draft as of 2024-12-11 | Computable Name: DVCPayload |
Payload for Digital Vaccination Certificate - DVC CBOR Web Token Logical Model
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DVCPayload | C | 0..* | Base | DVC HCERT Payload Instances of this logical model are not marked to be the target of a Reference mustHaveIsOrCn: Either issuer or clinicianName must be present |
n | 1..1 | string | Person name | |
dob | 1..1 | date | Date of birth in YYYY-MM-DD format | |
s | 0..1 | code | Sex | |
ntl | 0..1 | code | Nationality | |
nid | 0..1 | string | National Identification Document | |
gn | 0..1 | string | Parent or Guardian Name | |
v | 1..1 | BackboneElement | Vaccination Group (see element details) | |
dn | 1..1 | code | Dose Number | |
tg | 1..1 | code | Name of disease or condition vaccinated or received prophylaxis against | |
vp | 1..1 | code | Vaccine or prophylaxis classification code | |
mp | 0..1 | id | Vaccine Trade item id | |
ma | 1..1 | string | manufacturer name | |
mid | 0..1 | id | manufacturer id | |
dt | 1..1 | date | Date of vaccination, YYYY-MM-DD format | |
bo | 1..1 | string | Batch No | |
vls | 0..1 | date | Certificate Validity periods start date | |
vle | 0..1 | date | Certificate Validity periods end date | |
cn | 0..1 | string | Name of supervising clinician | |
is | 0..1 | id | Certificate issuer id (referenced organization) | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
mustHaveIsOrCn | error | DVCPayload | Either issuer or clinicianName must be present : v.is.exists() or v.cn.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DVCPayload | C | 0..* | Base | DVC HCERT Payload Instances of this logical model are not marked to be the target of a Reference mustHaveIsOrCn: Either issuer or clinicianName must be present |
n | 1..1 | string | Person name | |
dob | 1..1 | date | Date of birth in YYYY-MM-DD format | |
s | 0..1 | code | Sex | |
ntl | 0..1 | code | Nationality | |
nid | 0..1 | string | National Identification Document | |
gn | 0..1 | string | Parent or Guardian Name | |
v | 1..1 | BackboneElement | Vaccination Group (see element details) ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
dn | 1..1 | code | Dose Number | |
tg | 1..1 | code | Name of disease or condition vaccinated or received prophylaxis against | |
vp | 1..1 | code | Vaccine or prophylaxis classification code | |
mp | 0..1 | id | Vaccine Trade item id | |
ma | 1..1 | string | manufacturer name | |
mid | 0..1 | id | manufacturer id | |
dt | 1..1 | date | Date of vaccination, YYYY-MM-DD format | |
bo | 1..1 | string | Batch No | |
vls | 0..1 | date | Certificate Validity periods start date | |
vle | 0..1 | date | Certificate Validity periods end date | |
cn | 0..1 | string | Name of supervising clinician | |
is | 0..1 | id | Certificate issuer id (referenced organization) | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
mustHaveIsOrCn | error | DVCPayload | Either issuer or clinicianName must be present : v.is.exists() or v.cn.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DVCPayload | C | 0..* | Base | DVC HCERT Payload Instances of this logical model are not marked to be the target of a Reference mustHaveIsOrCn: Either issuer or clinicianName must be present |
n | 1..1 | string | Person name | |
dob | 1..1 | date | Date of birth in YYYY-MM-DD format | |
s | 0..1 | code | Sex | |
ntl | 0..1 | code | Nationality | |
nid | 0..1 | string | National Identification Document | |
gn | 0..1 | string | Parent or Guardian Name | |
v | 1..1 | BackboneElement | Vaccination Group (see element details) | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
dn | 1..1 | code | Dose Number | |
tg | 1..1 | code | Name of disease or condition vaccinated or received prophylaxis against | |
vp | 1..1 | code | Vaccine or prophylaxis classification code | |
mp | 0..1 | id | Vaccine Trade item id | |
ma | 1..1 | string | manufacturer name | |
mid | 0..1 | id | manufacturer id | |
dt | 1..1 | date | Date of vaccination, YYYY-MM-DD format | |
bo | 1..1 | string | Batch No | |
vls | 0..1 | date | Certificate Validity periods start date | |
vle | 0..1 | date | Certificate Validity periods end date | |
cn | 0..1 | string | Name of supervising clinician | |
is | 0..1 | id | Certificate issuer id (referenced organization) | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
mustHaveIsOrCn | error | DVCPayload | Either issuer or clinicianName must be present : v.is.exists() or v.cn.exists() |
This structure is derived from Base
Differential View
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DVCPayload | C | 0..* | Base | DVC HCERT Payload Instances of this logical model are not marked to be the target of a Reference mustHaveIsOrCn: Either issuer or clinicianName must be present |
n | 1..1 | string | Person name | |
dob | 1..1 | date | Date of birth in YYYY-MM-DD format | |
s | 0..1 | code | Sex | |
ntl | 0..1 | code | Nationality | |
nid | 0..1 | string | National Identification Document | |
gn | 0..1 | string | Parent or Guardian Name | |
v | 1..1 | BackboneElement | Vaccination Group (see element details) | |
dn | 1..1 | code | Dose Number | |
tg | 1..1 | code | Name of disease or condition vaccinated or received prophylaxis against | |
vp | 1..1 | code | Vaccine or prophylaxis classification code | |
mp | 0..1 | id | Vaccine Trade item id | |
ma | 1..1 | string | manufacturer name | |
mid | 0..1 | id | manufacturer id | |
dt | 1..1 | date | Date of vaccination, YYYY-MM-DD format | |
bo | 1..1 | string | Batch No | |
vls | 0..1 | date | Certificate Validity periods start date | |
vle | 0..1 | date | Certificate Validity periods end date | |
cn | 0..1 | string | Name of supervising clinician | |
is | 0..1 | id | Certificate issuer id (referenced organization) | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
mustHaveIsOrCn | error | DVCPayload | Either issuer or clinicianName must be present : v.is.exists() or v.cn.exists() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DVCPayload | C | 0..* | Base | DVC HCERT Payload Instances of this logical model are not marked to be the target of a Reference mustHaveIsOrCn: Either issuer or clinicianName must be present |
n | 1..1 | string | Person name | |
dob | 1..1 | date | Date of birth in YYYY-MM-DD format | |
s | 0..1 | code | Sex | |
ntl | 0..1 | code | Nationality | |
nid | 0..1 | string | National Identification Document | |
gn | 0..1 | string | Parent or Guardian Name | |
v | 1..1 | BackboneElement | Vaccination Group (see element details) ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
dn | 1..1 | code | Dose Number | |
tg | 1..1 | code | Name of disease or condition vaccinated or received prophylaxis against | |
vp | 1..1 | code | Vaccine or prophylaxis classification code | |
mp | 0..1 | id | Vaccine Trade item id | |
ma | 1..1 | string | manufacturer name | |
mid | 0..1 | id | manufacturer id | |
dt | 1..1 | date | Date of vaccination, YYYY-MM-DD format | |
bo | 1..1 | string | Batch No | |
vls | 0..1 | date | Certificate Validity periods start date | |
vle | 0..1 | date | Certificate Validity periods end date | |
cn | 0..1 | string | Name of supervising clinician | |
is | 0..1 | id | Certificate issuer id (referenced organization) | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
mustHaveIsOrCn | error | DVCPayload | Either issuer or clinicianName must be present : v.is.exists() or v.cn.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DVCPayload | C | 0..* | Base | DVC HCERT Payload Instances of this logical model are not marked to be the target of a Reference mustHaveIsOrCn: Either issuer or clinicianName must be present |
n | 1..1 | string | Person name | |
dob | 1..1 | date | Date of birth in YYYY-MM-DD format | |
s | 0..1 | code | Sex | |
ntl | 0..1 | code | Nationality | |
nid | 0..1 | string | National Identification Document | |
gn | 0..1 | string | Parent or Guardian Name | |
v | 1..1 | BackboneElement | Vaccination Group (see element details) | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
dn | 1..1 | code | Dose Number | |
tg | 1..1 | code | Name of disease or condition vaccinated or received prophylaxis against | |
vp | 1..1 | code | Vaccine or prophylaxis classification code | |
mp | 0..1 | id | Vaccine Trade item id | |
ma | 1..1 | string | manufacturer name | |
mid | 0..1 | id | manufacturer id | |
dt | 1..1 | date | Date of vaccination, YYYY-MM-DD format | |
bo | 1..1 | string | Batch No | |
vls | 0..1 | date | Certificate Validity periods start date | |
vle | 0..1 | date | Certificate Validity periods end date | |
cn | 0..1 | string | Name of supervising clinician | |
is | 0..1 | id | Certificate issuer id (referenced organization) | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
mustHaveIsOrCn | error | DVCPayload | Either issuer or clinicianName must be present : v.is.exists() or v.cn.exists() |
This structure is derived from Base