## Union of http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization and https://hl7.fi/fhir/finnish-smart/StructureDefinition/fi-smart-immunization

This is the set of resources that conform to either of the profiles IPA-Immunization (http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization) and FI SMART Immunization (https://hl7.fi/fhir/finnish-smart/StructureDefinition/fi-smart-immunization). E.g. what you have to deal with if you get resources conforming to one of them

### Structure

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* |  | Immunization event information dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
meta | Σ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
language |  | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language. ele-1: All FHIR elements must have a @value or children
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | left: Additional content defined by implementations; right: Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier |  | 0..* | Identifier | Business identifier ele-1: All FHIR elements must have a @value or children
status | ?!S Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ?? (required): A set of codes indicating the current status of an Immunization. ele-1: All FHIR elements must have a @value or children
statusReason | S | 0..1 | CodeableConcept | Reason not done Binding: ?? (example): The reason why a vaccine was not administered. ele-1: All FHIR elements must have a @value or children
vaccineCode | S Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: ?? (example): The code for vaccine product administered. ele-1: All FHIR elements must have a @value or children
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
coding | Σ | 0..* | Coding | Defining administered product or substance by using ATC or VNR code. Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
text | Σ | 0..1 | string | Insert product name. ele-1: All FHIR elements must have a @value or children
patient | S Σ | 1..1 | Reference(IPA-Patient) | Who was immunized ele-1: All FHIR elements must have a @value or children
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of ele-1: All FHIR elements must have a @value or children
occurrence[x] | S Σ | 1..1 |  | Vaccine administration date ele-1: All FHIR elements must have a @value or children
occurrenceDateTime |  |  | dateTime |
occurrenceString |  |  | string |
recorded |  | 0..1 | dateTime | When the immunization was first captured in the subject's record ele-1: All FHIR elements must have a @value or children
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
location |  | 0..1 | Reference(Location) | Where immunization occurred ele-1: All FHIR elements must have a @value or children
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer ele-1: All FHIR elements must have a @value or children
lotNumber |  | 0..1 | string | Vaccine lot number ele-1: All FHIR elements must have a @value or children
expirationDate |  | 0..1 | date | Vaccine expiration date ele-1: All FHIR elements must have a @value or children
site |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: ?? (example): The site at which the vaccine was administered. ele-1: All FHIR elements must have a @value or children
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
text | Σ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
route |  | 0..1 | CodeableConcept | How vaccine entered body Binding: ?? (example): The route by which the vaccine was administered. ele-1: All FHIR elements must have a @value or children
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
text | Σ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
doseQuantity |  | 0..1 | ?? | Amount of vaccine administered ele-1: All FHIR elements must have a @value or children
performer | Σ | 0..* | BackboneElement | Who performed event ele-1: All FHIR elements must have a @value or children
extension |  | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ?? (extensible): The role a practitioner or organization plays in the immunization event. ele-1: All FHIR elements must have a @value or children
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing ele-1: All FHIR elements must have a @value or children
note | Σ | 0..* | Annotation | Additional immunization notes ele-1: All FHIR elements must have a @value or children
reasonCode |  | 0..* | CodeableConcept | Why immunization occurred Binding: ?? (example): The reason why a vaccine was administered. ele-1: All FHIR elements must have a @value or children
reasonReference |  | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred ele-1: All FHIR elements must have a @value or children
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency ele-1: All FHIR elements must have a @value or children
subpotentReason |  | 0..* | CodeableConcept | Reason for being subpotent Binding: ?? (example): The reason why a dose is considered to be subpotent. ele-1: All FHIR elements must have a @value or children
education | C | 0..* | BackboneElement | Educational material presented to patient ele-1: All FHIR elements must have a @value or children imm-1: One of documentType or reference SHALL be present
extension |  | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
documentType |  | 0..1 | string | Educational material document identifier ele-1: All FHIR elements must have a @value or children
reference |  | 0..1 | uri | Educational material reference pointer ele-1: All FHIR elements must have a @value or children
publicationDate |  | 0..1 | dateTime | Educational material publication date ele-1: All FHIR elements must have a @value or children
presentationDate |  | 0..1 | dateTime | Educational material presentation date ele-1: All FHIR elements must have a @value or children
programEligibility |  | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ?? (example): The patient's eligibility for a vaccation program. ele-1: All FHIR elements must have a @value or children
fundingSource |  | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ?? (example): The source of funding used to purchase the vaccine administered. ele-1: All FHIR elements must have a @value or children
reaction |  | 0..* | BackboneElement | Details of a reaction that follows immunization ele-1: All FHIR elements must have a @value or children
extension |  | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
date |  | 0..1 | dateTime | When reaction started ele-1: All FHIR elements must have a @value or children
detail |  | 0..1 | Reference(Observation) | left: Additional information on reaction; right: Reference to contained Observation resource. The contained Observation has relevant diagnose codes. ele-1: All FHIR elements must have a @value or children
reported |  | 0..1 | boolean | Indicates self-reported reaction ele-1: All FHIR elements must have a @value or children
protocolApplied |  | 0..* | BackboneElement | Protocol followed by the provider ele-1: All FHIR elements must have a @value or children
extension |  | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
series |  | 0..1 | string | Name of vaccine series ele-1: All FHIR elements must have a @value or children
authority |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations ele-1: All FHIR elements must have a @value or children
targetDisease |  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ?? (example): The vaccine preventable disease the dose is being administered for. ele-1: All FHIR elements must have a @value or children
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
coding | Σ | 0..* | Coding | Vaccine preventatable disease being targetted defined by using THL code system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
text | Σ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
doseNumber[x] |  | 1..1 |  | Dose number within series ele-1: All FHIR elements must have a @value or children
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
seriesDoses[x] |  | 0..1 |  | Recommended number of doses for immunity ele-1: All FHIR elements must have a @value or children
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
Documentation for this format