This is the set of resources that conform to both Immunization (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips) and US Core Immunization Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization).
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | 0..* | Immunization event information | ||||||
![]() ![]() | Σ | 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: ?? (preferred): 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 | |||||
![]() ![]() | 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: ?? (required): A set of codes indicating the current status of an Immunization. | ||||
![]() ![]() | S | 0..1 | CodeableConcept | Reason not done Binding: ?? (example): The reason why a vaccine was not administered. | ||||
![]() ![]() | SΣ | 1..1 | ?? | left: Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.
The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code.
Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.; right: Vaccine Product Type (bind to CVX) Binding: ?? (extensible) | ||||
![]() ![]() | SΣ | 1..1 | Reference(Patient (IPS) | #sd-Patient-uv-ips-us-core-patient) | Who was immunized | ||||
![]() ![]() | S | 0..1 | Reference(http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter) | left: Encounter immunization was part of; right: Encounter the 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 | |||||
![]() ![]() | SΣ | 0..1 | boolean | Indicates context the data was recorded in | ||||
![]() ![]() | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ?? (example): The source of the data for a record which is not from a primary source. | |||||
![]() ![]() | S | 0..1 | Reference(http://hl7.org/fhir/us/core/StructureDefinition/us-core-location) | left: Where immunization occurred; right: Where the vaccine was administered | ||||
![]() ![]() | 0..1 | Reference(Organization) | Vaccine manufacturer | |||||
![]() ![]() | S | 0..1 | string | Vaccine lot number | ||||
![]() ![]() | 0..1 | date | Vaccine expiration date | |||||
![]() ![]() | 0..1 | CodeableConcept | Body site vaccine was administered Binding: ?? (preferred) | |||||
![]() ![]() | 0..1 | CodeableConcept | How vaccine entered body Binding: ?? (preferred): SNOMED Route Terms
| |||||
![]() ![]() | 0..1 | ??, ?? | Amount of vaccine administered | |||||
![]() ![]() | SΣ | 0..* | BackboneElement | Who performed event | ||||
![]() ![]() ![]() | 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: ?? (extensible): The role a practitioner or organization plays in the immunization event. | ||||
![]() ![]() ![]() | SΣ | 1..1 | Reference(http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner S | http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization) | Individual or organization who was performing | ||||
![]() ![]() | Σ | 0..* | Annotation | Additional immunization notes | ||||
![]() ![]() | 0..* | CodeableConcept | Why immunization occurred Binding: ?? (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: ?? (example): The reason why a dose is considered to be subpotent. | |||||
![]() ![]() | C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 | ||||
![]() ![]() ![]() | 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: ?? (example): The patient's eligibility for a vaccation program. | |||||
![]() ![]() | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ?? (example): The source of funding used to purchase the vaccine administered. | |||||
![]() ![]() | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||
![]() ![]() ![]() | 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..* | 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 | left: Vaccine preventable disease being targeted; right: Vaccine preventatable disease being targetted Binding: ?? (preferred): The particular disease or diseases against which the patient has been immunized. | |||||
![]() ![]() ![]() | 1..1 | Dose number within series | ||||||
![]() ![]() ![]() ![]() | positiveInt | |||||||
![]() ![]() ![]() ![]() | string | |||||||
![]() ![]() ![]() | 0..1 | Recommended number of doses for immunity | ||||||
![]() ![]() ![]() ![]() | positiveInt | |||||||
![]() ![]() ![]() ![]() | string | |||||||
Documentation for this format | ||||||||