International Patient Access, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ipa/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization | Version: 1.0.0 | |||
Standards status: Trial-use | Computable Name: IPAImmunization | |||
Copyright/Legal: Used by permission of HL7 International all rights reserved Creative Commons License |
Minimum expectations for an Immunization resource when accessed via a International Patient Access API
The following data elements must always be present (in other words, mandatory resource properties where the minimum cardinality is 1) or must be supported (Must Support definition). Servers cannot restrict access to mandatory elements when authorizing an application. However, servers may choose to provide additional information or may be required to do so by national or other profiles that apply to the server’s context.
Each Immunization SHALL have:
Applications must also support:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Immunization
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Immunization | Immunization event information | |
![]() ![]() ![]() | S | 1..1 | code | completed | entered-in-error | not-done |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Reason not done |
![]() ![]() ![]() | S | 1..1 | CodeableConcept | Vaccine product administered |
![]() ![]() ![]() | S | 1..1 | Reference(IPA-Patient) | Who was immunized |
![]() ![]() ![]() | S | 1..1 | dateTime, string | Vaccine administration date |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Immunization | Immunization event information | |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. |
![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. |
![]() ![]() ![]() | SΣ | 1..1 | Reference(IPA-Patient) | Who was immunized |
![]() ![]() ![]() | SΣ | 1..1 | Vaccine administration date | |
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() ![]() | string | |||
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Dose potency |
![]() |
Path | Conformance | ValueSet |
Immunization.status | required | ImmunizationStatusCodes |
Immunization.statusReason | example | ImmunizationStatusReasonCodes |
Immunization.vaccineCode | example | VaccineAdministeredValueSet |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Immunization | 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: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | 0..* | Identifier | Business identifier | |||||
![]() ![]() ![]() | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | ||||
![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. | ||||
![]() ![]() ![]() | SΣ | 1..1 | Reference(IPA-Patient) | Who was immunized | ||||
![]() ![]() ![]() | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
![]() ![]() ![]() | SΣ | 1..1 | Vaccine administration date | |||||
![]() ![]() ![]() ![]() | dateTime | |||||||
![]() ![]() ![]() ![]() | string | |||||||
![]() ![]() ![]() | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
![]() ![]() ![]() | Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
![]() ![]() ![]() | 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. | |||||
![]() ![]() ![]() | 0..1 | Reference(Location) | Where immunization occurred | |||||
![]() ![]() ![]() | 0..1 | Reference(Organization) | Vaccine manufacturer | |||||
![]() ![]() ![]() | 0..1 | string | Vaccine lot number | |||||
![]() ![]() ![]() | 0..1 | date | Vaccine expiration date | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
![]() ![]() ![]() | 0..1 | SimpleQuantity | 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): The role a practitioner or organization plays in the immunization event. | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
![]() ![]() ![]() | Σ | 0..* | Annotation | Additional immunization notes | ||||
![]() ![]() ![]() | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
![]() ![]() ![]() | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Dose potency | ||||
![]() ![]() ![]() | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
![]() ![]() ![]() | C | 0..* | BackboneElement | Educational material presented to patient | ||||
![]() ![]() ![]() ![]() | 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 | Educational material document identifier | |||||
![]() ![]() ![]() ![]() | 0..1 | uri | Educational material reference pointer | |||||
![]() ![]() ![]() ![]() | 0..1 | dateTime | Educational material publication date | |||||
![]() ![]() ![]() ![]() | 0..1 | dateTime | Educational material presentation date | |||||
![]() ![]() ![]() | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
![]() ![]() ![]() | 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 | Reference(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 targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
![]() ![]() ![]() ![]() | 1..1 | Dose number within series | ||||||
![]() ![]() ![]() ![]() ![]() | positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() | string | |||||||
![]() ![]() ![]() ![]() | 0..1 | Recommended number of doses for immunity | ||||||
![]() ![]() ![]() ![]() ![]() | positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() | string | |||||||
![]() |
Path | Conformance | ValueSet | ||||
Immunization.language | preferred | CommonLanguages
| ||||
Immunization.status | required | ImmunizationStatusCodes | ||||
Immunization.statusReason | example | ImmunizationStatusReasonCodes | ||||
Immunization.vaccineCode | example | VaccineAdministeredValueSet | ||||
Immunization.reportOrigin | example | ImmunizationOriginCodes | ||||
Immunization.site | example | CodesForImmunizationSiteOfAdministration | ||||
Immunization.route | example | ImmunizationRouteCodes | ||||
Immunization.performer.function | extensible | ImmunizationFunctionCodes | ||||
Immunization.reasonCode | example | ImmunizationReasonCodes | ||||
Immunization.subpotentReason | example | ImmunizationSubpotentReason | ||||
Immunization.programEligibility | example | ImmunizationProgramEligibility | ||||
Immunization.fundingSource | example | ImmunizationFundingSource | ||||
Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodes |
This structure is derived from Immunization
Differential View
This structure is derived from Immunization
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Immunization | Immunization event information | |
![]() ![]() ![]() | S | 1..1 | code | completed | entered-in-error | not-done |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Reason not done |
![]() ![]() ![]() | S | 1..1 | CodeableConcept | Vaccine product administered |
![]() ![]() ![]() | S | 1..1 | Reference(IPA-Patient) | Who was immunized |
![]() ![]() ![]() | S | 1..1 | dateTime, string | Vaccine administration date |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Immunization | Immunization event information | |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. |
![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. |
![]() ![]() ![]() | SΣ | 1..1 | Reference(IPA-Patient) | Who was immunized |
![]() ![]() ![]() | SΣ | 1..1 | Vaccine administration date | |
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() ![]() | string | |||
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Dose potency |
![]() |
Path | Conformance | ValueSet |
Immunization.status | required | ImmunizationStatusCodes |
Immunization.statusReason | example | ImmunizationStatusReasonCodes |
Immunization.vaccineCode | example | VaccineAdministeredValueSet |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Immunization | 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: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | 0..* | Identifier | Business identifier | |||||
![]() ![]() ![]() | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | ||||
![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. | ||||
![]() ![]() ![]() | SΣ | 1..1 | Reference(IPA-Patient) | Who was immunized | ||||
![]() ![]() ![]() | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
![]() ![]() ![]() | SΣ | 1..1 | Vaccine administration date | |||||
![]() ![]() ![]() ![]() | dateTime | |||||||
![]() ![]() ![]() ![]() | string | |||||||
![]() ![]() ![]() | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
![]() ![]() ![]() | Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
![]() ![]() ![]() | 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. | |||||
![]() ![]() ![]() | 0..1 | Reference(Location) | Where immunization occurred | |||||
![]() ![]() ![]() | 0..1 | Reference(Organization) | Vaccine manufacturer | |||||
![]() ![]() ![]() | 0..1 | string | Vaccine lot number | |||||
![]() ![]() ![]() | 0..1 | date | Vaccine expiration date | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
![]() ![]() ![]() | 0..1 | SimpleQuantity | 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): The role a practitioner or organization plays in the immunization event. | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
![]() ![]() ![]() | Σ | 0..* | Annotation | Additional immunization notes | ||||
![]() ![]() ![]() | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
![]() ![]() ![]() | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Dose potency | ||||
![]() ![]() ![]() | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
![]() ![]() ![]() | C | 0..* | BackboneElement | Educational material presented to patient | ||||
![]() ![]() ![]() ![]() | 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 | Educational material document identifier | |||||
![]() ![]() ![]() ![]() | 0..1 | uri | Educational material reference pointer | |||||
![]() ![]() ![]() ![]() | 0..1 | dateTime | Educational material publication date | |||||
![]() ![]() ![]() ![]() | 0..1 | dateTime | Educational material presentation date | |||||
![]() ![]() ![]() | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
![]() ![]() ![]() | 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 | Reference(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 targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
![]() ![]() ![]() ![]() | 1..1 | Dose number within series | ||||||
![]() ![]() ![]() ![]() ![]() | positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() | string | |||||||
![]() ![]() ![]() ![]() | 0..1 | Recommended number of doses for immunity | ||||||
![]() ![]() ![]() ![]() ![]() | positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() | string | |||||||
![]() |
Path | Conformance | ValueSet | ||||
Immunization.language | preferred | CommonLanguages
| ||||
Immunization.status | required | ImmunizationStatusCodes | ||||
Immunization.statusReason | example | ImmunizationStatusReasonCodes | ||||
Immunization.vaccineCode | example | VaccineAdministeredValueSet | ||||
Immunization.reportOrigin | example | ImmunizationOriginCodes | ||||
Immunization.site | example | CodesForImmunizationSiteOfAdministration | ||||
Immunization.route | example | ImmunizationRouteCodes | ||||
Immunization.performer.function | extensible | ImmunizationFunctionCodes | ||||
Immunization.reasonCode | example | ImmunizationReasonCodes | ||||
Immunization.subpotentReason | example | ImmunizationSubpotentReason | ||||
Immunization.programEligibility | example | ImmunizationProgramEligibility | ||||
Immunization.fundingSource | example | ImmunizationFundingSource | ||||
Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodes |
This structure is derived from Immunization
Other representations of profile: CSV, Excel, Schematron