SMART ICVP
0.3.0 - ci-build
SMART ICVP, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.3.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/LMupdates and changes regularly. See the Directory of published versions
Built from commit 7fe2f17e. Branch: LMupdates.
| Active as of 2026-04-16 |
Definitions for the ICVPMinVaccineDetails logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. ICVPMinVaccineDetails | |
| Definition | Minimal vaccine detail in DVC payload for use within an HCERT Payload using the ICVP Product Catalogue Base definition for all types defined in FHIR type system. |
| Short | ICVP HCERT PayloadBase for all types and resources |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | must-have-issuer-or-clinician-name: Either issuer or clinicianName must be present (is.exists() or cn.exists()) |
| 2. ICVPMinVaccineDetails.vp | |
| Definition | Vaccine Product ID |
| Short | Vaccine Product ID |
| Comments | LOINC 39236-5; SNOMED CT 787859002. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from WHO ICVP Vaccine Product Ids (required to http://smart.who.int/icvp/ValueSet/ICVPProductIds) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-11 (ICVP.C5.DE.11) and REQ-CC-06. SHALL carry the identifier of the vaccine/prophylaxis product administered. Bound (required) to ICVPProductIds — a product outside this catalogue SHALL be rejected by ICVP.DT.1 / ICVP.DT.2. Disease (REQ-DE-12) and manufacturer (REQ-DE-16) are DERIVED from vp via the ICVP Product Catalogue and are NOT independently populated. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.11 (Vaccine or prophylaxis), LOINC: 39236-5 (Vaccine code), SNOMED CT: 787859002 (Vaccine product (medicinal product)) |
| 4. ICVPMinVaccineDetails.dv | |
| Definition | Date of vaccination |
| Short | Date of vaccination |
| Comments | LOINC 30952-6. |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-13 (ICVP.C5.DE.13). SHALL be the calendar date on which the vaccine/prophylaxis was administered — the anchor for all temporal-validity calculations (REQ-DE-20, REQ-DE-21/22/23). SHALL NOT be later than the certificate's issuance date or the verification date; MAY precede the issuance date. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.13 (Date), LOINC: 30952-6 (Date and time of vaccination) |
| 6. ICVPMinVaccineDetails.cn | |
| Definition | Name of supervising clinician |
| Short | Name of supervising clinician |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-14 (ICVP.C5.DE.14) and contributes to REQ-CC-07. MAY carry the full name of the supervising clinician. Either cn or is (REQ-DE-15) SHALL be present — see invariant must-have-issuer-or-clinician-name on DVCMinVaccineDetails. This is the digital counterpart of the Annex 6 clinician name column, NOT of the wet-ink signature (REQ-CC-08). |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.14 (Name of supervising clinician) |
| 8. ICVPMinVaccineDetails.is | |
| Definition | Certificate issuer id (referenced organization) |
| Short | Certificate issuer id (referenced organization) |
| Control | 0..1 |
| Type | id |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-15 (ICVP.C5.DE.15) and contributes to REQ-CC-07 / REQ-CC-10. MAY carry the identifier of the relevant issuing authority; SHALL correspond to a participant in the GDHCN SMART Trust ValueSet-Participants. Either cn (REQ-DE-14) or is SHALL be present. Certificates intended for international border verification SHOULD populate is — without it, cryptographic verification through the GDHCN is not possible. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.15 (Relevant authority responsible for issuing this certificate) |
| 10. ICVPMinVaccineDetails.bo | |
| Definition | Batch No |
| Short | Batch No |
| Comments | LOINC 30959-1 'Lot number [Identifier] Vaccine'. |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-17 (ICVP.C5.DE.17) and absorbs REQ-DE-18 (DE.18) and REQ-DE-19 (DE.19). SHALL carry the batch (lot) number as recorded by the manufacturer. Where a coded catalogue of batches is available, populate bo with the manufacturer's canonical batch identifier to preserve recall and pharmacovigilance traceability. SHALL NOT be omitted (Coexistence footnote 28). |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.17 (Batch No. of vaccine or prophylaxis), LOINC: 30959-1 (Lot number [Identifier] Vaccine) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ICVPMinVaccineDetails | |
| Definition | Minimal vaccine detail in DVC payload for use within an HCERT Payload using the ICVP Product Catalogue |
| Short | ICVP HCERT Payload |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. ICVPMinVaccineDetails.vp | |
| Comments | LOINC 39236-5; SNOMED CT 787859002. |
| Binding | The codes SHALL be taken from WHO ICVP Vaccine Product Ids (required to http://smart.who.int/icvp/ValueSet/ICVPProductIds) |
| Requirements | Satisfies REQ-DE-11 (ICVP.C5.DE.11) and REQ-CC-06. SHALL carry the identifier of the vaccine/prophylaxis product administered. Bound (required) to ICVPProductIds — a product outside this catalogue SHALL be rejected by ICVP.DT.1 / ICVP.DT.2. Disease (REQ-DE-12) and manufacturer (REQ-DE-16) are DERIVED from vp via the ICVP Product Catalogue and are NOT independently populated. |
| 4. ICVPMinVaccineDetails.dv | |
| Comments | LOINC 30952-6. |
| Requirements | Satisfies REQ-DE-13 (ICVP.C5.DE.13). SHALL be the calendar date on which the vaccine/prophylaxis was administered — the anchor for all temporal-validity calculations (REQ-DE-20, REQ-DE-21/22/23). SHALL NOT be later than the certificate's issuance date or the verification date; MAY precede the issuance date. |
| 6. ICVPMinVaccineDetails.cn | |
| Requirements | Satisfies REQ-DE-14 (ICVP.C5.DE.14) and contributes to REQ-CC-07. MAY carry the full name of the supervising clinician. Either cn or is (REQ-DE-15) SHALL be present — see invariant must-have-issuer-or-clinician-name on DVCMinVaccineDetails. This is the digital counterpart of the Annex 6 clinician name column, NOT of the wet-ink signature (REQ-CC-08). |
| 8. ICVPMinVaccineDetails.is | |
| Requirements | Satisfies REQ-DE-15 (ICVP.C5.DE.15) and contributes to REQ-CC-07 / REQ-CC-10. MAY carry the identifier of the relevant issuing authority; SHALL correspond to a participant in the GDHCN SMART Trust ValueSet-Participants. Either cn (REQ-DE-14) or is SHALL be present. Certificates intended for international border verification SHOULD populate is — without it, cryptographic verification through the GDHCN is not possible. |
| 10. ICVPMinVaccineDetails.bo | |
| Comments | LOINC 30959-1 'Lot number [Identifier] Vaccine'. |
| Requirements | Satisfies REQ-DE-17 (ICVP.C5.DE.17) and absorbs REQ-DE-18 (DE.18) and REQ-DE-19 (DE.19). SHALL carry the batch (lot) number as recorded by the manufacturer. Where a coded catalogue of batches is available, populate bo with the manufacturer's canonical batch identifier to preserve recall and pharmacovigilance traceability. SHALL NOT be omitted (Coexistence footnote 28). |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ICVPMinVaccineDetails | |
| Definition | Minimal vaccine detail in DVC payload for use within an HCERT Payload using the ICVP Product Catalogue |
| Short | ICVP HCERT Payload |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | must-have-issuer-or-clinician-name: Either issuer or clinicianName must be present (is.exists() or cn.exists()) |
| 2. ICVPMinVaccineDetails.vp | |
| Definition | Vaccine Product ID |
| Short | Vaccine Product ID |
| Comments | LOINC 39236-5; SNOMED CT 787859002. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from WHO ICVP Vaccine Product Ids (required to http://smart.who.int/icvp/ValueSet/ICVPProductIds) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-11 (ICVP.C5.DE.11) and REQ-CC-06. SHALL carry the identifier of the vaccine/prophylaxis product administered. Bound (required) to ICVPProductIds — a product outside this catalogue SHALL be rejected by ICVP.DT.1 / ICVP.DT.2. Disease (REQ-DE-12) and manufacturer (REQ-DE-16) are DERIVED from vp via the ICVP Product Catalogue and are NOT independently populated. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.11 (Vaccine or prophylaxis), LOINC: 39236-5 (Vaccine code), SNOMED CT: 787859002 (Vaccine product (medicinal product)) |
| 4. ICVPMinVaccineDetails.dv | |
| Definition | Date of vaccination |
| Short | Date of vaccination |
| Comments | LOINC 30952-6. |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-13 (ICVP.C5.DE.13). SHALL be the calendar date on which the vaccine/prophylaxis was administered — the anchor for all temporal-validity calculations (REQ-DE-20, REQ-DE-21/22/23). SHALL NOT be later than the certificate's issuance date or the verification date; MAY precede the issuance date. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.13 (Date), LOINC: 30952-6 (Date and time of vaccination) |
| 6. ICVPMinVaccineDetails.cn | |
| Definition | Name of supervising clinician |
| Short | Name of supervising clinician |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-14 (ICVP.C5.DE.14) and contributes to REQ-CC-07. MAY carry the full name of the supervising clinician. Either cn or is (REQ-DE-15) SHALL be present — see invariant must-have-issuer-or-clinician-name on DVCMinVaccineDetails. This is the digital counterpart of the Annex 6 clinician name column, NOT of the wet-ink signature (REQ-CC-08). |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.14 (Name of supervising clinician) |
| 8. ICVPMinVaccineDetails.is | |
| Definition | Certificate issuer id (referenced organization) |
| Short | Certificate issuer id (referenced organization) |
| Control | 0..1 |
| Type | id |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-15 (ICVP.C5.DE.15) and contributes to REQ-CC-07 / REQ-CC-10. MAY carry the identifier of the relevant issuing authority; SHALL correspond to a participant in the GDHCN SMART Trust ValueSet-Participants. Either cn (REQ-DE-14) or is SHALL be present. Certificates intended for international border verification SHOULD populate is — without it, cryptographic verification through the GDHCN is not possible. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.15 (Relevant authority responsible for issuing this certificate) |
| 10. ICVPMinVaccineDetails.bo | |
| Definition | Batch No |
| Short | Batch No |
| Comments | LOINC 30959-1 'Lot number [Identifier] Vaccine'. |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-17 (ICVP.C5.DE.17) and absorbs REQ-DE-18 (DE.18) and REQ-DE-19 (DE.19). SHALL carry the batch (lot) number as recorded by the manufacturer. Where a coded catalogue of batches is available, populate bo with the manufacturer's canonical batch identifier to preserve recall and pharmacovigilance traceability. SHALL NOT be omitted (Coexistence footnote 28). |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.17 (Batch No. of vaccine or prophylaxis), LOINC: 30959-1 (Lot number [Identifier] Vaccine) |