| Left: | IPA-Immunization (http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization) | 
| Right: | Fi Base Immunization (https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/fi-base-immunization) | 
| Error | StructureDefinition.url | Values for url differ: 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization' vs 'https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/fi-base-immunization' | 
| Error | StructureDefinition.version | Values for version differ: '1.1.0' vs '2.0.0-ci' | 
| Information | StructureDefinition.name | Values for name differ: 'IPAImmunization' vs 'FiBaseImmunization' | 
| Information | StructureDefinition.title | Values for title differ: 'IPA-Immunization' vs 'Fi Base Immunization' | 
| Information | StructureDefinition.status | Values for status differ: 'active' vs 'draft' | 
| Information | StructureDefinition.date | Values for date differ: '2022-08-02' vs '2025-10-05T18:07:05+00:00' | 
| Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 International / Patient Care' vs 'HL7 Finland' | 
| Information | StructureDefinition.jurisdiction | Removed the item 'http://unstats.un.org/unsd/methods/m49/m49.htm#001' | 
| Information | StructureDefinition.jurisdiction | Added the item 'urn:iso:std:iso:3166#FI' | 
| Information | Immunization.language | Example/preferred bindings differ at Immunization.language using binding from IPAImmunization | 
| Information | StructureDefinition.short | Values for short differ: 'Additional content defined by implementations' vs 'Extension' | 
| Information | StructureDefinition.definition | Values for definition differ: 'May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'An Extension' | 
| Warning | Immunization.status | Elements differ in definition for mustSupport: 'true' vs 'false' | 
| Warning | Immunization.vaccineCode | Elements differ in definition for mustSupport: 'true' vs 'false' | 
| Warning | Immunization.patient | Elements differ in definition for mustSupport: 'true' vs 'false' | 
| Warning | Immunization.occurrence[x] | Elements differ in definition for mustSupport: 'true' vs 'false' | 
| Information | StructureDefinition.short | Values for short differ: 'Additional information on reaction' vs 'Reference to contained Observation resource. The contained Observation has relevant diagnose codes.' | 
| Name | Value | Comments | |
|---|---|---|---|
 abstract | false | ||
 baseDefinition | http://hl7.org/fhir/StructureDefinition/Immunization | ||
 copyright | Used by permission of HL7 International all rights reserved Creative Commons License | 
  | |
 date | 2022-08-02 | 2025-10-05T18:07:05+00:00 | 
  | 
 description | Minimum expectations for an Immunization resource when accessed via a International Patient Access API | This is a base profile for Finnish Immunization resource. | 
  | 
 experimental | false | 
  | |
 fhirVersion | 4.0.1 | ||
 jurisdiction | |||
![]()  jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 | 
  | |
![]()  jurisdiction[1] | urn:iso:std:iso:3166#FI | 
  | |
 kind | resource | ||
 name | IPAImmunization | FiBaseImmunization | 
  | 
 publisher | HL7 International / Patient Care | HL7 Finland | 
  | 
 purpose | |||
 status | active | draft | 
  | 
 title | IPA-Immunization | Fi Base Immunization | 
  | 
 type | Immunization | ||
 url | http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization | https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/fi-base-immunization | 
  | 
 version | 1.1.0 | 2.0.0-ci | 
  | 
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments![]()  | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]()  | 0..* | Immunization | Immunization event information | 0..* | Immunization | Immunization event information | |||||||||||
![]() ![]()  | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
![]() ![]()  | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
![]() ![]()  | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 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 | 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..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..* | Resource | Contained, inline Resources | |||||||||||
![]() ![]()  | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Extension Slice: Unordered, Open by value:url  | |||||||||||
![]() ![]()  | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
![]() ![]()  | 0..* | Identifier | Business identifier | 0..* | Identifier | Business identifier | |||||||||||
![]() ![]()  | ?!SOΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ?? (required): A set of codes indicating the current status of an Immunization. 
  | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ?? (required): A set of codes indicating the current status of an Immunization.  | 
  | ||||||||
