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/ and changes regularly. See the Directory of published versions
Logical Model: ICVP Vaccine Details with Selective Disclosure
| Official URL: http://smart.who.int/icvp/StructureDefinition/ICVPVaccineDetailsSD | Version: 0.1.0 | |||
| Draft as of 2025-08-19 | Computable Name: ICVPVaccineDetailsSD | |||
ICVP Vaccine Details with Selective Disclosure
Usages:
- Use this Logical Model Profile: DVC Icvp with Selective Disclosure
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..* | ICVPVaccineDetails | Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID, productID ICVP - Vaccine Details Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician |
  productID |
C | 1..1 | Coding | Vaccine Product Constraints: is-a-prequal-product-id, is-an-icvp-product-id |
 date |
1..1 | date | Date | |
  issuer |
0..1 | Reference(Organization) | Issuing Organization | |
 @id |
0..1 | string | Unique id for inter-element referencing | |
 Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
  extension:SelectiveDisclosure |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
 display |
Σ | 0..1 | string | Text alternative for the resource |
| clinicianName |
0..1 | string | Name of supervising clinician | |
| @id |
0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:SelectiveDisclosure |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
| @value |
0..1 | string | Primitive value for string Max Length:1048576 | |
| batchNo |
1..1 | CodeableConcept | Batch No | |
| validityPeriod |
0..1 | Period | Certificate validity period | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| ICVPVaccineDetails.issuer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| is-a-prequal-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the PreQual Databatase : system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIDs' | |
| is-an-icvp-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the ICVP vaccines from the PreQual Databatase : system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIDs' | |
| must-have-issuer-or-clinician | error | ICVPVaccineDetails | Either issuer or clinicianName must be present : issuer.exists() or clinicianName.exists() |
This structure is derived from ICVPVaccineDetails
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVPVaccineDetails |
ICVPVaccineDetails | Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID, productID Instances of this logical model can be the target of a Reference | ||
| issuer |
||||
  Slices for extension |
Content/Rules for all slices | |||
 extension:SelectiveDisclosure |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
| clinicianName |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:SelectiveDisclosure |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVPVaccineDetails |
C | 0..* | ICVPVaccineDetails | Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID, productID ICVP - Vaccine Details Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician |
| productID |
C | 1..1 | Coding | Vaccine Product Constraints: is-a-prequal-product-id, is-an-icvp-product-id |
| date |
1..1 | date | Date | |
| issuer |
0..1 | Reference(Organization) | Issuing Organization | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:SelectiveDisclosure |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display |
Σ | 0..1 | string | Text alternative for the resource |
| clinicianName |
0..1 | string | Name of supervising clinician | |
| @id |
0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:SelectiveDisclosure |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
| @value |
0..1 | string | Primitive value for string Max Length:1048576 | |
| batchNo |
1..1 | CodeableConcept | Batch No | |
| validityPeriod |
0..1 | Period | Certificate validity period | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| ICVPVaccineDetails.issuer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| is-a-prequal-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the PreQual Databatase : system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIDs' | |
| is-an-icvp-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the ICVP vaccines from the PreQual Databatase : system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIDs' | |
| must-have-issuer-or-clinician | error | ICVPVaccineDetails | Either issuer or clinicianName must be present : issuer.exists() or clinicianName.exists() |
This structure is derived from ICVPVaccineDetails
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVPVaccineDetails |
C | 0..* | ICVPVaccineDetails | Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID, productID ICVP - Vaccine Details Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician |
| productID |
C | 1..1 | Coding | Vaccine Product Constraints: is-a-prequal-product-id, is-an-icvp-product-id |
| date |
1..1 | date | Date | |
| issuer |
0..1 | Reference(Organization) | Issuing Organization | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:SelectiveDisclosure |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display |
Σ | 0..1 | string | Text alternative for the resource |
| clinicianName |
0..1 | string | Name of supervising clinician | |
| @id |
0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:SelectiveDisclosure |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
| @value |
0..1 | string | Primitive value for string Max Length:1048576 | |
| batchNo |
1..1 | CodeableConcept | Batch No | |
| validityPeriod |
0..1 | Period | Certificate validity period | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| ICVPVaccineDetails.issuer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| is-a-prequal-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the PreQual Databatase : system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIDs' | |
| is-an-icvp-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the ICVP vaccines from the PreQual Databatase : system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIDs' | |
| must-have-issuer-or-clinician | error | ICVPVaccineDetails | Either issuer or clinicianName must be present : issuer.exists() or clinicianName.exists() |
Differential View
This structure is derived from ICVPVaccineDetails
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVPVaccineDetails |
ICVPVaccineDetails | Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID, productID Instances of this logical model can be the target of a Reference | ||
| issuer |
||||
| Slices for extension |
Content/Rules for all slices | |||
| extension:SelectiveDisclosure |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
| clinicianName |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:SelectiveDisclosure |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVPVaccineDetails |
C | 0..* | ICVPVaccineDetails | Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID, productID ICVP - Vaccine Details Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician |
| productID |
C | 1..1 | Coding | Vaccine Product Constraints: is-a-prequal-product-id, is-an-icvp-product-id |
| date |
1..1 | date | Date | |
| issuer |
0..1 | Reference(Organization) | Issuing Organization | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:SelectiveDisclosure |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display |
Σ | 0..1 | string | Text alternative for the resource |
| clinicianName |
0..1 | string | Name of supervising clinician | |
| @id |
0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:SelectiveDisclosure |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
| @value |
0..1 | string | Primitive value for string Max Length:1048576 | |
| batchNo |
1..1 | CodeableConcept | Batch No | |
| validityPeriod |
0..1 | Period | Certificate validity period | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| ICVPVaccineDetails.issuer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| is-a-prequal-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the PreQual Databatase : system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIDs' | |
| is-an-icvp-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the ICVP vaccines from the PreQual Databatase : system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIDs' | |
| must-have-issuer-or-clinician | error | ICVPVaccineDetails | Either issuer or clinicianName must be present : issuer.exists() or clinicianName.exists() |
This structure is derived from ICVPVaccineDetails