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/v1.0.0-updates and changes regularly. See the Directory of published versions
Logical Model: dICVP - Vaccine Details ( Experimental )
| Official URL: http://smart.who.int/icvp/StructureDefinition/dICVPVaccineDetails | Version: 0.1.0 | |||
| Active as of 2025-02-15 | Computable Name: dICVPVaccineDetails | |||
Vaccine Data elements for the Digital Model International Certificate of Vaccination or Prophylaxis.
Usage:
- Use this Logical Model Profile: dICVP
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  dICVPVaccineDetails |
C | 0..* | VaccineDetails | Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod dICVP - Vaccine Details Instances of this logical model can be the target of a Reference must-have-issuer-or-clinician: Either issuer or clinicianName must be present |
  productID |
1..1 | Coding | Vaccine Product | |
 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 | |
| certificateId |
1..1 | id | Certificate ID | |
| vaccineTradeItem |
0..1 | code | vaccine trade item id Binding: preQualVaccines (required) | |
| manufacturerId |
0..1 | Identifier | Manufacture ID | |
 serialNo |
0..1 | string | Serial No | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| dICVPVaccineDetails.vaccineTradeItem | required | preQualVaccines (a valid code from Prequalified Vaccines)http://smart.who.int/icvp/ValueSet/preQualVaccinesfrom this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| must-have-issuer-or-clinician | error | dICVPVaccineDetails | Either issuer or clinicianName must be present : issuer.exists() or clinicianName.exists() |
This structure is derived from VaccineDetails
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| dICVPVaccineDetails |
0..* | VaccineDetails | Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod dICVP - Vaccine Details Instances of this logical model can be the target of a Reference | |
| certificateId |
1..1 | id | Certificate ID | |
| vaccineTradeItem |
0..1 | code | vaccine trade item id Binding: preQualVaccines (required) | |
| manufacturerId |
0..1 | Identifier | Manufacture ID | |
| serialNo |
0..1 | string | Serial No | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| dICVPVaccineDetails.vaccineTradeItem | required | preQualVaccines (a valid code from Prequalified Vaccines)http://smart.who.int/icvp/ValueSet/preQualVaccinesfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| dICVPVaccineDetails |
C | 0..* | VaccineDetails | Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod dICVP - Vaccine Details Instances of this logical model can be the target of a Reference must-have-issuer-or-clinician: Either issuer or clinicianName must be present |
| productID |
1..1 | Coding | Vaccine Product | |
| 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 | |
| certificateId |
1..1 | id | Certificate ID | |
| vaccineTradeItem |
0..1 | code | vaccine trade item id Binding: preQualVaccines (required) | |
| manufacturerId |
0..1 | Identifier | Manufacture ID | |
| serialNo |
0..1 | string | Serial No | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| dICVPVaccineDetails.vaccineTradeItem | required | preQualVaccines (a valid code from Prequalified Vaccines)http://smart.who.int/icvp/ValueSet/preQualVaccinesfrom this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| must-have-issuer-or-clinician | error | dICVPVaccineDetails | Either issuer or clinicianName must be present : issuer.exists() or clinicianName.exists() |
This structure is derived from VaccineDetails
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| dICVPVaccineDetails |
C | 0..* | VaccineDetails | Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod dICVP - Vaccine Details Instances of this logical model can be the target of a Reference must-have-issuer-or-clinician: Either issuer or clinicianName must be present |
| productID |
1..1 | Coding | Vaccine Product | |
| 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 | |
| certificateId |
1..1 | id | Certificate ID | |
| vaccineTradeItem |
0..1 | code | vaccine trade item id Binding: preQualVaccines (required) | |
| manufacturerId |
0..1 | Identifier | Manufacture ID | |
| serialNo |
0..1 | string | Serial No | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| dICVPVaccineDetails.vaccineTradeItem | required | preQualVaccines (a valid code from Prequalified Vaccines)http://smart.who.int/icvp/ValueSet/preQualVaccinesfrom this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| must-have-issuer-or-clinician | error | dICVPVaccineDetails | Either issuer or clinicianName must be present : issuer.exists() or clinicianName.exists() |
Differential View
This structure is derived from VaccineDetails
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| dICVPVaccineDetails |
0..* | VaccineDetails | Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod dICVP - Vaccine Details Instances of this logical model can be the target of a Reference | |
| certificateId |
1..1 | id | Certificate ID | |
| vaccineTradeItem |
0..1 | code | vaccine trade item id Binding: preQualVaccines (required) | |
| manufacturerId |
0..1 | Identifier | Manufacture ID | |
| serialNo |
0..1 | string | Serial No | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| dICVPVaccineDetails.vaccineTradeItem | required | preQualVaccines (a valid code from Prequalified Vaccines)http://smart.who.int/icvp/ValueSet/preQualVaccinesfrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| dICVPVaccineDetails |
C | 0..* | VaccineDetails | Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod dICVP - Vaccine Details Instances of this logical model can be the target of a Reference must-have-issuer-or-clinician: Either issuer or clinicianName must be present |
| productID |
1..1 | Coding | Vaccine Product | |
| 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 | |
| certificateId |
1..1 | id | Certificate ID | |
| vaccineTradeItem |
0..1 | code | vaccine trade item id Binding: preQualVaccines (required) | |
| manufacturerId |
0..1 | Identifier | Manufacture ID | |
| serialNo |
0..1 | string | Serial No | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| dICVPVaccineDetails.vaccineTradeItem | required | preQualVaccines (a valid code from Prequalified Vaccines)http://smart.who.int/icvp/ValueSet/preQualVaccinesfrom this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| must-have-issuer-or-clinician | error | dICVPVaccineDetails | Either issuer or clinicianName must be present : issuer.exists() or clinicianName.exists() |
This structure is derived from VaccineDetails