![]() ![]()  | 0..1 | CodeableConcept | Reason not done Binding: ?? (example): The reason why a vaccine was not administered.  | 0..1 | CodeableConcept | Reason not done Binding: ?? (example): The reason why a vaccine was not administered.  | |||||||||||
![]() ![]()  | SOΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: ?? (example): The code for vaccine product administered. 
  | Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: ?? (example): The code for vaccine product administered.  | 
  | ||||||||
![]() ![]() ![]()  | 0..1 | string | Unique id for inter-element referencing | 
  | |||||||||||||
![]() ![]() ![]()  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | 
  | |||||||||||||
![]() ![]() ![]()  | Σ | 0..* | Coding | Defining administered product or substance by using ATC or VNR code. Slice: Unordered, Open by value:system  | 
  | ||||||||||||
![]() ![]() ![]()  | Σ | 0..1 | string | Insert product name. | 
  | ||||||||||||
![]() ![]()  | SOΣ | 1..1 | Reference(IPA-Patient) | Who was immunized
  | Σ | 1..1 | Reference(FI Base Patient(2.0.0-ci)) | Who was immunized | 
  | ||||||||
![]() ![]()  | 0..1 | Reference(Encounter) | Encounter immunization was part of | 0..1 | Reference(FI Base Encounter(2.0.0-ci)) | Encounter immunization was part of | |||||||||||
![]() ![]()  | SOΣ | 1..1 | dateTime, string | Vaccine administration date
  | Σ | 1..1 | dateTime, string | Vaccine administration date | 
  | ||||||||
![]() ![]()  | 0..1 | dateTime | When the immunization was first captured in the subject's record | 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 | 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.  | 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.  | |||||||||||
![]() ![]()  | 0..1 | Reference(Location) | Where immunization occurred | 0..1 | Reference(FI Base Location(2.0.0-ci)) | Where immunization occurred | |||||||||||
![]() ![]()  | 0..1 | Reference(Organization) | Vaccine manufacturer | 0..1 | Reference(FI Base Organization(2.0.0-ci)) | Vaccine manufacturer | |||||||||||
![]() ![]()  | 0..1 | string | Vaccine lot number | 0..1 | string | Vaccine lot number | |||||||||||
![]() ![]()  | 0..1 | date | Vaccine expiration date | 0..1 | date | Vaccine expiration date | |||||||||||
![]() ![]()  | 0..1 | CodeableConcept | Body site vaccine  was administered Binding: ?? (example): The site at which the vaccine was administered.  | 0..1 | CodeableConcept | Body site vaccine  was administered Binding: ?? (example): The site at which the vaccine was administered.  | |||||||||||
![]() ![]() ![]()  | 0..1 | string | Unique id for inter-element referencing | 
  | |||||||||||||
![]() ![]() ![]()  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | 
  | |||||||||||||
![]() ![]() ![]()  | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system  | 
  | ||||||||||||
![]() ![]() ![]()  | Σ | 0..1 | string | Plain text representation of the concept | 
  | ||||||||||||
![]() ![]()  | 0..1 | CodeableConcept | How vaccine entered body Binding: ?? (example): The route by which the vaccine was administered.  | 0..1 | CodeableConcept | How vaccine entered body Binding: ?? (example): The route by which the vaccine was administered.  | |||||||||||
![]() ![]() ![]()  | 0..1 | string | Unique id for inter-element referencing | 
  | |||||||||||||
![]() ![]() ![]()  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | 
  | |||||||||||||
![]() ![]() ![]()  | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system  | 
  | ||||||||||||
![]() ![]() ![]()  | Σ | 0..1 | string | Plain text representation of the concept | 
  | ||||||||||||
