Austrian Patient Summary (R4) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

Resource Profile: AT APS Immunization

Official URL: https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-immunization				Version: 0.1.0
Active as of 2025-04-03		Responsible: ELGA GmbH	Realm:	Computable Name: AtApsImmunization

This AT APS profile for the Immunization resource is derived from the general Immunization resource in absence of a corresponding profile in the HL7® Austria FHIR® Core implementation guide and also ensures IPS conformity via the IPS profile referenced by the so-called imposeProfile extension.

Usage:

• Use this Resource Profile: AT APS Bundle
• Refer to this Resource Profile: AT APS Composition
• Examples for this Resource Profile: Immunization/immunization-vaccine-unknown

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

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

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	AT APS Immunization This profile also imposes the profile Immunization (IPS) 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
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
Slices for extension		0..*	Extension	Extension 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
extension:basedOn		0..1	Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)	Immunization basedOn URL: https://fhir.hl7.at/elga/aps/r4/StructureDefinition/immunization-basedOn 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
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. ele-1: All FHIR elements must have a @value or children
vaccineCode	Σ	1..1	CodeableConcept	Vaccine product administered Binding: AT APS Immunitzation Vaccine Codes (extensible) Additional Bindings Purpose https://termgit.elga.gv.at/ValueSet/eimpf-historischeimpfstoffe candidate ele-1: All FHIR elements must have a @value or children
patient	Σ	1..1	Reference(AT APS Patient)	Who was immunized ele-1: All FHIR elements must have a @value or children
occurrence[x]	Σ	1..1		Vaccine administration date ele-1: All FHIR elements must have a @value or children
occurrenceDateTime			dateTime
occurrenceString			string
route		0..1	CodeableConcept	How vaccine entered body Binding: https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung (extensible) 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
protocolApplied		1..*	BackboneElement	Protocol followed by the provider ele-1: All FHIR elements must have a @value or children
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
targetDisease		1..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget (extensible) 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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.vaccineCode	extensible	AtApsImmunizationVaccineCodes https://fhir.hl7.at/elga/aps/r4/ValueSet/at-aps-immunization-vaccine-codes from this IG
Immunization.route	extensible	https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung
Immunization.protocolApplied.targetDisease	extensible	https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget

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()

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	AT APS Immunization This profile also imposes the profile Immunization (IPS)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:basedOn		0..1	Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)	Immunization basedOn URL: https://fhir.hl7.at/elga/aps/r4/StructureDefinition/immunization-basedOn
vaccineCode		1..1	CodeableConcept	Vaccine product administered Binding: AT APS Immunitzation Vaccine Codes (extensible) Additional Bindings Purpose https://termgit.elga.gv.at/ValueSet/eimpf-historischeimpfstoffe candidate
patient		1..1	Reference(AT APS Patient)	Who was immunized
route		0..1	CodeableConcept	How vaccine entered body Binding: https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung (extensible)
protocolApplied		1..*	BackboneElement	Protocol followed by the provider
targetDisease		1..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget (extensible)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.vaccineCode	extensible	AtApsImmunizationVaccineCodes https://fhir.hl7.at/elga/aps/r4/ValueSet/at-aps-immunization-vaccine-codes from this IG
Immunization.route	extensible	https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung
Immunization.protocolApplied.targetDisease	extensible	https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	AT APS Immunization This profile also imposes the profile Immunization (IPS)
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
extension:basedOn		0..1	Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)	Immunization basedOn URL: https://fhir.hl7.at/elga/aps/r4/StructureDefinition/immunization-basedOn
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business identifier
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	Σ	1..1	CodeableConcept	Vaccine product administered Binding: AT APS Immunitzation Vaccine Codes (extensible) Additional Bindings Purpose https://termgit.elga.gv.at/ValueSet/eimpf-historischeimpfstoffe candidate
patient	Σ	1..1	Reference(AT APS Patient)	Who was immunized
encounter		0..1	Reference(Encounter)	Encounter immunization was part of
occurrence[x]	Σ	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(Location)	Where immunization occurred
manufacturer		0..1	Reference(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.
route		0..1	CodeableConcept	How vaccine entered body Binding: https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung (extensible)
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(Practitioner | PractitionerRole | 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(Condition | 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 imm-1: One of documentType or reference SHALL be present
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(Observation)	Additional information on reaction
reported		0..1	boolean	Indicates self-reported reaction
protocolApplied		1..*	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(Organization)	Who is responsible for publishing the recommendations
targetDisease		1..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget (extensible)
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	URI
Immunization.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	extensible	AtApsImmunizationVaccineCodes https://fhir.hl7.at/elga/aps/r4/ValueSet/at-aps-immunization-vaccine-codes from this IG
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	extensible	https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	extensible	https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget

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 Immunization

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

• AT APS Patient (https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-patient)

Extensions

This structure refers to these extensions:

• https://fhir.hl7.at/elga/aps/r4/StructureDefinition/immunization-basedOn

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	AT APS Immunization This profile also imposes the profile Immunization (IPS) 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
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
Slices for extension		0..*	Extension	Extension 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
extension:basedOn		0..1	Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)	Immunization basedOn URL: https://fhir.hl7.at/elga/aps/r4/StructureDefinition/immunization-basedOn 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
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. ele-1: All FHIR elements must have a @value or children
vaccineCode	Σ	1..1	CodeableConcept	Vaccine product administered Binding: AT APS Immunitzation Vaccine Codes (extensible) Additional Bindings Purpose https://termgit.elga.gv.at/ValueSet/eimpf-historischeimpfstoffe candidate ele-1: All FHIR elements must have a @value or children
patient	Σ	1..1	Reference(AT APS Patient)	Who was immunized ele-1: All FHIR elements must have a @value or children
occurrence[x]	Σ	1..1		Vaccine administration date ele-1: All FHIR elements must have a @value or children
occurrenceDateTime			dateTime
occurrenceString			string
route		0..1	CodeableConcept	How vaccine entered body Binding: https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung (extensible) 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
protocolApplied		1..*	BackboneElement	Protocol followed by the provider ele-1: All FHIR elements must have a @value or children
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
targetDisease		1..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget (extensible) 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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.vaccineCode	extensible	AtApsImmunizationVaccineCodes https://fhir.hl7.at/elga/aps/r4/ValueSet/at-aps-immunization-vaccine-codes from this IG
Immunization.route	extensible	https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung
Immunization.protocolApplied.targetDisease	extensible	https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget

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()

Differential View

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	AT APS Immunization This profile also imposes the profile Immunization (IPS)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:basedOn		0..1	Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)	Immunization basedOn URL: https://fhir.hl7.at/elga/aps/r4/StructureDefinition/immunization-basedOn
vaccineCode		1..1	CodeableConcept	Vaccine product administered Binding: AT APS Immunitzation Vaccine Codes (extensible) Additional Bindings Purpose https://termgit.elga.gv.at/ValueSet/eimpf-historischeimpfstoffe candidate
patient		1..1	Reference(AT APS Patient)	Who was immunized
route		0..1	CodeableConcept	How vaccine entered body Binding: https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung (extensible)
protocolApplied		1..*	BackboneElement	Protocol followed by the provider
targetDisease		1..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget (extensible)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.vaccineCode	extensible	AtApsImmunizationVaccineCodes https://fhir.hl7.at/elga/aps/r4/ValueSet/at-aps-immunization-vaccine-codes from this IG
Immunization.route	extensible	https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung
Immunization.protocolApplied.targetDisease	extensible	https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	AT APS Immunization This profile also imposes the profile Immunization (IPS)
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
extension:basedOn		0..1	Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)	Immunization basedOn URL: https://fhir.hl7.at/elga/aps/r4/StructureDefinition/immunization-basedOn
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business identifier
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	Σ	1..1	CodeableConcept	Vaccine product administered Binding: AT APS Immunitzation Vaccine Codes (extensible) Additional Bindings Purpose https://termgit.elga.gv.at/ValueSet/eimpf-historischeimpfstoffe candidate
patient	Σ	1..1	Reference(AT APS Patient)	Who was immunized
encounter		0..1	Reference(Encounter)	Encounter immunization was part of
occurrence[x]	Σ	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(Location)	Where immunization occurred
manufacturer		0..1	Reference(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.
route		0..1	CodeableConcept	How vaccine entered body Binding: https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung (extensible)
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(Practitioner | PractitionerRole | 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(Condition | 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 imm-1: One of documentType or reference SHALL be present
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(Observation)	Additional information on reaction
reported		0..1	boolean	Indicates self-reported reaction
protocolApplied		1..*	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(Organization)	Who is responsible for publishing the recommendations
targetDisease		1..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget (extensible)
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	URI
Immunization.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	extensible	AtApsImmunizationVaccineCodes https://fhir.hl7.at/elga/aps/r4/ValueSet/at-aps-immunization-vaccine-codes from this IG
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	extensible	https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	extensible	https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget

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 Immunization

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

• AT APS Patient (https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-patient)

Extensions

This structure refers to these extensions:

• https://fhir.hl7.at/elga/aps/r4/StructureDefinition/immunization-basedOn

Other representations of profile: CSV, Excel, Schematron