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 - Vaccine Details ( Experimental )
| Official URL: http://smart.who.int/icvp/StructureDefinition/ICVPVaccineDetails | Version: 0.3.0 | |||
| Active as of 2026-04-16 | 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
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..* | DVCVaccineDetailsPreQual | ICVP - Vaccine Details Elements defined in Ancestors:vaccine[x], date, issuer, clinicianName, manufacturer, batchNo, validity, vaccine[x] Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician, period-from-until-must-be-present-and-valid |
  vaccine[x] |
C | 1..1 | Reference(WHO Vaccine PreQual DB - Finished Vaccine Products) | Vaccine or prophylaxis Constraints: vaccine-reference-must-exist |
   @id |
0..1 | id | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
 identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
| @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 Example General: http://www.acme.com/identifiers/patient |
| value |
ΣC | 0..1 | string | The value that is unique Binding: WHO ICVP Vaccine Product Ids (required) 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) |
| display |
ΣC | 0..1 | string | Text alternative for the resource |
| date |
1..1 | date | Date | |
| issuer |
0..1 | Reference(Organization) | Relevant authority responsible for issuing this certificate | |
| clinicianName |
0..1 | string | Name of supervising clinician | |
| manufacturer |
1..1 | Reference(Organization) | Manufacturer of vaccine or prophylaxis | |
| batchNo |
1..1 | CodeableConcept | Batch No. of vaccine or prophylaxis | |
| validity |
1..1 | Period | Certificate valid from... until... | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| ICVPVaccineDetails.vaccine[x].type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| ICVPVaccineDetails.vaccine[x].identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| ICVPVaccineDetails.vaccine[x].identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| ICVPVaccineDetails.vaccine[x].identifier.value | Base | required | WHO ICVP Vaccine Product Ids | 📦0.3.0 | This IG |
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()
|
| must-have-issuer-or-clinician | error | ICVPVaccineDetails | Either issuer or clinicianName must be present |
issuer.exists() or clinicianName.exists()
|
| period-from-until-must-be-present-and-valid | error | ICVPVaccineDetails | If period is present, both start and end must be present, and start must be before end |
validity.start.exists() and (validity.end.exists() implies validity.start <= validity.end)
|
| vaccine-reference-must-exist | error | ICVPVaccineDetails.vaccine[x] | The vaccine reference must point to a resource that exists |
vaccineReference.reference.exists() implies vaccineReference.resolve().exists()
|
This structure is derived from DVCVaccineDetailsPreQual
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVPVaccineDetails |
0..* | DVCVaccineDetailsPreQual | ICVP - Vaccine Details Elements defined in Ancestors:vaccine[x], date, issuer, clinicianName, manufacturer, batchNo, validity, vaccine[x] Instances of this logical model can be the target of a Reference | |
 vaccine[x] |
||||
 identifier |
||||
| value |
0..1 | string | The value that is unique Binding: WHO ICVP Vaccine Product Ids (required) | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| ICVPVaccineDetails.vaccine[x].identifier.value | Base | required | WHO ICVP Vaccine Product Ids | 📦0.3.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVPVaccineDetails |
C | 0..* | DVCVaccineDetailsPreQual | ICVP - Vaccine Details Elements defined in Ancestors:vaccine[x], date, issuer, clinicianName, manufacturer, batchNo, validity, vaccine[x] Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician, period-from-until-must-be-present-and-valid |
| vaccine[x] |
C | 1..1 | Reference(WHO Vaccine PreQual DB - Finished Vaccine Products) | Vaccine or prophylaxis Constraints: vaccine-reference-must-exist |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
| @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 Example General: http://www.acme.com/identifiers/patient |
| value |
ΣC | 0..1 | string | The value that is unique Binding: WHO ICVP Vaccine Product Ids (required) 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) |
| display |
ΣC | 0..1 | string | Text alternative for the resource |
| date |
1..1 | date | Date | |
| issuer |
0..1 | Reference(Organization) | Relevant authority responsible for issuing this certificate | |
| clinicianName |
0..1 | string | Name of supervising clinician | |
| manufacturer |
1..1 | Reference(Organization) | Manufacturer of vaccine or prophylaxis | |
| batchNo |
1..1 | CodeableConcept | Batch No. of vaccine or prophylaxis | |
| validity |
1..1 | Period | Certificate valid from... until... | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| ICVPVaccineDetails.vaccine[x].type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| ICVPVaccineDetails.vaccine[x].identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| ICVPVaccineDetails.vaccine[x].identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| ICVPVaccineDetails.vaccine[x].identifier.value | Base | required | WHO ICVP Vaccine Product Ids | 📦0.3.0 | This IG |
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()
|
| must-have-issuer-or-clinician | error | ICVPVaccineDetails | Either issuer or clinicianName must be present |
issuer.exists() or clinicianName.exists()
|
| period-from-until-must-be-present-and-valid | error | ICVPVaccineDetails | If period is present, both start and end must be present, and start must be before end |
validity.start.exists() and (validity.end.exists() implies validity.start <= validity.end)
|
| vaccine-reference-must-exist | error | ICVPVaccineDetails.vaccine[x] | The vaccine reference must point to a resource that exists |
vaccineReference.reference.exists() implies vaccineReference.resolve().exists()
|
This structure is derived from DVCVaccineDetailsPreQual
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVPVaccineDetails |
C | 0..* | DVCVaccineDetailsPreQual | ICVP - Vaccine Details Elements defined in Ancestors:vaccine[x], date, issuer, clinicianName, manufacturer, batchNo, validity, vaccine[x] Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician, period-from-until-must-be-present-and-valid |
| vaccine[x] |
C | 1..1 | Reference(WHO Vaccine PreQual DB - Finished Vaccine Products) | Vaccine or prophylaxis Constraints: vaccine-reference-must-exist |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
| @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 Example General: http://www.acme.com/identifiers/patient |
| value |
ΣC | 0..1 | string | The value that is unique Binding: WHO ICVP Vaccine Product Ids (required) 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) |
| display |
ΣC | 0..1 | string | Text alternative for the resource |
| date |
1..1 | date | Date | |
| issuer |
0..1 | Reference(Organization) | Relevant authority responsible for issuing this certificate | |
| clinicianName |
0..1 | string | Name of supervising clinician | |
| manufacturer |
1..1 | Reference(Organization) | Manufacturer of vaccine or prophylaxis | |
| batchNo |
1..1 | CodeableConcept | Batch No. of vaccine or prophylaxis | |
| validity |
1..1 | Period | Certificate valid from... until... | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| ICVPVaccineDetails.vaccine[x].type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| ICVPVaccineDetails.vaccine[x].identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| ICVPVaccineDetails.vaccine[x].identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| ICVPVaccineDetails.vaccine[x].identifier.value | Base | required | WHO ICVP Vaccine Product Ids | 📦0.3.0 | This IG |
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()
|
| must-have-issuer-or-clinician | error | ICVPVaccineDetails | Either issuer or clinicianName must be present |
issuer.exists() or clinicianName.exists()
|
| period-from-until-must-be-present-and-valid | error | ICVPVaccineDetails | If period is present, both start and end must be present, and start must be before end |
validity.start.exists() and (validity.end.exists() implies validity.start <= validity.end)
|
| vaccine-reference-must-exist | error | ICVPVaccineDetails.vaccine[x] | The vaccine reference must point to a resource that exists |
vaccineReference.reference.exists() implies vaccineReference.resolve().exists()
|
Differential View
This structure is derived from DVCVaccineDetailsPreQual
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVPVaccineDetails |
0..* | DVCVaccineDetailsPreQual | ICVP - Vaccine Details Elements defined in Ancestors:vaccine[x], date, issuer, clinicianName, manufacturer, batchNo, validity, vaccine[x] Instances of this logical model can be the target of a Reference | |
| vaccine[x] |
||||
| identifier |
||||
| value |
0..1 | string | The value that is unique Binding: WHO ICVP Vaccine Product Ids (required) | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| ICVPVaccineDetails.vaccine[x].identifier.value | Base | required | WHO ICVP Vaccine Product Ids | 📦0.3.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVPVaccineDetails |
C | 0..* | DVCVaccineDetailsPreQual | ICVP - Vaccine Details Elements defined in Ancestors:vaccine[x], date, issuer, clinicianName, manufacturer, batchNo, validity, vaccine[x] Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician, period-from-until-must-be-present-and-valid |
| vaccine[x] |
C | 1..1 | Reference(WHO Vaccine PreQual DB - Finished Vaccine Products) | Vaccine or prophylaxis Constraints: vaccine-reference-must-exist |
| @id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
| @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 Example General: http://www.acme.com/identifiers/patient |
| value |
ΣC | 0..1 | string | The value that is unique Binding: WHO ICVP Vaccine Product Ids (required) 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) |
| display |
ΣC | 0..1 | string | Text alternative for the resource |
| date |
1..1 | date | Date | |
| issuer |
0..1 | Reference(Organization) | Relevant authority responsible for issuing this certificate | |
| clinicianName |
0..1 | string | Name of supervising clinician | |
| manufacturer |
1..1 | Reference(Organization) | Manufacturer of vaccine or prophylaxis | |
| batchNo |
1..1 | CodeableConcept | Batch No. of vaccine or prophylaxis | |
| validity |
1..1 | Period | Certificate valid from... until... | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| ICVPVaccineDetails.vaccine[x].type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| ICVPVaccineDetails.vaccine[x].identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| ICVPVaccineDetails.vaccine[x].identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| ICVPVaccineDetails.vaccine[x].identifier.value | Base | required | WHO ICVP Vaccine Product Ids | 📦0.3.0 | This IG |
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()
|
| must-have-issuer-or-clinician | error | ICVPVaccineDetails | Either issuer or clinicianName must be present |
issuer.exists() or clinicianName.exists()
|
| period-from-until-must-be-present-and-valid | error | ICVPVaccineDetails | If period is present, both start and end must be present, and start must be before end |
validity.start.exists() and (validity.end.exists() implies validity.start <= validity.end)
|
| vaccine-reference-must-exist | error | ICVPVaccineDetails.vaccine[x] | The vaccine reference must point to a resource that exists |
vaccineReference.reference.exists() implies vaccineReference.resolve().exists()
|
This structure is derived from DVCVaccineDetailsPreQual