![]() ![]()  | 0..1 | ?? | Amount of vaccine administered | 0..1 | ?? | Amount of vaccine administered | |||||||||||
![]() ![]()  | Σ | 0..* | BackboneElement | Who performed event | Σ | 0..* | BackboneElement | Who performed event | |||||||||
![]() ![]() ![]()  | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]()  | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]()  | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 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.  | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ?? (extensible): The role a practitioner or organization plays in the immunization event.  | |||||||||
![]() ![]() ![]()  | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | Σ | 1..1 | Reference(FI Base Practitioner(2.0.0-ci) | FI Base PractitionerRole(2.0.0-ci) | FI Base Organization(2.0.0-ci)) | Individual or organization who was performing | |||||||||
![]() ![]()  | Σ | 0..* | Annotation | Additional immunization notes | Σ | 0..* | Annotation | Additional immunization notes | |||||||||
![]() ![]()  | 0..* | CodeableConcept | Why immunization occurred Binding: ?? (example): The reason why a vaccine was administered.  | 0..* | CodeableConcept | Why immunization occurred Binding: ?? (example): The reason why a vaccine was administered.  | |||||||||||
![]() ![]()  | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | 0..* | Reference(FI Base Condition(2.0.0-ci) | FI Base Observation(2.0.0-ci) | DiagnosticReport) | Why immunization occurred | |||||||||||
![]() ![]()  | ?!Σ | 0..1 | boolean | Dose potency | ?!Σ | 0..1 | boolean | Dose potency | |||||||||
![]() ![]()  | 0..* | CodeableConcept | Reason for being subpotent Binding: ?? (example): The reason why a dose is considered to be subpotent.  | 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 | C | 0..* | BackboneElement | Educational material presented to patient | |||||||||
![]() ![]() ![]()  | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]()  | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]()  | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]()  | 0..1 | string | Educational material document identifier | 0..1 | string | Educational material document identifier | |||||||||||
![]() ![]() ![]()  | 0..1 | uri | Educational material reference pointer | 0..1 | uri | Educational material reference pointer | |||||||||||
![]() ![]() ![]()  | 0..1 | dateTime | Educational material publication date | 0..1 | dateTime | Educational material publication date | |||||||||||
![]() ![]() ![]()  | 0..1 | dateTime | Educational material presentation 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..* | 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..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..* | BackboneElement | Details of a reaction that follows immunization | |||||||||||
![]() ![]() ![]()  | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]()  | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]()  | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]()  | 0..1 | dateTime | When reaction started | 0..1 | dateTime | When reaction started | |||||||||||
![]() ![]() ![]()  | 0..1 | Reference(Observation) | Additional information on reaction | 0..1 | Reference(FI Base Observation(2.0.0-ci)) | Reference to contained Observation resource. The contained Observation has relevant diagnose codes. | |||||||||||
![]() ![]() ![]()  | 0..1 | boolean | Indicates self-reported reaction | 0..1 | boolean | Indicates self-reported reaction | |||||||||||
![]() ![]()  | 0..* | BackboneElement | Protocol followed by the provider | 0..* | BackboneElement | Protocol followed by the provider | |||||||||||
![]() ![]() ![]()  | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]()  | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]()  | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]()  | 0..1 | string | Name of vaccine series | 0..1 | string | Name of vaccine series | |||||||||||
![]() ![]() ![]()  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | 0..1 | Reference(FI Base Organization(2.0.0-ci)) | Who is responsible for publishing the recommendations | |||||||||||
![]() ![]() ![]()  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ?? (example): The vaccine preventable disease the dose is being administered for.  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ?? (example): The vaccine preventable disease the dose is being administered for.  | |||||||||||
![]() ![]() ![]() ![]()  | 0..1 | string | Unique id for inter-element referencing | 
  | |||||||||||||
![]() ![]() ![]() ![]()  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | 
  | |||||||||||||
![]() ![]() ![]() ![]()  | Σ | 0..* | Coding | Vaccine preventatable disease being targetted defined by using THL code system Slice: Unordered, Open by value:system  | 
  | ||||||||||||
![]() ![]() ![]() ![]()  | Σ | 0..1 | string | Plain text representation of the concept | 
  | ||||||||||||
![]() ![]() ![]()  | 1..1 | positiveInt, string | Dose number within series | 1..1 | positiveInt, string | Dose number within series | |||||||||||
![]() ![]() ![]()  | 0..1 | positiveInt, string | Recommended number of doses for immunity | 0..1 | positiveInt, string | Recommended number of doses for immunity | |||||||||||
  Documentation for this format | |||||||||||||||||