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/14/merge and changes regularly. See the Directory of published versions

Logical Model: dICVPVaccineDetails - Detailed Descriptions

Active as of 2025-02-16

Definitions for the dICVPVaccineDetails logical model.

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

0. dICVPVaccineDetails
Definition

Vaccine Data elements for the Digital Model International Certificate of Vaccination or Prophylaxis.

ShortdICVP - Vaccine Details
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsmust-have-issuer-or-clinician: Either issuer or clinicianName must be present (issuer.exists() or clinicianName.exists())
2. dICVPVaccineDetails.productID
Definition

Vaccine product information (note: use InventoryItem in FHIR R6)

ShortVaccine Product
Control1..1
TypeCoding
4. dICVPVaccineDetails.date
Definition

Date of vaccine

ShortDate
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. dICVPVaccineDetails.issuer
Definition

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

ShortIssuing Organization
Control0..1
TypeReference(Organization)
8. dICVPVaccineDetails.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
10. dICVPVaccineDetails.batchNo
Definition

Batch No

ShortBatch No
Control1..1
TypeCodeableConcept
12. dICVPVaccineDetails.validityPeriod
Definition

Certificate validity period

ShortCertificate validity period
Control0..1
TypePeriod
14. dICVPVaccineDetails.certificateId
Definition

Certificate ID

ShortCertificate ID
Control1..1
Typeid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. dICVPVaccineDetails.vaccineTradeItem
Definition

Vaccine trade item id

Shortvaccine trade item id
Control0..1
BindingThe codes SHALL be taken from preQualVaccines
(required to http://smart.who.int/icvp/ValueSet/preQualVaccines)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. dICVPVaccineDetails.manufacturerId
Definition

Manufacturer ID

ShortManufacture ID
Control0..1
TypeIdentifier
20. dICVPVaccineDetails.serialNo
Definition

Serial No

ShortSerial No
Control0..1
Typestring
Primitive ValueThis 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. dICVPVaccineDetails
Definition

Vaccine Data elements for the Digital Model International Certificate of Vaccination or Prophylaxis.

ShortdICVP - Vaccine Details
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. dICVPVaccineDetails.certificateId
Definition

Certificate ID

ShortCertificate ID
Control1..1
Typeid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. dICVPVaccineDetails.vaccineTradeItem
Definition

Vaccine trade item id

Shortvaccine trade item id
Control0..1
BindingThe codes SHALL be taken from preQualVaccines
(required to http://smart.who.int/icvp/ValueSet/preQualVaccines)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. dICVPVaccineDetails.manufacturerId
Definition

Manufacturer ID

ShortManufacture ID
Control0..1
TypeIdentifier
8. dICVPVaccineDetails.serialNo
Definition

Serial No

ShortSerial No
Control0..1
Typestring
Primitive ValueThis 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. dICVPVaccineDetails
Definition

Vaccine Data elements for the Digital Model International Certificate of Vaccination or Prophylaxis.

ShortdICVP - Vaccine Details
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsmust-have-issuer-or-clinician: Either issuer or clinicianName must be present (issuer.exists() or clinicianName.exists())
2. dICVPVaccineDetails.productID
Definition

Vaccine product information (note: use InventoryItem in FHIR R6)

ShortVaccine Product
Control1..1
TypeCoding
4. dICVPVaccineDetails.date
Definition

Date of vaccine

ShortDate
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. dICVPVaccineDetails.issuer
Definition

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

ShortIssuing Organization
Control0..1
TypeReference(Organization)
8. dICVPVaccineDetails.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
10. dICVPVaccineDetails.batchNo
Definition

Batch No

ShortBatch No
Control1..1
TypeCodeableConcept
12. dICVPVaccineDetails.validityPeriod
Definition

Certificate validity period

ShortCertificate validity period
Control0..1
TypePeriod
14. dICVPVaccineDetails.certificateId
Definition

Certificate ID

ShortCertificate ID
Control1..1
Typeid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. dICVPVaccineDetails.vaccineTradeItem
Definition

Vaccine trade item id

Shortvaccine trade item id
Control0..1
BindingThe codes SHALL be taken from preQualVaccines
(required to http://smart.who.int/icvp/ValueSet/preQualVaccines)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. dICVPVaccineDetails.manufacturerId
Definition

Manufacturer ID

ShortManufacture ID
Control0..1
TypeIdentifier
20. dICVPVaccineDetails.serialNo
Definition

Serial No

ShortSerial No
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension