Scope and usage

This profile sets minimum expectations for the Immunization resource. It identifies which core elements, extensions, vocabularies, and value sets could be present in the resource when using this profile. It provides the floor for standards development for specific use cases.

IPA Immunization profile limitations

Finnish base immunization profile is based on the IPA immunization profile which imposes some further constraints on the base Immunization resource.

Vaccination Recorder extension

In some cases the practitioner who performed the addministration is not be the same person who recorded the action. For these cases the vaccinationRecorder extension is created. Recorder is not required information when recording vaccination to the Kanta’s Patient Data Repository or Hilmo system but it may be an essential information for EHR.

Finnish National Vaccination Register

All vaccinations in Finland are recorded into Kanta’s Patient Data Repository and Hilmo system. Eventually these system determine the required information, at least when recording vaccination. It is highly recommended to familiarize onself with the specification when applying this profile although all of the fields may not be relevant in given use case.

ATC and VNR codes

See also the terminology section of Medication Codes in this guide.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from IPAImmunization

Name	Flags	Card.	Type	Description & Constraints
Immunization			IPAImmunization
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
vaccinationRecorder		0..1	Reference(FI Base Practitioner)	Vaccination recorder may not be the same person who performed the addministration. URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/vaccination-recorder
vaccineCode
Slices for coding		0..*	Coding	Defining administered product or substance by using ATC or VNR code. Slice: Unordered, Open by value:system
coding:ATC		0..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.32
coding:VNR		0..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.55
text		0..1	string	Insert product name.
patient		1..1	Reference(FI Base Patient)	Who was immunized
encounter		0..1	Reference(FI Base Encounter)	Encounter immunization was part of
location		0..1	Reference(FI Base Location)	Where immunization occurred
manufacturer		0..1	Reference(FI Base Organization)	Vaccine manufacturer
site
Slices for coding		0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:Vaccination-site		0..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.110
route
Slices for coding		0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:Vaccination-route		0..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.111
performer
actor		1..1	Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Organization)	Individual or organization who was performing
reasonReference		0..*	Reference(FI Base Condition | FI Base Observation | DiagnosticReport)	Why immunization occurred
reaction
detail		0..1	Reference(FI Base Observation)	Reference to contained Observation resource. The contained Observation has relevant diagnose codes.
protocolApplied
authority		0..1	Reference(FI Base Organization)	Who is responsible for publishing the recommendations
targetDisease
Slices for coding		0..*	Coding	Vaccine preventatable disease being targetted defined by using THL code system Slice: Unordered, Open by value:system
coding:THL-code		0..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.609
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	IPAImmunization	Immunization event information
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
vaccinationRecorder		0..1	Reference(FI Base Practitioner)	Vaccination recorder may not be the same person who performed the addministration. URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/vaccination-recorder
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Slices for coding	Σ	0..*	Coding	Defining administered product or substance by using ATC or VNR code. Slice: Unordered, Open by value:system
coding:ATC	Σ	0..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.32
coding:VNR	Σ	0..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.55
text	Σ	0..1	string	Insert product name.
patient	SΣ	1..1	Reference(FI Base Patient)	Who was immunized
encounter		0..1	Reference(FI Base Encounter)	Encounter immunization was part of
occurrence[x]	SΣ	1..1		Vaccine administration date
occurrenceDateTime			dateTime
occurrenceString			string
location		0..1	Reference(FI Base Location)	Where immunization occurred
manufacturer		0..1	Reference(FI Base Organization)	Vaccine manufacturer
reasonReference		0..*	Reference(FI Base Condition | FI Base Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Immunization.status	required	ImmunizationStatusCodes
Immunization.statusReason	example	ImmunizationStatusReasonCodes
Immunization.vaccineCode	example	VaccineAdministeredValueSet

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	IPAImmunization	Immunization event information
id	Σ	0..1	id	Logical id of this artifact
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	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
vaccinationRecorder		0..1	Reference(FI Base Practitioner)	Vaccination recorder may not be the same person who performed the addministration. URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/vaccination-recorder
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business identifier
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Defining administered product or substance by using ATC or VNR code. Slice: Unordered, Open by value:system
coding:ATC	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.32
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:VNR	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.55
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Insert product name.
patient	SΣ	1..1	Reference(FI Base Patient)	Who was immunized
encounter		0..1	Reference(FI Base Encounter)	Encounter immunization was part of
occurrence[x]	SΣ	1..1		Vaccine administration date
occurrenceDateTime			dateTime
occurrenceString			string
recorded		0..1	dateTime	When the immunization was first captured in the subject's record
primarySource	Σ	0..1	boolean	Indicates context the data was recorded in
reportOrigin		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.
location		0..1	Reference(FI Base Location)	Where immunization occurred
manufacturer		0..1	Reference(FI Base Organization)	Vaccine manufacturer
lotNumber		0..1	string	Vaccine lot number
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:Vaccination-site	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.110
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
route		0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:Vaccination-route	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.111
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
doseQuantity		0..1	SimpleQuantity	Amount of vaccine administered
performer	Σ	0..*	BackboneElement	Who performed event
id		0..1	string	Unique id for inter-element referencing
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: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	Σ	1..1	Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Organization)	Individual or organization who was performing
note	Σ	0..*	Annotation	Additional immunization notes
reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference		0..*	Reference(FI Base Condition | FI Base Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..*	BackboneElement	Educational material presented to patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
documentType		0..1	string	Educational material document identifier
reference		0..1	uri	Educational material reference pointer
publicationDate		0..1	dateTime	Educational material publication date
presentationDate		0..1	dateTime	Educational material presentation date
programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction		0..*	BackboneElement	Details of a reaction that follows immunization
id		0..1	string	Unique id for inter-element referencing
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(FI Base Observation)	Reference to contained Observation resource. The contained Observation has relevant diagnose codes.
reported		0..1	boolean	Indicates self-reported reaction
protocolApplied		0..*	BackboneElement	Protocol followed by the provider
id		0..1	string	Unique id for inter-element referencing
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(FI Base Organization)	Who is responsible for publishing the recommendations
targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Vaccine preventatable disease being targetted defined by using THL code system Slice: Unordered, Open by value:system
coding:THL-code	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.609
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
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

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
imm-1	error	Immunization.education	One of documentType or reference SHALL be present : documentType.exists() or reference.exists()

Differential View

This structure is derived from IPAImmunization

Name	Flags	Card.	Type	Description & Constraints
Immunization			IPAImmunization
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
vaccinationRecorder		0..1	Reference(FI Base Practitioner)	Vaccination recorder may not be the same person who performed the addministration. URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/vaccination-recorder
vaccineCode
Slices for coding		0..*	Coding	Defining administered product or substance by using ATC or VNR code. Slice: Unordered, Open by value:system
coding:ATC		0..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.32
coding:VNR		0..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.55
text		0..1	string	Insert product name.
patient		1..1	Reference(FI Base Patient)	Who was immunized
encounter		0..1	Reference(FI Base Encounter)	Encounter immunization was part of
location		0..1	Reference(FI Base Location)	Where immunization occurred
manufacturer		0..1	Reference(FI Base Organization)	Vaccine manufacturer
site
Slices for coding		0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:Vaccination-site		0..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.110
route
Slices for coding		0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:Vaccination-route		0..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.111
performer
actor		1..1	Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Organization)	Individual or organization who was performing
reasonReference		0..*	Reference(FI Base Condition | FI Base Observation | DiagnosticReport)	Why immunization occurred
reaction
detail		0..1	Reference(FI Base Observation)	Reference to contained Observation resource. The contained Observation has relevant diagnose codes.
protocolApplied
authority		0..1	Reference(FI Base Organization)	Who is responsible for publishing the recommendations
targetDisease
Slices for coding		0..*	Coding	Vaccine preventatable disease being targetted defined by using THL code system Slice: Unordered, Open by value:system
coding:THL-code		0..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.609
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	IPAImmunization	Immunization event information
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
vaccinationRecorder		0..1	Reference(FI Base Practitioner)	Vaccination recorder may not be the same person who performed the addministration. URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/vaccination-recorder
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Slices for coding	Σ	0..*	Coding	Defining administered product or substance by using ATC or VNR code. Slice: Unordered, Open by value:system
coding:ATC	Σ	0..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.32
coding:VNR	Σ	0..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.55
text	Σ	0..1	string	Insert product name.
patient	SΣ	1..1	Reference(FI Base Patient)	Who was immunized
encounter		0..1	Reference(FI Base Encounter)	Encounter immunization was part of
occurrence[x]	SΣ	1..1		Vaccine administration date
occurrenceDateTime			dateTime
occurrenceString			string
location		0..1	Reference(FI Base Location)	Where immunization occurred
manufacturer		0..1	Reference(FI Base Organization)	Vaccine manufacturer
reasonReference		0..*	Reference(FI Base Condition | FI Base Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Immunization.status	required	ImmunizationStatusCodes
Immunization.statusReason	example	ImmunizationStatusReasonCodes
Immunization.vaccineCode	example	VaccineAdministeredValueSet

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	IPAImmunization	Immunization event information
id	Σ	0..1	id	Logical id of this artifact
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	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
vaccinationRecorder		0..1	Reference(FI Base Practitioner)	Vaccination recorder may not be the same person who performed the addministration. URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/vaccination-recorder
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business identifier
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Defining administered product or substance by using ATC or VNR code. Slice: Unordered, Open by value:system
coding:ATC	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.32
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:VNR	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.55
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Insert product name.
patient	SΣ	1..1	Reference(FI Base Patient)	Who was immunized
encounter		0..1	Reference(FI Base Encounter)	Encounter immunization was part of
occurrence[x]	SΣ	1..1		Vaccine administration date
occurrenceDateTime			dateTime
occurrenceString			string
recorded		0..1	dateTime	When the immunization was first captured in the subject's record
primarySource	Σ	0..1	boolean	Indicates context the data was recorded in
reportOrigin		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.
location		0..1	Reference(FI Base Location)	Where immunization occurred
manufacturer		0..1	Reference(FI Base Organization)	Vaccine manufacturer
lotNumber		0..1	string	Vaccine lot number
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:Vaccination-site	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.110
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
route		0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:Vaccination-route	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.111
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
doseQuantity		0..1	SimpleQuantity	Amount of vaccine administered
performer	Σ	0..*	BackboneElement	Who performed event
id		0..1	string	Unique id for inter-element referencing
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: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	Σ	1..1	Reference(FI Base Practitioner | FI Base PractitionerRole | FI Base Organization)	Individual or organization who was performing
note	Σ	0..*	Annotation	Additional immunization notes
reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference		0..*	Reference(FI Base Condition | FI Base Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..*	BackboneElement	Educational material presented to patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
documentType		0..1	string	Educational material document identifier
reference		0..1	uri	Educational material reference pointer
publicationDate		0..1	dateTime	Educational material publication date
presentationDate		0..1	dateTime	Educational material presentation date
programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction		0..*	BackboneElement	Details of a reaction that follows immunization
id		0..1	string	Unique id for inter-element referencing
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(FI Base Observation)	Reference to contained Observation resource. The contained Observation has relevant diagnose codes.
reported		0..1	boolean	Indicates self-reported reaction
protocolApplied		0..*	BackboneElement	Protocol followed by the provider
id		0..1	string	Unique id for inter-element referencing
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(FI Base Organization)	Who is responsible for publishing the recommendations
targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Vaccine preventatable disease being targetted defined by using THL code system Slice: Unordered, Open by value:system
coding:THL-code	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.609
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
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

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
imm-1	error	Immunization.education	One of documentType or reference SHALL be present : documentType.exists() or reference.exists()

This structure is derived from IPAImmunization

Summary

Mandatory: 0 element (5 nested mandatory elements)

Structures

This structure refers to these other structures:

• FI Base Patient (https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/fi-base-patient)
• FI Base Encounter (https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/fi-base-encounter)
• FI Base Location (https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/fi-base-location)
• FI Base Organization (https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/fi-base-organization)
• FI Base Practitioner (https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/fi-base-practitioner)
• FI Base PractitionerRole (https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/fi-base-practitioner-role)
• FI Base Condition (https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/fi-base-condition)
• FI Base Observation (https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/fi-base-observation)

Extensions

This structure refers to these extensions:

• https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/vaccination-recorder

Slices

This structure defines the following Slices:

• The element Immunization.vaccineCode.coding is sliced based on the value of value:system
• The element Immunization.site.coding is sliced based on the value of value:system
• The element Immunization.route.coding is sliced based on the value of value:system
• The element Immunization.protocolApplied.targetDisease.coding is sliced based on the value of value:system