## Union of http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips and http://hl7.eu/fhir/base-r5/StructureDefinition/immunization-eu-core

This is the set of resources that conform to either of the profiles Immunization (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips) and Immunization (EU core) (http://hl7.eu/fhir/base-r5/StructureDefinition/immunization-eu-core). E.g. what you have to deal with if you get resources conforming to one of them

### Structure

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* |  | Immunization event information
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | left: Language of the resource content; right: Language of the immunization content Binding: ?? (required): left: A human language.; right: IETF language tag for a human language
text |  | 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
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier |  | 0..* | Identifier | left: Business identifier; right: Identifier of the immunization
status | ?!S Σ | 1..1 | code | left: completed | entered-in-error | not-done; right: Immunization status. Binding: ?? (required): A set of codes indicating the current status of an Immunization.
statusReason |  | 0..1 | CodeableConcept | left: Reason not done; right: Reason for not performing. Binding: ?? (example): The reason why a vaccine was not administered.
vaccineCode | S Σ | 1..1 | CodeableConcept | 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 administered Binding: ?? (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization.
patient | S Σ | 1..1 | Reference(Patient (IPS) | #sd+39-Patient-uv-ips-patient-eu-core) | Who was immunized
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor | Source
SHALL:populate-if-known | Creator (IPS) | from Immunization (IPS)
SHALL:handle | Consumer (IPS) | from Immunization (IPS)
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of
occurrence[x] | S Σ | 1..1 |  | left: Vaccine administration date; right: Date of vaccination
occurrenceDateTime |  |  | dateTime |
occurrenceString |  |  | string |
recorded |  | 0..1 | dateTime | When the immunization was first captured in the subject's record
primarySource | Σ | 0..1 | boolean | left: Indicates context the data was recorded in; right: Indicates context the data was captured in
reportOrigin |  | 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.
location |  | 0..1 | Reference(Location) | Where immunization occurred
manufacturer |  | 0..1 | Reference(Organization), CodeableReference(Organization|5.0.0) | left: Vaccine manufacturer; right: Vaccine manufacturer/MAH
lotNumber |  | 0..1 | string | left: Vaccine lot number; right: Batch/lot number
expirationDate |  | 0..1 | date | Vaccine expiration date
site |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: ?? (preferred)
route |  | 0..1 | CodeableConcept | How vaccine entered body Binding: ?? (preferred): SNOMED Route Terms
doseQuantity |  | 0..1 | ?? | Amount of vaccine administered
performer | Σ | 0..* | BackboneElement | Who performed event
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: ?? (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
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
author[x] | Σ | 0..1 |  | Individual responsible for the annotation
authorReference |  |  | Reference(Practitioner|5.0.0 | PractitionerRole|5.0.0 | Patient|5.0.0 | RelatedPerson|5.0.0 | Organization|5.0.0) |
authorString |  |  | string |
time | Σ | 0..1 | dateTime | When the annotation was made
text | Σ | 1..1 | markdown | Additional notes about the immunization
reasonCode |  | 0..* | CodeableConcept | Why immunization occurred Binding: ?? (example): The reason why a vaccine was administered.
reasonReference |  | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
subpotentReason |  | 0..* | CodeableConcept | Reason for being subpotent Binding: ?? (example): The reason why a dose is considered to be subpotent.
education | C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1
programEligibility |  | 0..* |  | left: Patient eligibility for a vaccination program; right: Patient eligibility for a specific vaccination program Binding: ?? (example): The patient's eligibility for a vaccation program.
programEligibilityAll Types |  |  |  | Content/Rules for all Types
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
program |  | 1..1 | CodeableConcept | The program that eligibility is declared for Binding: ?? (example)
programStatus |  | 1..1 | CodeableConcept | The patient's eligibility status for the program Binding: ?? (example)
programEligibility |  |  | CodeableConcept |
programEligibility |  |  | BackboneElement |
fundingSource |  | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ?? (example): The source of funding used to purchase the vaccine administered.
reaction |  | 0..* | BackboneElement | Details of a reaction that follows immunization
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
date |  | 0..1 | dateTime | When reaction started
detail |  | 0..1 | Reference(Observation) | Additional information on reaction
reported |  | 0..1 | boolean | Indicates self-reported reaction
manifestation |  | 0..1 | CodeableReference(Observation|5.0.0) | Additional information on reaction
protocolApplied |  | 0..* | BackboneElement | Protocol followed by the provider
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
series |  | 0..1 | string | Name of vaccine series
authority |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations
targetDisease |  | 0..* | CodeableConcept | left: Vaccine preventable disease being targeted; right: Vaccine preventatable disease being targeted Binding: ?? (preferred): The particular disease or diseases against which the patient has been immunized.
doseNumber[x] |  | 1..1 |  | Dose number within series
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
seriesDoses[x] |  | 0..1 |  | Recommended number of doses for immunity
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
doseNumber |  | 1..1 | string | Dose Number
seriesDoses |  | 0..1 | string | Number of doses
basedOn | Σ | 0..* | Reference(CarePlan|5.0.0 | MedicationRequest|5.0.0 | ServiceRequest|5.0.0 | ImmunizationRecommendation|5.0.0) | Authority that the immunization event is based on
administeredProduct |  | 0..1 | CodeableReference(Medication|5.0.0) | The product that was administered or was to be administered.
supportingInformation |  | 0..* | Reference(Resource|5.0.0) | Additional information in support of the immunization
informationSource |  | 0..1 | CodeableReference(http://hl7.eu/fhir/base-r5/StructureDefinition/patient-eu-core | http://hl7.eu/fhir/base-r5/StructureDefinition/practitioner-eu-core | http://hl7.eu/fhir/base-r5/StructureDefinition/practitionerRole-eu-core | RelatedPerson | http://hl7.eu/fhir/base-r5/StructureDefinition/organization-eu-core) | Indicates the source of a reported record Binding: ?? (example)
reason |  | 0..* | CodeableReference(Condition|5.0.0 | Observation|5.0.0 | DiagnosticReport|5.0.0) | Why immunization occurred Binding: ?? (example)
Documentation for this format