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

Logical Model: ModelVaccineDetails - Detailed Descriptions

Active as of 2024-12-11

Definitions for the ModelVaccineDetails logical model.

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

0. ModelVaccineDetails
Definition

Vaccine Data elements for the Digital Vaccination Certificates

ShortDVC - Vaccine Details
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. ModelVaccineDetails.doseNumber
Definition

Dose Number

ShortDose Number
Control1..1
BindingThe codes SHALL be taken from Dose Number
(required to http://smart.who.int/icvp/ValueSet/doseNumber)
TypeCodeableConcept
4. ModelVaccineDetails.disease
Definition

Name of disease or condition vaccinated or received prophylaxis against

ShortDisease
Control1..1
BindingThe codes SHALL be taken from Disease Targeted
(required to http://smart.who.int/icvp/ValueSet/DiseaseTargeted)
TypeCoding
6. ModelVaccineDetails.vaccineClassification
Definition

Vaccine or prophylaxis classification code

ShortVaccine code
Control1..1
BindingThe codes SHALL be taken from DVC - Vaccines
(required to http://smart.who.int/icvp/ValueSet/DVCVaccines)
TypeCodeableConcept
8. ModelVaccineDetails.vaccineTradeItem
Definition

Vaccine trade item id

Shortvaccine trade item id
Control0..1
TypeIdentifier
10. ModelVaccineDetails.date
Definition

Date of vaccine

ShortDate
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. ModelVaccineDetails.clinicianName
Definition

Name of supervising clinician, or relevant authority responsible for issuing this certificate, or for overseeing the administering centre

ShortName of supervising clinician
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. ModelVaccineDetails.issuer
Definition

Relevant authoring reponsible for issuing the certificate, or for overseeing the administration center

ShortIssuing Organization
Control0..1
TypeReference(Organization)
16. ModelVaccineDetails.manufacturerId
Definition

Manufacturer ID

ShortManufacture ID
Control0..1
TypeIdentifier
18. ModelVaccineDetails.manufacturer
Definition

Name Manufacturer of vaccine

ShortName of Manufacturer of vaccine
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. ModelVaccineDetails.batchNo
Definition

Batch No

ShortBatch No
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. ModelVaccineDetails.validityPeriod
Definition

Certificate validity period

ShortCertificate validity period
Control0..1
TypePeriod

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

0. ModelVaccineDetails
Definition

Vaccine Data elements for the Digital Vaccination Certificates

ShortDVC - Vaccine Details
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. ModelVaccineDetails.doseNumber
Definition

Dose Number

ShortDose Number
Control1..1
BindingThe codes SHALL be taken from Dose Number
(required to http://smart.who.int/icvp/ValueSet/doseNumber)
TypeCodeableConcept
4. ModelVaccineDetails.disease
Definition

Name of disease or condition vaccinated or received prophylaxis against

ShortDisease
Control1..1
BindingThe codes SHALL be taken from Disease Targeted
(required to http://smart.who.int/icvp/ValueSet/DiseaseTargeted)
TypeCoding
6. ModelVaccineDetails.vaccineClassification
Definition

Vaccine or prophylaxis classification code

ShortVaccine code
Control1..1
BindingThe codes SHALL be taken from DVC - Vaccines
(required to http://smart.who.int/icvp/ValueSet/DVCVaccines)
TypeCodeableConcept
8. ModelVaccineDetails.vaccineTradeItem
Definition

Vaccine trade item id

Shortvaccine trade item id
Control0..1
TypeIdentifier
10. ModelVaccineDetails.date
Definition

Date of vaccine

ShortDate
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. ModelVaccineDetails.clinicianName
Definition

Name of supervising clinician, or relevant authority responsible for issuing this certificate, or for overseeing the administering centre

ShortName of supervising clinician
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. ModelVaccineDetails.issuer
Definition

Relevant authoring reponsible for issuing the certificate, or for overseeing the administration center

ShortIssuing Organization
Control0..1
TypeReference(Organization)
16. ModelVaccineDetails.manufacturerId
Definition

Manufacturer ID

ShortManufacture ID
Control0..1
TypeIdentifier
18. ModelVaccineDetails.manufacturer
Definition

Name Manufacturer of vaccine

ShortName of Manufacturer of vaccine
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. ModelVaccineDetails.batchNo
Definition

Batch No

ShortBatch No
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. ModelVaccineDetails.validityPeriod
Definition

Certificate validity period

ShortCertificate validity period
Control0..1
TypePeriod

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

0. ModelVaccineDetails
Definition

Vaccine Data elements for the Digital Vaccination Certificates

ShortDVC - Vaccine Details
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. ModelVaccineDetails.doseNumber
Definition

Dose Number

ShortDose Number
Control1..1
BindingThe codes SHALL be taken from Dose Number
(required to http://smart.who.int/icvp/ValueSet/doseNumber)
TypeCodeableConcept
4. ModelVaccineDetails.disease
Definition

Name of disease or condition vaccinated or received prophylaxis against

ShortDisease
Control1..1
BindingThe codes SHALL be taken from Disease Targeted
(required to http://smart.who.int/icvp/ValueSet/DiseaseTargeted)
TypeCoding
6. ModelVaccineDetails.vaccineClassification
Definition

Vaccine or prophylaxis classification code

ShortVaccine code
Control1..1
BindingThe codes SHALL be taken from DVC - Vaccines
(required to http://smart.who.int/icvp/ValueSet/DVCVaccines)
TypeCodeableConcept
8. ModelVaccineDetails.vaccineTradeItem
Definition

Vaccine trade item id

Shortvaccine trade item id
Control0..1
TypeIdentifier
10. ModelVaccineDetails.date
Definition

Date of vaccine

ShortDate
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. ModelVaccineDetails.clinicianName
Definition

Name of supervising clinician, or relevant authority responsible for issuing this certificate, or for overseeing the administering centre

ShortName of supervising clinician
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. ModelVaccineDetails.issuer
Definition

Relevant authoring reponsible for issuing the certificate, or for overseeing the administration center

ShortIssuing Organization
Control0..1
TypeReference(Organization)
16. ModelVaccineDetails.manufacturerId
Definition

Manufacturer ID

ShortManufacture ID
Control0..1
TypeIdentifier
18. ModelVaccineDetails.manufacturer
Definition

Name Manufacturer of vaccine

ShortName of Manufacturer of vaccine
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. ModelVaccineDetails.batchNo
Definition

Batch No

ShortBatch No
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. ModelVaccineDetails.validityPeriod
Definition

Certificate validity period

ShortCertificate validity period
Control0..1
TypePeriod