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.
Logical Model: ICVP ( Experimental )
| Official URL: http://smart.who.int/icvp/StructureDefinition/ICVP | Version: 0.3.0 | |||
| Active as of 2026-04-16 | Computable Name: ICVP | |||
Data elements for the Model International Certificate of Vaccination or Prophylaxis.
Usages:
- Derived from this Logical Model: ICVP (single) and pICVP
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:   |
|---|---|---|---|---|
  ICVP |
C | 0..* | DVCPreQual | ICVP Elements defined in Ancestors:name, dob, sex, nationality, nid, guardian, disease, integrityCheck, vaccineDetails, version, vaccineDetails Instances of this logical model can be the target of a Reference Constraints: nid-must-have-value |
  name |
1..1 | string | Name of the recipient of vaccine or prophylaxis | |
| dob |
1..1 | date | Date of Birth | |
| sex |
1..1 | code | Sex Binding: http://hl7.org/fhir/administrative-gender (extensible) | |
 nationality |
1..1 | Coding | Nationality Binding: Iso316613 (extensible) | |
 nid |
C | 1..1 | Identifier | National Identification Document, if applicable Constraints: ident-1 |
 @id |
0..1 | id | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system |
Σ | 0..1 | uri | The namespace for the identifier value Binding: Hl7VSIdentifierType (3.0.0) (extensible) Example General: http://www.acme.com/identifiers/patient |
| value |
ΣC | 0..1 | string | The value that is unique Example General: 123456 |
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use |
  assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| guardian |
0..1 | string | Name of the parent or guardian. Required, if applicable | |
| disease |
1..* | Coding | Name of disease or condition Binding: http://id.who.int/icd/release/11/mms (extensible) | |
| integrityCheck |
0..* | BackboneElement | Integrity check value | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| cryptographicSignature |
1..1 | string | Cryptographic signature of the issuer | |
| kid |
1..1 | string | Key identifier for signature verification | |
 vaccineDetails |
1..* | ICVPVaccineDetails | Vaccine Details | |
| version |
1..1 | string | Version Fixed Value: 0.1.0 | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| ICVP.sex | Base | extensible | http://hl7.org/fhir/administrative-gender | Not State | Unknown |
| ICVP.nationality | Base | extensible | Iso 3166 Part 1: 3 Letter Codes | 📦5.0.0 | FHIR Std. |
| ICVP.nid.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| ICVP.nid.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| ICVP.nid.system | Base | extensible | hl7VS-identifierType | 📍3.0.0 | THO v7.1 |
| ICVP.disease | Base | extensible | http://id.who.int/icd/release/11/mms | Not State | Unknown |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ident-1 | warning | ICVP.nid | Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason |
value.exists()
|
| nid-must-have-value | error | ICVP | If National ID is present, it must have a value and a system |
nid.empty() or (nid.value.exists() and nid.system.exists())
|
This structure is derived from DVCPreQual
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVP |
0..* | DVCPreQual | ICVP Elements defined in Ancestors:name, dob, sex, nationality, nid, guardian, disease, integrityCheck, vaccineDetails, version, vaccineDetails Instances of this logical model can be the target of a Reference | |
| nationality |
1..1 | Coding | Nationality | |
| nid |
1..1 | Identifier | National Identification Document, if applicable | |
| vaccineDetails |
1..* | ICVPVaccineDetails | Vaccine Details | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVP |
C | 0..* | DVCPreQual | ICVP Elements defined in Ancestors:name, dob, sex, nationality, nid, guardian, disease, integrityCheck, vaccineDetails, version, vaccineDetails Instances of this logical model can be the target of a Reference Constraints: nid-must-have-value |
| name |
1..1 | string | Name of the recipient of vaccine or prophylaxis | |
| dob |
1..1 | date | Date of Birth | |
| sex |
1..1 | code | Sex Binding: http://hl7.org/fhir/administrative-gender (extensible) | |
| nationality |
1..1 | Coding | Nationality Binding: Iso316613 (extensible) | |
| nid |
C | 1..1 | Identifier | National Identification Document, if applicable Constraints: ident-1 |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system |
Σ | 0..1 | uri | The namespace for the identifier value Binding: Hl7VSIdentifierType (3.0.0) (extensible) Example General: http://www.acme.com/identifiers/patient |
| value |
ΣC | 0..1 | string | The value that is unique Example General: 123456 |
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| guardian |
0..1 | string | Name of the parent or guardian. Required, if applicable | |
| disease |
1..* | Coding | Name of disease or condition Binding: http://id.who.int/icd/release/11/mms (extensible) | |
| integrityCheck |
0..* | BackboneElement | Integrity check value | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| cryptographicSignature |
1..1 | string | Cryptographic signature of the issuer | |
| kid |
1..1 | string | Key identifier for signature verification | |
| vaccineDetails |
1..* | ICVPVaccineDetails | Vaccine Details | |
| version |
1..1 | string | Version Fixed Value: 0.1.0 | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| ICVP.sex | Base | extensible | http://hl7.org/fhir/administrative-gender | Not State | Unknown |
| ICVP.nationality | Base | extensible | Iso 3166 Part 1: 3 Letter Codes | 📦5.0.0 | FHIR Std. |
| ICVP.nid.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| ICVP.nid.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| ICVP.nid.system | Base | extensible | hl7VS-identifierType | 📍3.0.0 | THO v7.1 |
| ICVP.disease | Base | extensible | http://id.who.int/icd/release/11/mms | Not State | Unknown |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ident-1 | warning | ICVP.nid | Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason |
value.exists()
|
| nid-must-have-value | error | ICVP | If National ID is present, it must have a value and a system |
nid.empty() or (nid.value.exists() and nid.system.exists())
|
This structure is derived from DVCPreQual
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVP |
C | 0..* | DVCPreQual | ICVP Elements defined in Ancestors:name, dob, sex, nationality, nid, guardian, disease, integrityCheck, vaccineDetails, version, vaccineDetails Instances of this logical model can be the target of a Reference Constraints: nid-must-have-value |
| name |
1..1 | string | Name of the recipient of vaccine or prophylaxis | |
| dob |
1..1 | date | Date of Birth | |
| sex |
1..1 | code | Sex Binding: http://hl7.org/fhir/administrative-gender (extensible) | |
| nationality |
1..1 | Coding | Nationality Binding: Iso316613 (extensible) | |
| nid |
C | 1..1 | Identifier | National Identification Document, if applicable Constraints: ident-1 |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system |
Σ | 0..1 | uri | The namespace for the identifier value Binding: Hl7VSIdentifierType (3.0.0) (extensible) Example General: http://www.acme.com/identifiers/patient |
| value |
ΣC | 0..1 | string | The value that is unique Example General: 123456 |
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| guardian |
0..1 | string | Name of the parent or guardian. Required, if applicable | |
| disease |
1..* | Coding | Name of disease or condition Binding: http://id.who.int/icd/release/11/mms (extensible) | |
| integrityCheck |
0..* | BackboneElement | Integrity check value | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| cryptographicSignature |
1..1 | string | Cryptographic signature of the issuer | |
| kid |
1..1 | string | Key identifier for signature verification | |
| vaccineDetails |
1..* | ICVPVaccineDetails | Vaccine Details | |
| version |
1..1 | string | Version Fixed Value: 0.1.0 | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| ICVP.sex | Base | extensible | http://hl7.org/fhir/administrative-gender | Not State | Unknown |
| ICVP.nationality | Base | extensible | Iso 3166 Part 1: 3 Letter Codes | 📦5.0.0 | FHIR Std. |
| ICVP.nid.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| ICVP.nid.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| ICVP.nid.system | Base | extensible | hl7VS-identifierType | 📍3.0.0 | THO v7.1 |
| ICVP.disease | Base | extensible | http://id.who.int/icd/release/11/mms | Not State | Unknown |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ident-1 | warning | ICVP.nid | Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason |
value.exists()
|
| nid-must-have-value | error | ICVP | If National ID is present, it must have a value and a system |
nid.empty() or (nid.value.exists() and nid.system.exists())
|
Differential View
This structure is derived from DVCPreQual
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVP |
0..* | DVCPreQual | ICVP Elements defined in Ancestors:name, dob, sex, nationality, nid, guardian, disease, integrityCheck, vaccineDetails, version, vaccineDetails Instances of this logical model can be the target of a Reference | |
| nationality |
1..1 | Coding | Nationality | |
| nid |
1..1 | Identifier | National Identification Document, if applicable | |
| vaccineDetails |
1..* | ICVPVaccineDetails | Vaccine Details | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVP |
C | 0..* | DVCPreQual | ICVP Elements defined in Ancestors:name, dob, sex, nationality, nid, guardian, disease, integrityCheck, vaccineDetails, version, vaccineDetails Instances of this logical model can be the target of a Reference Constraints: nid-must-have-value |
| name |
1..1 | string | Name of the recipient of vaccine or prophylaxis | |
| dob |
1..1 | date | Date of Birth | |
| sex |
1..1 | code | Sex Binding: http://hl7.org/fhir/administrative-gender (extensible) | |
| nationality |
1..1 | Coding | Nationality Binding: Iso316613 (extensible) | |
| nid |
C | 1..1 | Identifier | National Identification Document, if applicable Constraints: ident-1 |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system |
Σ | 0..1 | uri | The namespace for the identifier value Binding: Hl7VSIdentifierType (3.0.0) (extensible) Example General: http://www.acme.com/identifiers/patient |
| value |
ΣC | 0..1 | string | The value that is unique Example General: 123456 |
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| guardian |
0..1 | string | Name of the parent or guardian. Required, if applicable | |
| disease |
1..* | Coding | Name of disease or condition Binding: http://id.who.int/icd/release/11/mms (extensible) | |
| integrityCheck |
0..* | BackboneElement | Integrity check value | |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| cryptographicSignature |
1..1 | string | Cryptographic signature of the issuer | |
| kid |
1..1 | string | Key identifier for signature verification | |
| vaccineDetails |
1..* | ICVPVaccineDetails | Vaccine Details | |
| version |
1..1 | string | Version Fixed Value: 0.1.0 | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| ICVP.sex | Base | extensible | http://hl7.org/fhir/administrative-gender | Not State | Unknown |
| ICVP.nationality | Base | extensible | Iso 3166 Part 1: 3 Letter Codes | 📦5.0.0 | FHIR Std. |
| ICVP.nid.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| ICVP.nid.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| ICVP.nid.system | Base | extensible | hl7VS-identifierType | 📍3.0.0 | THO v7.1 |
| ICVP.disease | Base | extensible | http://id.who.int/icd/release/11/mms | Not State | Unknown |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ident-1 | warning | ICVP.nid | Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason |
value.exists()
|
| nid-must-have-value | error | ICVP | If National ID is present, it must have a value and a system |
nid.empty() or (nid.value.exists() and nid.system.exists())
|
This structure is derived from DVCPreQual