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.
| Official URL: http://smart.who.int/icvp/StructureDefinition/ICVPImmunization | Version: 0.3.0 | |||
| Active as of 2026-04-16 | Computable Name: ICVPImmunization | |||
This profile represents Immunization record for Digital Vaccine Certificates for use in the International Certificate of Vaccination or Prophylaxis (ICVP). Such vaccine should be listed in the ICVP Product Catalogue
The ICVP product catalogue consists of vaccines listed in the list of Prequalified Vaccines and the Emergency Use Listing.
In FHIR R6, this could also be a reference to an InventoryItem
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: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DVCImmunization | Immunization event information | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 1..1 | Coding, Reference(Medication Catalog Item) | Extension URL: http://smart.who.int/pcmt/StructureDefinition/ProductID |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) |
![]() ![]() |
ΣC | 1..1 | CodeableConcept | Vaccine administered Binding: VaccineAdministeredValueSet (example) Constraints: has-an-icvp-vaccine-type |
![]() ![]() |
S | 0..1 | string | Vaccine lot number |
![]() ![]() |
Σ | 1..1 | Reference(Patient) | Who was immunized |
![]() ![]() |
Σ | 1..1 | dateTime | Vaccine administration date |
![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Immunization Status Codes | 📍5.0.0 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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()
|
| has-an-icvp-vaccine-type | error | Immunization.vaccineCode | Ensure vaccine type is from the prequal vaccine database for ICVP vaccines |
memberOf('http://smart.who.int/icvp/ValueSet/ICVPVaccineType')
|
This structure is derived from DVCImmunization
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DVCImmunization | Immunization event information | |
![]() ![]() |
C | 1..1 | CodeableConcept | Vaccine administered Constraints: has-an-icvp-vaccine-type |
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| has-an-icvp-vaccine-type | error | Immunization.vaccineCode | Ensure vaccine type is from the prequal vaccine database for ICVP vaccines |
memberOf('http://smart.who.int/icvp/ValueSet/ICVPVaccineType')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DVCImmunization | Immunization event information | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 1..1 | Coding, Reference(Medication Catalog Item) | Extension URL: http://smart.who.int/pcmt/StructureDefinition/ProductID | ||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
0..* | Identifier | Business identifier | |||||
![]() ![]() |
Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | Authority that the immunization event is based on | ||||
![]() ![]() |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) | ||||
![]() ![]() |
0..1 | CodeableConcept | Reason for current status Binding: ImmunizationStatusReasonCodes (example) | |||||
![]() ![]() |
ΣC | 1..1 | CodeableConcept | Vaccine administered Binding: VaccineAdministeredValueSet (example) Constraints: has-an-icvp-vaccine-type | ||||
![]() ![]() |
0..1 | CodeableReference(Medication) | Product that was administered | |||||
![]() ![]() |
0..1 | CodeableReference(Organization) | Vaccine manufacturer | |||||
![]() ![]() |
S | 0..1 | string | Vaccine lot number | ||||
![]() ![]() |
0..1 | date | Vaccine expiration date | |||||
![]() ![]() |
Σ | 1..1 | Reference(Patient) | Who was immunized | ||||
![]() ![]() |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
![]() ![]() |
0..* | Reference(Resource) | Additional information in support of the immunization | |||||
![]() ![]() |
Σ | 1..1 | dateTime | Vaccine administration date | ||||
![]() ![]() |
Σ | 0..1 | boolean | Indicates context the data was captured in | ||||
![]() ![]() |
0..1 | CodeableReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Indicates the source of a reported record Binding: ImmunizationOriginCodes (example) | |||||
![]() ![]() |
0..1 | Reference(Location) | Where immunization occurred | |||||
![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example) | |||||
![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example) | |||||
![]() ![]() |
0..1 | SimpleQuantity(5.0.0) | Amount of vaccine administered | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | Who performed event | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible) | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(mCSD Practitioner(4.0.0) | mCSD Organization for Jurisdictions(4.0.0)) | Individual or organization who was performing | ||||
![]() ![]() |
Σ | 0..* | Annotation | Additional immunization notes | ||||
![]() ![]() |
0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Why immunization occurred Binding: ImmunizationReasonCodes (example) | |||||
![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency | ||||
![]() ![]() |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
![]() ![]() |
0..* | BackboneElement | Patient eligibility for a specific vaccination program | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | The program that eligibility is declared for Binding: CodesForVaccineFundingPrograms (example) | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | The patient's eligibility status for the program Binding: ImmunizationProgramEligibility (example) | |||||
![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example) | |||||
![]() ![]() |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | dateTime | When reaction started | |||||
![]() ![]() ![]() |
0..1 | CodeableReference(Observation) | Additional information on reaction | |||||
![]() ![]() ![]() |
0..1 | boolean | Indicates self-reported reaction | |||||
![]() ![]() |
0..* | BackboneElement | Protocol followed by the provider | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | string | Name of vaccine series | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine preventatable disease being targeted Binding: ImmunizationTargetDiseaseCodes (example) | |||||
![]() ![]() ![]() |
1..1 | string | Dose number within series | |||||
![]() ![]() ![]() |
0..1 | string | Recommended number of doses for immunity | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Immunization.status | Base | required | Immunization Status Codes | 📍5.0.0 | FHIR Std. |
| Immunization.statusReason | Base | example | Immunization Status Reason Codes | 📍5.0.0 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍5.0.0 | FHIR Std. |
| Immunization.informationSource | Base | example | Immunization Origin Codes | 📍5.0.0 | FHIR Std. |
| Immunization.site | Base | example | Codes for Immunization Site of Administration | 📍5.0.0 | FHIR Std. |
| Immunization.route | Base | example | Immunization Route Codes | 📍5.0.0 | FHIR Std. |
| Immunization.performer.function | Base | extensible | Immunization Function Codes | 📍5.0.0 | FHIR Std. |
| Immunization.reason | Base | example | Immunization Reason Codes | 📍5.0.0 | FHIR Std. |
| Immunization.subpotentReason | Base | example | Immunization Subpotent Reason | 📍5.0.0 | FHIR Std. |
| Immunization.programEligibility.program | Base | example | Vaccine Funding Programs | 📍5.0.0 | FHIR Std. |
| Immunization.programEligibility.programStatus | Base | example | Immunization Program Eligibility | 📍5.0.0 | FHIR Std. |
| Immunization.fundingSource | Base | example | Immunization Funding Source | 📍5.0.0 | FHIR Std. |
| Immunization.protocolApplied.targetDisease | Base | example | Immunization Target Disease Codes | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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()
|
| has-an-icvp-vaccine-type | error | Immunization.vaccineCode | Ensure vaccine type is from the prequal vaccine database for ICVP vaccines |
memberOf('http://smart.who.int/icvp/ValueSet/ICVPVaccineType')
|
This structure is derived from DVCImmunization
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DVCImmunization | Immunization event information | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 1..1 | Coding, Reference(Medication Catalog Item) | Extension URL: http://smart.who.int/pcmt/StructureDefinition/ProductID |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) |
![]() ![]() |
ΣC | 1..1 | CodeableConcept | Vaccine administered Binding: VaccineAdministeredValueSet (example) Constraints: has-an-icvp-vaccine-type |
![]() ![]() |
S | 0..1 | string | Vaccine lot number |
![]() ![]() |
Σ | 1..1 | Reference(Patient) | Who was immunized |
![]() ![]() |
Σ | 1..1 | dateTime | Vaccine administration date |
![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Immunization Status Codes | 📍5.0.0 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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()
|
| has-an-icvp-vaccine-type | error | Immunization.vaccineCode | Ensure vaccine type is from the prequal vaccine database for ICVP vaccines |
memberOf('http://smart.who.int/icvp/ValueSet/ICVPVaccineType')
|
Differential View
This structure is derived from DVCImmunization
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DVCImmunization | Immunization event information | |
![]() ![]() |
C | 1..1 | CodeableConcept | Vaccine administered Constraints: has-an-icvp-vaccine-type |
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| has-an-icvp-vaccine-type | error | Immunization.vaccineCode | Ensure vaccine type is from the prequal vaccine database for ICVP vaccines |
memberOf('http://smart.who.int/icvp/ValueSet/ICVPVaccineType')
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DVCImmunization | Immunization event information | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 1..1 | Coding, Reference(Medication Catalog Item) | Extension URL: http://smart.who.int/pcmt/StructureDefinition/ProductID | ||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
0..* | Identifier | Business identifier | |||||
![]() ![]() |
Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | Authority that the immunization event is based on | ||||
![]() ![]() |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) | ||||
![]() ![]() |
0..1 | CodeableConcept | Reason for current status Binding: ImmunizationStatusReasonCodes (example) | |||||
![]() ![]() |
ΣC | 1..1 | CodeableConcept | Vaccine administered Binding: VaccineAdministeredValueSet (example) Constraints: has-an-icvp-vaccine-type | ||||
![]() ![]() |
0..1 | CodeableReference(Medication) | Product that was administered | |||||
![]() ![]() |
0..1 | CodeableReference(Organization) | Vaccine manufacturer | |||||
![]() ![]() |
S | 0..1 | string | Vaccine lot number | ||||
![]() ![]() |
0..1 | date | Vaccine expiration date | |||||
![]() ![]() |
Σ | 1..1 | Reference(Patient) | Who was immunized | ||||
![]() ![]() |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
![]() ![]() |
0..* | Reference(Resource) | Additional information in support of the immunization | |||||
![]() ![]() |
Σ | 1..1 | dateTime | Vaccine administration date | ||||
![]() ![]() |
Σ | 0..1 | boolean | Indicates context the data was captured in | ||||
![]() ![]() |
0..1 | CodeableReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Indicates the source of a reported record Binding: ImmunizationOriginCodes (example) | |||||
![]() ![]() |
0..1 | Reference(Location) | Where immunization occurred | |||||
![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example) | |||||
![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example) | |||||
![]() ![]() |
0..1 | SimpleQuantity(5.0.0) | Amount of vaccine administered | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | Who performed event | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible) | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(mCSD Practitioner(4.0.0) | mCSD Organization for Jurisdictions(4.0.0)) | Individual or organization who was performing | ||||
![]() ![]() |
Σ | 0..* | Annotation | Additional immunization notes | ||||
![]() ![]() |
0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Why immunization occurred Binding: ImmunizationReasonCodes (example) | |||||
![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency | ||||
![]() ![]() |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
![]() ![]() |
0..* | BackboneElement | Patient eligibility for a specific vaccination program | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | The program that eligibility is declared for Binding: CodesForVaccineFundingPrograms (example) | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | The patient's eligibility status for the program Binding: ImmunizationProgramEligibility (example) | |||||
![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example) | |||||
![]() ![]() |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | dateTime | When reaction started | |||||
![]() ![]() ![]() |
0..1 | CodeableReference(Observation) | Additional information on reaction | |||||
![]() ![]() ![]() |
0..1 | boolean | Indicates self-reported reaction | |||||
![]() ![]() |
0..* | BackboneElement | Protocol followed by the provider | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | string | Name of vaccine series | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine preventatable disease being targeted Binding: ImmunizationTargetDiseaseCodes (example) | |||||
![]() ![]() ![]() |
1..1 | string | Dose number within series | |||||
![]() ![]() ![]() |
0..1 | string | Recommended number of doses for immunity | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Immunization.status | Base | required | Immunization Status Codes | 📍5.0.0 | FHIR Std. |
| Immunization.statusReason | Base | example | Immunization Status Reason Codes | 📍5.0.0 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍5.0.0 | FHIR Std. |
| Immunization.informationSource | Base | example | Immunization Origin Codes | 📍5.0.0 | FHIR Std. |
| Immunization.site | Base | example | Codes for Immunization Site of Administration | 📍5.0.0 | FHIR Std. |
| Immunization.route | Base | example | Immunization Route Codes | 📍5.0.0 | FHIR Std. |
| Immunization.performer.function | Base | extensible | Immunization Function Codes | 📍5.0.0 | FHIR Std. |
| Immunization.reason | Base | example | Immunization Reason Codes | 📍5.0.0 | FHIR Std. |
| Immunization.subpotentReason | Base | example | Immunization Subpotent Reason | 📍5.0.0 | FHIR Std. |
| Immunization.programEligibility.program | Base | example | Vaccine Funding Programs | 📍5.0.0 | FHIR Std. |
| Immunization.programEligibility.programStatus | Base | example | Immunization Program Eligibility | 📍5.0.0 | FHIR Std. |
| Immunization.fundingSource | Base | example | Immunization Funding Source | 📍5.0.0 | FHIR Std. |
| Immunization.protocolApplied.targetDisease | Base | example | Immunization Target Disease Codes | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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()
|
| has-an-icvp-vaccine-type | error | Immunization.vaccineCode | Ensure vaccine type is from the prequal vaccine database for ICVP vaccines |
memberOf('http://smart.who.int/icvp/ValueSet/ICVPVaccineType')
|
This structure is derived from DVCImmunization
Other representations of profile: CSV, Excel, Schematron