SMART ICVP, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.2.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: ICVP - Vaccine Details ( Experimental )
| Official URL: http://smart.who.int/icvp/StructureDefinition/ICVPVaccineDetails | Version: 0.2.0 | |||
| Active as of 2025-09-25 | Computable Name: ICVPVaccineDetails | |||
Vaccine Data elements for the International Certificate of Vaccination or Prophylaxis
Usages:
- Derived from this Logical Model: ICVP Vaccine Details with Selective Disclosure and pICVP - Vaccine Details
- Use this Logical Model: ICVP and DVC Icvp with Selective Disclosure
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  ICVPVaccineDetails |
C | 0..* | PreQualVaccineDetails | Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID ICVP - Vaccine Details Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician |
  productID |
C | 1..1 | Coding | Vaccine Product Constraints: is-a-prequal-product-id, is-an-icvp-product-id |
 date |
1..1 | date | Date | |
 issuer |
0..1 | Reference(Organization) | Issuing Organization | |
| clinicianName |
0..1 | string | Name of supervising clinician | |
| batchNo |
1..1 | CodeableConcept | Batch No | |
 validityPeriod |
0..1 | Period | Certificate validity period | |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| is-a-prequal-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the PreQual Database : system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds' | |
| is-an-icvp-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the ICVP vaccines from the PreQual Databatase : system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds' | |
| must-have-issuer-or-clinician | error | ICVPVaccineDetails | Either issuer or clinicianName must be present : issuer.exists() or clinicianName.exists() |
This structure is derived from PreQualVaccineDetails
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVPVaccineDetails |
0..* | PreQualVaccineDetails | Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID ICVP - Vaccine Details Instances of this logical model can be the target of a Reference | |
| productID |
C | 1..1 | Coding | Vaccine Product Constraints: is-an-icvp-product-id |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| is-an-icvp-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the ICVP vaccines from the PreQual Databatase : system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds' |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVPVaccineDetails |
C | 0..* | PreQualVaccineDetails | Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID ICVP - Vaccine Details Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician |
| productID |
C | 1..1 | Coding | Vaccine Product Constraints: is-a-prequal-product-id, is-an-icvp-product-id |
| date |
1..1 | date | Date | |
| issuer |
0..1 | Reference(Organization) | Issuing Organization | |
| clinicianName |
0..1 | string | Name of supervising clinician | |
| batchNo |
1..1 | CodeableConcept | Batch No | |
| validityPeriod |
0..1 | Period | Certificate validity period | |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| is-a-prequal-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the PreQual Database : system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds' | |
| is-an-icvp-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the ICVP vaccines from the PreQual Databatase : system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds' | |
| must-have-issuer-or-clinician | error | ICVPVaccineDetails | Either issuer or clinicianName must be present : issuer.exists() or clinicianName.exists() |
This structure is derived from PreQualVaccineDetails
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVPVaccineDetails |
C | 0..* | PreQualVaccineDetails | Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID ICVP - Vaccine Details Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician |
| productID |
C | 1..1 | Coding | Vaccine Product Constraints: is-a-prequal-product-id, is-an-icvp-product-id |
| date |
1..1 | date | Date | |
| issuer |
0..1 | Reference(Organization) | Issuing Organization | |
| clinicianName |
0..1 | string | Name of supervising clinician | |
| batchNo |
1..1 | CodeableConcept | Batch No | |
| validityPeriod |
0..1 | Period | Certificate validity period | |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| is-a-prequal-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the PreQual Database : system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds' | |
| is-an-icvp-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the ICVP vaccines from the PreQual Databatase : system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds' | |
| must-have-issuer-or-clinician | error | ICVPVaccineDetails | Either issuer or clinicianName must be present : issuer.exists() or clinicianName.exists() |
Differential View
This structure is derived from PreQualVaccineDetails
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVPVaccineDetails |
0..* | PreQualVaccineDetails | Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID ICVP - Vaccine Details Instances of this logical model can be the target of a Reference | |
| productID |
C | 1..1 | Coding | Vaccine Product Constraints: is-an-icvp-product-id |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| is-an-icvp-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the ICVP vaccines from the PreQual Databatase : system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds' |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVPVaccineDetails |
C | 0..* | PreQualVaccineDetails | Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID ICVP - Vaccine Details Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician |
| productID |
C | 1..1 | Coding | Vaccine Product Constraints: is-a-prequal-product-id, is-an-icvp-product-id |
| date |
1..1 | date | Date | |
| issuer |
0..1 | Reference(Organization) | Issuing Organization | |
| clinicianName |
0..1 | string | Name of supervising clinician | |
| batchNo |
1..1 | CodeableConcept | Batch No | |
| validityPeriod |
0..1 | Period | Certificate validity period | |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| is-a-prequal-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the PreQual Database : system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds' | |
| is-an-icvp-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the ICVP vaccines from the PreQual Databatase : system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds' | |
| must-have-issuer-or-clinician | error | ICVPVaccineDetails | Either issuer or clinicianName must be present : issuer.exists() or clinicianName.exists() |
This structure is derived from PreQualVaccineDetails