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 ICVPMin logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. ICVPMin | |
| Definition | Minimal 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 |
| 2. ICVPMin.n | |
| Definition | Name |
| Short | Name |
| Comments | LOINC 87226-7 'Legal name of patient - first and last'. Language per REQ-CC-04 (English or French). |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-01 (ICVP.A9.DE.1). SHALL carry the full name of the recipient, transcribed from the identity document used for travel, in the same form and order as it appears on that document. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.A9.DE.1 (Name of the recipient of vaccine or prophylaxis), LOINC: 87226-7 (Legal name of patient - first and last) |
| 4. ICVPMin.dob | |
| Definition | Date of birth |
| Short | Date of birth |
| Comments | LOINC 21112-8; SNOMED CT 184099003. |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-02 (ICVP.A9.DE.2). SHALL be recorded as a fully specified calendar date. Partial dates on identity documents are resolved per national policy. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.A9.DE.2 (Date of Birth), LOINC: 21112-8 (Birth date), SNOMED CT: 184099003 (Date of birth (observable entity)) |
| 6. ICVPMin.s | |
| Definition | Sex |
| Short | Sex |
| Comments | Mapping governed by the ICVP.Core ConceptMap. |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from http://hl7.org/fhir/administrative-gender (extensible to http://hl7.org/fhir/administrative-gender) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-03 (ICVP.A9.DE.3). SHALL record the sex of the recipient. Bound (extensible) to FHIR AdministrativeGender (male/female/other/unknown). Values not in the core set SHALL be mapped to 'unknown' (ICVP.A9.DE.7) for interoperability. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.A9.DE.3 (Sex) |
| 8. ICVPMin.nt | |
| Definition | Nationality |
| Short | Nationality |
| Comments | LOINC 69433-1; SNOMED CT 223369002. |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from Iso316613 (extensible to http://hl7.org/fhir/ValueSet/iso3166-1-3) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-08 (ICVP.A9.DE.8). SHALL record a single ISO 3166-1 alpha-3 country code for the recipient's nationality. Stateless cases handled per national policy. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.A9.DE.8 (Nationality), LOINC: 69433-1 (Citizenship status), SNOMED CT: 223369002 (Country (geographic location)) |
| 10. ICVPMin.id | |
| Definition | National Identification Document |
| Short | National Identification Document |
| Comments | LOINC 76435-7. Pairs with dt (document type). |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-09 (ICVP.A9.DE.9) — document number component. MAY be populated per issuing State Party policy; SHOULD be populated where operationally feasible to support border-control identity binding (Coexistence 'Individual issuance'). Data-protection obligations per IHR Article 45 apply. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.A9.DE.9 (National identification document, if applicable), LOINC: 76435-7 (Patient identifier), SNOMED CT: 900000000000474003 (Universally Unique Identifier (foundation metadata concept)) |
| 12. ICVPMin.dt | |
| Definition | National ID Document Type |
| Short | National ID Document Type |
| Comments | Pairs with id (document number). |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from Hl7VSIdentifierType (3.0.0) (extensible to http://terminology.hl7.org/ValueSet/v2-0203|3.0.0) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-09 (ICVP.A9.DE.9) — document type component. Bound (extensible) to the HL7 v2 identifier-type value set. Resolves Coexistence footnote 23 ambiguity by modelling document type alongside id (document number). |
| 14. ICVPMin.gn | |
| Definition | Parent or Guardian Name |
| Short | Parent or Guardian Name |
| Comments | LOINC 79183-0; SNOMED CT 394619001. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-10 (ICVP.A9.DE.10). SHALL be present when the recipient is a minor or dependent (per issuing State Party policy); otherwise omitted. Where the parent/guardian holds their own travel identity document, record the name as it appears on that document. Wet-ink parent/guardian signature (Annex 6 non-digital) is not applicable — see REQ-CC-08. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.A9.DE.10 (Name of the parent or guardian), LOINC: 79183-0 (First name of Guardian or legally authorized representative), SNOMED CT: 394619001 (Guardian (person)) |
| 16. ICVPMin.vx | |
| Definition | Vaccine Details |
| Short | Vaccine Details |
| Control | 1..1 |
| Type | http://smart.who.int/icvp/StructureDefinition/ICVPMinVaccineDetails |
| Requirements | Satisfies REQ-CC-02 and REQ-CC-03: container for the single vaccine/prophylaxis administration represented by this certificate. Multiple administrations SHALL be issued as separate Digital ICVPs. |
| 18. ICVPMin.v | |
| Definition | Version of the certificate template |
| Short | Version |
| Comments | Unrecognised versions SHOULD be treated as ambiguous, not rejected; verifier MAY fall back to the latest supported version and flag the discrepancy. |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-27 (ICVP.D5.DE.27). SHALL carry a version identifier for the certificate template. Used by verifiers to select the human-readable text template (REQ-DE-24), apply version-appropriate validation logic, and determine compatibility. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.D5.DE.27 (Version) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ICVPMin | |
| Definition | Minimal 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. ICVPMin.n | |
| Comments | LOINC 87226-7 'Legal name of patient - first and last'. Language per REQ-CC-04 (English or French). |
| Requirements | Satisfies REQ-DE-01 (ICVP.A9.DE.1). SHALL carry the full name of the recipient, transcribed from the identity document used for travel, in the same form and order as it appears on that document. |
| 4. ICVPMin.dob | |
| Comments | LOINC 21112-8; SNOMED CT 184099003. |
| Requirements | Satisfies REQ-DE-02 (ICVP.A9.DE.2). SHALL be recorded as a fully specified calendar date. Partial dates on identity documents are resolved per national policy. |
| 6. ICVPMin.s | |
| Comments | Mapping governed by the ICVP.Core ConceptMap. |
| Requirements | Satisfies REQ-DE-03 (ICVP.A9.DE.3). SHALL record the sex of the recipient. Bound (extensible) to FHIR AdministrativeGender (male/female/other/unknown). Values not in the core set SHALL be mapped to 'unknown' (ICVP.A9.DE.7) for interoperability. |
| 8. ICVPMin.nt | |
| Comments | LOINC 69433-1; SNOMED CT 223369002. |
| Requirements | Satisfies REQ-DE-08 (ICVP.A9.DE.8). SHALL record a single ISO 3166-1 alpha-3 country code for the recipient's nationality. Stateless cases handled per national policy. |
| 10. ICVPMin.id | |
| Comments | LOINC 76435-7. Pairs with dt (document type). |
| Requirements | Satisfies REQ-DE-09 (ICVP.A9.DE.9) — document number component. MAY be populated per issuing State Party policy; SHOULD be populated where operationally feasible to support border-control identity binding (Coexistence 'Individual issuance'). Data-protection obligations per IHR Article 45 apply. |
| 12. ICVPMin.dt | |
| Comments | Pairs with id (document number). |
| Requirements | Satisfies REQ-DE-09 (ICVP.A9.DE.9) — document type component. Bound (extensible) to the HL7 v2 identifier-type value set. Resolves Coexistence footnote 23 ambiguity by modelling document type alongside id (document number). |
| 14. ICVPMin.gn | |
| Comments | LOINC 79183-0; SNOMED CT 394619001. |
| Requirements | Satisfies REQ-DE-10 (ICVP.A9.DE.10). SHALL be present when the recipient is a minor or dependent (per issuing State Party policy); otherwise omitted. Where the parent/guardian holds their own travel identity document, record the name as it appears on that document. Wet-ink parent/guardian signature (Annex 6 non-digital) is not applicable — see REQ-CC-08. |
| 16. ICVPMin.vx | |
| Type | http://smart.who.int/icvp/StructureDefinition/ICVPMinVaccineDetails |
| Requirements | Satisfies REQ-CC-02 and REQ-CC-03: container for the single vaccine/prophylaxis administration represented by this certificate. Multiple administrations SHALL be issued as separate Digital ICVPs. |
| 18. ICVPMin.v | |
| Comments | Unrecognised versions SHOULD be treated as ambiguous, not rejected; verifier MAY fall back to the latest supported version and flag the discrepancy. |
| Requirements | Satisfies REQ-DE-27 (ICVP.D5.DE.27). SHALL carry a version identifier for the certificate template. Used by verifiers to select the human-readable text template (REQ-DE-24), apply version-appropriate validation logic, and determine compatibility. |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ICVPMin | |
| Definition | Minimal 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 |
| 2. ICVPMin.n | |
| Definition | Name |
| Short | Name |
| Comments | LOINC 87226-7 'Legal name of patient - first and last'. Language per REQ-CC-04 (English or French). |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-01 (ICVP.A9.DE.1). SHALL carry the full name of the recipient, transcribed from the identity document used for travel, in the same form and order as it appears on that document. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.A9.DE.1 (Name of the recipient of vaccine or prophylaxis), LOINC: 87226-7 (Legal name of patient - first and last) |
| 4. ICVPMin.dob | |
| Definition | Date of birth |
| Short | Date of birth |
| Comments | LOINC 21112-8; SNOMED CT 184099003. |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-02 (ICVP.A9.DE.2). SHALL be recorded as a fully specified calendar date. Partial dates on identity documents are resolved per national policy. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.A9.DE.2 (Date of Birth), LOINC: 21112-8 (Birth date), SNOMED CT: 184099003 (Date of birth (observable entity)) |
| 6. ICVPMin.s | |
| Definition | Sex |
| Short | Sex |
| Comments | Mapping governed by the ICVP.Core ConceptMap. |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from http://hl7.org/fhir/administrative-gender (extensible to http://hl7.org/fhir/administrative-gender) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-03 (ICVP.A9.DE.3). SHALL record the sex of the recipient. Bound (extensible) to FHIR AdministrativeGender (male/female/other/unknown). Values not in the core set SHALL be mapped to 'unknown' (ICVP.A9.DE.7) for interoperability. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.A9.DE.3 (Sex) |
| 8. ICVPMin.nt | |
| Definition | Nationality |
| Short | Nationality |
| Comments | LOINC 69433-1; SNOMED CT 223369002. |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from Iso316613 (extensible to http://hl7.org/fhir/ValueSet/iso3166-1-3) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-08 (ICVP.A9.DE.8). SHALL record a single ISO 3166-1 alpha-3 country code for the recipient's nationality. Stateless cases handled per national policy. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.A9.DE.8 (Nationality), LOINC: 69433-1 (Citizenship status), SNOMED CT: 223369002 (Country (geographic location)) |
| 10. ICVPMin.id | |
| Definition | National Identification Document |
| Short | National Identification Document |
| Comments | LOINC 76435-7. Pairs with dt (document type). |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-09 (ICVP.A9.DE.9) — document number component. MAY be populated per issuing State Party policy; SHOULD be populated where operationally feasible to support border-control identity binding (Coexistence 'Individual issuance'). Data-protection obligations per IHR Article 45 apply. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.A9.DE.9 (National identification document, if applicable), LOINC: 76435-7 (Patient identifier), SNOMED CT: 900000000000474003 (Universally Unique Identifier (foundation metadata concept)) |
| 12. ICVPMin.dt | |
| Definition | National ID Document Type |
| Short | National ID Document Type |
| Comments | Pairs with id (document number). |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from Hl7VSIdentifierType (3.0.0) (extensible to http://terminology.hl7.org/ValueSet/v2-0203|3.0.0) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-09 (ICVP.A9.DE.9) — document type component. Bound (extensible) to the HL7 v2 identifier-type value set. Resolves Coexistence footnote 23 ambiguity by modelling document type alongside id (document number). |
| 14. ICVPMin.gn | |
| Definition | Parent or Guardian Name |
| Short | Parent or Guardian Name |
| Comments | LOINC 79183-0; SNOMED CT 394619001. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-10 (ICVP.A9.DE.10). SHALL be present when the recipient is a minor or dependent (per issuing State Party policy); otherwise omitted. Where the parent/guardian holds their own travel identity document, record the name as it appears on that document. Wet-ink parent/guardian signature (Annex 6 non-digital) is not applicable — see REQ-CC-08. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.A9.DE.10 (Name of the parent or guardian), LOINC: 79183-0 (First name of Guardian or legally authorized representative), SNOMED CT: 394619001 (Guardian (person)) |
| 16. ICVPMin.vx | |
| Definition | Vaccine Details |
| Short | Vaccine Details |
| Control | 1..1 |
| Type | http://smart.who.int/icvp/StructureDefinition/ICVPMinVaccineDetails |
| Requirements | Satisfies REQ-CC-02 and REQ-CC-03: container for the single vaccine/prophylaxis administration represented by this certificate. Multiple administrations SHALL be issued as separate Digital ICVPs. |
| 18. ICVPMin.v | |
| Definition | Version of the certificate template |
| Short | Version |
| Comments | Unrecognised versions SHOULD be treated as ambiguous, not rejected; verifier MAY fall back to the latest supported version and flag the discrepancy. |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Requirements | Satisfies REQ-DE-27 (ICVP.D5.DE.27). SHALL carry a version identifier for the certificate template. Used by verifiers to select the human-readable text template (REQ-DE-24), apply version-appropriate validation logic, and determine compatibility. |
| Definitional Codes | ICVP.Core CodeSystem for Data Elements: ICVP.D5.DE.27 (Version) |