EHI Export Implementation Guide
0.1.0 - ci-build
EHI Export Implementation Guide
0.1.0 - ci-build
EHI Export Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://ehi-export.pointclickcare.com//StructureDefinition/immunization | Version: 0.1.0 | |||
| Draft as of 2025-12-10 | Computable Name: EHIImmunization | |||
Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.
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:   |
|---|---|---|---|---|
  Immunization |
0..* | Immunization | Immunization event information | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:immunizationStatus |
0..1 | code | Extension URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-ImmunizationStatus.html Binding: Immunization Status Value Set (required) | |
  status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
 vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. |
 patient |
Σ | 1..1 | Reference(Patient) | Who was immunized |
  occurrence[x] |
Σ | 1..1 | Vaccine administration date | |
 occurrenceDateTime |
dateTime | |||
 occurrenceString |
string | |||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍4.0.1 | 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()
|
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |
 implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| text |
0..0 | Text summary of the resource, for human interpretation | ||
| contained |
0..0 | Contained, inline Resources | ||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:immunizationStatus |
0..1 | code | Extension URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-ImmunizationStatus.html Binding: Immunization Status Value Set (required) | |
 modifierExtension |
0..0 | Extension | ||
| patient |
1..1 | Reference(Patient) | Who was immunized | |
| encounter |
0..0 | Encounter immunization was part of | ||
| location |
0..0 | Where immunization occurred | ||
| reasonCode |
0..0 | Why immunization occurred | ||
| reasonReference |
0..0 | Why immunization occurred | ||
| isSubpotent |
0..0 | Dose potency | ||
| subpotentReason |
0..0 | Reason for being subpotent | ||
| programEligibility |
0..0 | Patient eligibility for a vaccination program | ||
| fundingSource |
0..0 | Funding source for the vaccine | ||
| reaction |
0..0 | Details of a reaction that follows immunization | ||
| protocolApplied |
0..0 | Protocol followed by the provider | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |
| id |
Σ | 0..1 | id | Logical id of this artifact |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:immunizationStatus |
0..1 | code | Extension URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-ImmunizationStatus.html Binding: Immunization Status Value Set (required) | |
| identifier |
0..* | Identifier | Business identifier | |
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
| statusReason |
0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | |
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. |
| patient |
Σ | 1..1 | Reference(Patient) | Who was immunized |
| occurrence[x] |
Σ | 1..1 | Vaccine administration date | |
| occurrenceDateTime |
dateTime | |||
| occurrenceString |
string | |||
| recorded |
0..1 | dateTime | When the immunization was first captured in the subject's record | |
| primarySource |
Σ | 0..1 | boolean | Indicates context the data was recorded in |
| reportOrigin |
0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |
| lotNumber |
0..1 | string | Vaccine lot number | |
| expirationDate |
0..1 | date | Vaccine expiration date | |
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |
| doseQuantity |
0..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered | |
| performer |
Σ | 0..* | BackboneElement | Who performed event |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. |
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
| note |
Σ | 0..* | Annotation | Additional immunization notes |
| education |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| documentType |
0..1 | string | Educational material document identifier | |
| reference |
0..1 | uri | Educational material reference pointer | |
| publicationDate |
0..1 | dateTime | Educational material publication date | |
| presentationDate |
0..1 | dateTime | Educational material presentation date | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std. |
| Immunization.statusReason | Base | example | Immunization Status Reason Codes | 📍4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍4.0.1 | FHIR Std. |
| Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📍4.0.1 | FHIR Std. |
| Immunization.site | Base | example | Codes for Immunization Site of Administration | 📍4.0.1 | FHIR Std. |
| Immunization.route | Base | example | Immunization Route Codes | 📍4.0.1 | FHIR Std. |
| Immunization.performer.function | Base | extensible | Immunization Function Codes | 📍4.0.1 | FHIR Std. |
| Immunization.protocolApplied.targetDisease | Base | example | Immunization Target Disease Codes | 📍4.0.1 | 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()
|
| imm-1 | error | Immunization.education | One of documentType or reference SHALL be present |
documentType.exists() or reference.exists()
|
This structure is derived from Immunization
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:immunizationStatus |
0..1 | code | Extension URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-ImmunizationStatus.html Binding: Immunization Status Value Set (required) | |
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. |
| patient |
Σ | 1..1 | Reference(Patient) | Who was immunized |
| occurrence[x] |
Σ | 1..1 | Vaccine administration date | |
| occurrenceDateTime |
dateTime | |||
| occurrenceString |
string | |||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍4.0.1 | 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()
|
Differential View
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| text |
0..0 | Text summary of the resource, for human interpretation | ||
| contained |
0..0 | Contained, inline Resources | ||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:immunizationStatus |
0..1 | code | Extension URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-ImmunizationStatus.html Binding: Immunization Status Value Set (required) | |
| modifierExtension |
0..0 | Extension | ||
| patient |
1..1 | Reference(Patient) | Who was immunized | |
| encounter |
0..0 | Encounter immunization was part of | ||
| location |
0..0 | Where immunization occurred | ||
| reasonCode |
0..0 | Why immunization occurred | ||
| reasonReference |
0..0 | Why immunization occurred | ||
| isSubpotent |
0..0 | Dose potency | ||
| subpotentReason |
0..0 | Reason for being subpotent | ||
| programEligibility |
0..0 | Patient eligibility for a vaccination program | ||
| fundingSource |
0..0 | Funding source for the vaccine | ||
| reaction |
0..0 | Details of a reaction that follows immunization | ||
| protocolApplied |
0..0 | Protocol followed by the provider | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |
| id |
Σ | 0..1 | id | Logical id of this artifact |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:immunizationStatus |
0..1 | code | Extension URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-ImmunizationStatus.html Binding: Immunization Status Value Set (required) | |
| identifier |
0..* | Identifier | Business identifier | |
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
| statusReason |
0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | |
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. |
| patient |
Σ | 1..1 | Reference(Patient) | Who was immunized |
| occurrence[x] |
Σ | 1..1 | Vaccine administration date | |
| occurrenceDateTime |
dateTime | |||
| occurrenceString |
string | |||
| recorded |
0..1 | dateTime | When the immunization was first captured in the subject's record | |
| primarySource |
Σ | 0..1 | boolean | Indicates context the data was recorded in |
| reportOrigin |
0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |
| lotNumber |
0..1 | string | Vaccine lot number | |
| expirationDate |
0..1 | date | Vaccine expiration date | |
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |
| doseQuantity |
0..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered | |
| performer |
Σ | 0..* | BackboneElement | Who performed event |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. |
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
| note |
Σ | 0..* | Annotation | Additional immunization notes |
| education |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| documentType |
0..1 | string | Educational material document identifier | |
| reference |
0..1 | uri | Educational material reference pointer | |
| publicationDate |
0..1 | dateTime | Educational material publication date | |
| presentationDate |
0..1 | dateTime | Educational material presentation date | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std. |
| Immunization.statusReason | Base | example | Immunization Status Reason Codes | 📍4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍4.0.1 | FHIR Std. |
| Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📍4.0.1 | FHIR Std. |
| Immunization.site | Base | example | Codes for Immunization Site of Administration | 📍4.0.1 | FHIR Std. |
| Immunization.route | Base | example | Immunization Route Codes | 📍4.0.1 | FHIR Std. |
| Immunization.performer.function | Base | extensible | Immunization Function Codes | 📍4.0.1 | FHIR Std. |
| Immunization.protocolApplied.targetDisease | Base | example | Immunization Target Disease Codes | 📍4.0.1 | 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()
|
| imm-1 | error | Immunization.education | One of documentType or reference SHALL be present |
documentType.exists() or reference.exists()
|
This structure is derived from Immunization
Other representations of profile: CSV, Excel, Schematron