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

Logical Model: ICVPMinVaccineDetails - Detailed Descriptions

Draft as of 2025-08-19

Definitions for the ICVPMinVaccineDetails logical model.

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

0. ICVPMinVaccineDetails
Definition

Mininmial vaccine detail in DVC payload for use within an HCERT Payload using the ICVP Product Catalogue

ShortICVP HCERT Payload
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsmust-have-issuer-or-clinician-name: Either issuer or clinicianName must be present (v.is.exists() or v.cn.exists())
2. ICVPMinVaccineDetails.vp
Definition

ICVP Product Catalog ID

ShortICVP Product Catalog ID
Control1..1
BindingThe codes SHALL be taken from WHO ICVP Vaccine Product Ids
(required to http://smart.who.int/icvp/ValueSet/ICVPProductIds)
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. ICVPMinVaccineDetails.dt
Definition

Date of vaccination, YYYY-MM-DD format

ShortDate of vaccination, YYYY-MM-DD format
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. ICVPMinVaccineDetails.cn
Definition

Name of supervising clinician

ShortName of supervising clinician
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. ICVPMinVaccineDetails.is
Definition

Certificate issuer id (referenced organization)

ShortCertificate issuer id (referenced organization)
Control0..1
Typeid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. ICVPMinVaccineDetails.bo
Definition

Batch No

ShortBatch No
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. ICVPMinVaccineDetails.vls
Definition

Certificate Validity periods start date

ShortCertificate Validity periods start date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. ICVPMinVaccineDetails.vle
Definition

Certificate Validity periods end date

ShortCertificate Validity periods end date
Control0..1
Typedate
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 foundhere

0. ICVPMinVaccineDetails
Definition

Mininmial vaccine detail in DVC payload for use within an HCERT Payload using the ICVP Product Catalogue

ShortICVP HCERT Payload
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. ICVPMinVaccineDetails.vp
BindingThe codes SHALL be taken from WHO ICVP Vaccine Product Ids
(required to http://smart.who.int/icvp/ValueSet/ICVPProductIds)

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

0. ICVPMinVaccineDetails
Definition

Mininmial vaccine detail in DVC payload for use within an HCERT Payload using the ICVP Product Catalogue

ShortICVP HCERT Payload
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsmust-have-issuer-or-clinician-name: Either issuer or clinicianName must be present (v.is.exists() or v.cn.exists())
2. ICVPMinVaccineDetails.vp
Definition

ICVP Product Catalog ID

ShortICVP Product Catalog ID
Control1..1
BindingThe codes SHALL be taken from WHO ICVP Vaccine Product Ids
(required to http://smart.who.int/icvp/ValueSet/ICVPProductIds)
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. ICVPMinVaccineDetails.dt
Definition

Date of vaccination, YYYY-MM-DD format

ShortDate of vaccination, YYYY-MM-DD format
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. ICVPMinVaccineDetails.cn
Definition

Name of supervising clinician

ShortName of supervising clinician
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. ICVPMinVaccineDetails.is
Definition

Certificate issuer id (referenced organization)

ShortCertificate issuer id (referenced organization)
Control0..1
Typeid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. ICVPMinVaccineDetails.bo
Definition

Batch No

ShortBatch No
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. ICVPMinVaccineDetails.vls
Definition

Certificate Validity periods start date

ShortCertificate Validity periods start date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. ICVPMinVaccineDetails.vle
Definition

Certificate Validity periods end date

ShortCertificate Validity periods end date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension