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/main and changes regularly. See the Directory of published versions
| Official URL: http://smart.who.int/icvp/StructureDefinition/ICVPVaccineDetailsSD | Version: 0.3.0 | |||
| Active as of 2025-10-30 | Computable Name: ICVPVaccineDetailsSD | |||
ICVP Vaccine Details with Selective Disclosure
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | ICVPVaccineDetails | ICVP - Vaccine Details Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician |
![]() ![]() |
C | 1..1 | Coding | Vaccine Product Constraints: is-a-prequal-product-id, is-an-icvp-product-id |
![]() ![]() |
1..1 | date | Date | |
![]() ![]() |
0..1 | Reference(Organization) | Issuing Organization | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
Σ | 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). |
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() |
0..1 | string | Name of supervising clinician | |
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |
![]() ![]() |
1..1 | CodeableConcept | Batch No | |
![]() ![]() |
0..1 | Period | Certificate validity period | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ICVPVaccineDetails.issuer.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| 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()
|
| is-a-prequal-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the PreQual Database |
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()
|
ICVP Vaccine Details with Selective Disclosure
Version: 1.0.0
This endpoint serves the JSON Schema definition for the Logical Model StructureDefinition-ICVPVaccineDetailsSD.
Description: ICVP Vaccine Details with Selective Disclosure
Type: object
Schema ID: http://smart.who.int/base/StructureDefinition-ICVPVaccineDetailsSD.schema.json
Required fields: resourceType, productID, date, batchNo
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "http://smart.who.int/base/StructureDefinition-ICVPVaccineDetailsSD.schema.json",
"title": "ICVP Vaccine Details with Selective Disclosure",
"description": "ICVP Vaccine Details with Selective Disclosure",
"type": "object",
"properties": {
"resourceType": {
"type": "string",
"const": "ICVPVaccineDetailsSD",
"description": "Resource type identifier for ICVPVaccineDetailsSD logical model"
},
"@context": {
"description": "JSON-LD context for this logical model with ValueSet vocabularies",
"anyOf": [
{
"type": "string",
"format": "uri",
"description": "URI reference to external JSON-LD context"
},
{
"type": "object",
"description": "Inline JSON-LD context",
"properties": {
"@version": {
"type": "number",
"const": 1.1
},
"fhir": {
"type": "string",
"const": "http://hl7.org/fhir/"
}
},
"additionalProperties": {
"type": "string",
"format": "uri"
}
},
{
"type": "array",
"description": "Array of JSON-LD context objects/URIs",
"items": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "object"
}
]
}
}
]
},
"@type": {
"type": "string",
"description": "JSON-LD type identifier for ICVPVaccineDetailsSD logical model",
"examples": [
"LogicalModel-ICVPVaccineDetailsSD"
]
},
"ICVPVaccineDetails": {
"type": "array",
"items": {
"type": "object",
"description": "FHIR "
},
"description": "Vaccine Data elements for the International Certificate of Vaccination or Prophylaxis"
},
"productID": {
"type": "object",
"description": "Vaccine product information (note: use InventoryItem in FHIR R6)"
},
"date": {
"type": "string",
"format": "date",
"description": "Date of vaccine"
},
"issuer": {
"type": "object",
"description": "Relevant authoring reponsible for issuing the certificate, or for overseeing the administration center"
},
"id": {
"type": "object",
"description": "unique id for the element within a resource (for internal references)"
},
"reference": {
"type": "string",
"description": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources."
},
"type": {
"type": "string",
"format": "uri",
"description": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources)."
},
"identifier": {
"type": "object",
"description": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference."
},
"display": {
"type": "string",
"description": "Plain text narrative that identifies the resource in addition to the resource reference."
},
"clinicianName": {
"type": "string",
"description": "Name of supervising clinician, or relevant authority responsible for issuing this certificate, or for overseeing the administering centre"
},
"value": {
"type": "object",
"description": "The actual value"
},
"batchNo": {
"type": "object",
"description": "Batch No"
},
"validityPeriod": {
"type": "object",
"description": "Certificate validity period"
}
},
"required": [
"resourceType",
"productID",
"date",
"batchNo"
],
"resourceDefinition": "http://smart.who.int/icvp/StructureDefinition/ICVPVaccineDetailsSD",
"fhir:parent": "http://smart.who.int/icvp/StructureDefinition/ICVPVaccineDetails",
"jsonld:valuesets": [
"resource-types|4.0.1"
],
"jsonld:contextTemplate": {
"@version": 1.1,
"fhir": "http://hl7.org/fhir/",
"resource-types|4.0.1": "http://smart.who.int/base/ValueSet-resource-types|4.0.1.jsonld"
}
}
This documentation is automatically generated from the OpenAPI specification.
This structure is derived from ICVPVaccineDetails
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
ICVPVaccineDetails | Instances of this logical model can be the target of a Reference | ||
![]() ![]() |
||||
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | ICVPVaccineDetails | ICVP - Vaccine Details Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician |
![]() ![]() |
C | 1..1 | Coding | Vaccine Product Constraints: is-a-prequal-product-id, is-an-icvp-product-id |
![]() ![]() |
1..1 | date | Date | |
![]() ![]() |
0..1 | Reference(Organization) | Issuing Organization | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
Σ | 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). |
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() |
0..1 | string | Name of supervising clinician | |
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |
![]() ![]() |
1..1 | CodeableConcept | Batch No | |
![]() ![]() |
0..1 | Period | Certificate validity period | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ICVPVaccineDetails.issuer.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| 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()
|
| is-a-prequal-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the PreQual Database |
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: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | ICVPVaccineDetails | ICVP - Vaccine Details Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician |
![]() ![]() |
C | 1..1 | Coding | Vaccine Product Constraints: is-a-prequal-product-id, is-an-icvp-product-id |
![]() ![]() |
1..1 | date | Date | |
![]() ![]() |
0..1 | Reference(Organization) | Issuing Organization | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
Σ | 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). |
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() |
0..1 | string | Name of supervising clinician | |
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |
![]() ![]() |
1..1 | CodeableConcept | Batch No | |
![]() ![]() |
0..1 | Period | Certificate validity period | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ICVPVaccineDetails.issuer.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| 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()
|
| is-a-prequal-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the PreQual Database |
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 | Instances of this logical model can be the target of a Reference | ||
![]() ![]() |
||||
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
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: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | ICVPVaccineDetails | ICVP - Vaccine Details Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician |
![]() ![]() |
C | 1..1 | Coding | Vaccine Product Constraints: is-a-prequal-product-id, is-an-icvp-product-id |
![]() ![]() |
1..1 | date | Date | |
![]() ![]() |
0..1 | Reference(Organization) | Issuing Organization | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
Σ | 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). |
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() |
0..1 | string | Name of supervising clinician | |
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | code | Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure | |
![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |
![]() ![]() |
1..1 | CodeableConcept | Batch No | |
![]() ![]() |
0..1 | Period | Certificate validity period | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ICVPVaccineDetails.issuer.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| 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()
|
| is-a-prequal-product-id | error | ICVPVaccineDetails.productID | Product ID comes from the PreQual Database |
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