Austrian Patient Summary (R4)
0.2.0 - STU1

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

Resource Profile: AT APS Immunization

Official URL: https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-immunization Version: 0.2.0
Active as of 2025-10-06 Computable Name: AtApsImmunization

Das AT APS-Profil für die Immunization-Ressource berücksichtigt zum einen die österreichischen Vorgaben (z.B. Patient und zu verwendende Value-Sets) und stellt andererseits die Konformität gegenüber dem IPS-Profil sicher, indem die so genannte imposeProfile-Erweiterung verwendet wird.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization AT APS Immunization
This profile also imposes the profile Immunization (IPS)
... 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
.... extension:basedOn 0..1 Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) Immunization basedOn
URL: https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-ext-immunization-basedOn
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: AT APS Immunitzation Vaccine Codes (extensible)
Additional BindingsPurpose
https://termgit.elga.gv.at/ValueSet/eimpf-historischeimpfstoffe candidate
... patient Σ 1..1 Reference(AT APS Patient) Who was immunized
... occurrence[x] Σ 1..1 Vaccine administration date
.... occurrenceDateTime dateTime
.... occurrenceString string
... route 0..1 CodeableConcept How vaccine entered body
Binding: https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung (extensible)
... isSubpotent ?!Σ 0..1 boolean Dose potency
... protocolApplied 1..* BackboneElement Protocol followed by the provider
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base extensible AT APS Immunitzation Vaccine Codes 📦0.2.0 This IG
Immunization.route Base extensible https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung Not Stated Unknown
Immunization.protocolApplied.​targetDisease Base extensible https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget Not Stated Unknown

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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/at-aps-ext-immunization-basedOn
... vaccineCode 1..1 CodeableConcept Vaccine product administered
Binding: AT APS Immunitzation Vaccine Codes (extensible)
Additional BindingsPurpose
https://termgit.elga.gv.at/ValueSet/eimpf-historischeimpfstoffe candidate
... patient 1..1 Reference(AT APS Patient) Who was immunized
... 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)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.vaccineCode Base extensible AT APS Immunitzation Vaccine Codes 📦0.2.0 This IG
Immunization.route Base extensible https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung Not Stated Unknown
Immunization.protocolApplied.​targetDisease Base extensible https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget Not Stated Unknown
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... 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/at-aps-ext-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 BindingsPurpose
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(4.0.1) 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
Constraints: imm-1
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.statusReason Base example Immunization Status Reason Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base extensible AT APS Immunitzation Vaccine Codes 📦0.2.0 This IG
Immunization.reportOrigin Base example Immunization Origin Codes 📍4.0.1 FHIR Std.
Immunization.site Base example Codes for Immunization Site of Administration 📍4.0.1 FHIR Std.
Immunization.route Base extensible https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung Not Stated Unknown
Immunization.performer.​function Base extensible Immunization Function Codes 📍4.0.1 FHIR Std.
Immunization.reasonCode Base example Immunization Reason Codes 📍4.0.1 FHIR Std.
Immunization.subpotentReason Base example Immunization Subpotent Reason 📍4.0.1 FHIR Std.
Immunization.programEligibility Base example Immunization Program Eligibility 📍4.0.1 FHIR Std.
Immunization.fundingSource Base example Immunization Funding Source 📍4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base extensible https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget Not Stated Unknown

Constraints

Id Grade Path(s) Description Expression
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:

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization AT APS Immunization
This profile also imposes the profile Immunization (IPS)
... 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
.... extension:basedOn 0..1 Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) Immunization basedOn
URL: https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-ext-immunization-basedOn
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: AT APS Immunitzation Vaccine Codes (extensible)
Additional BindingsPurpose
https://termgit.elga.gv.at/ValueSet/eimpf-historischeimpfstoffe candidate
... patient Σ 1..1 Reference(AT APS Patient) Who was immunized
... occurrence[x] Σ 1..1 Vaccine administration date
.... occurrenceDateTime dateTime
.... occurrenceString string
... route 0..1 CodeableConcept How vaccine entered body
Binding: https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung (extensible)
... isSubpotent ?!Σ 0..1 boolean Dose potency
... protocolApplied 1..* BackboneElement Protocol followed by the provider
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base extensible AT APS Immunitzation Vaccine Codes 📦0.2.0 This IG
Immunization.route Base extensible https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung Not Stated Unknown
Immunization.protocolApplied.​targetDisease Base extensible https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget Not Stated Unknown

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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/at-aps-ext-immunization-basedOn
... vaccineCode 1..1 CodeableConcept Vaccine product administered
Binding: AT APS Immunitzation Vaccine Codes (extensible)
Additional BindingsPurpose
https://termgit.elga.gv.at/ValueSet/eimpf-historischeimpfstoffe candidate
... patient 1..1 Reference(AT APS Patient) Who was immunized
... 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)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.vaccineCode Base extensible AT APS Immunitzation Vaccine Codes 📦0.2.0 This IG
Immunization.route Base extensible https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung Not Stated Unknown
Immunization.protocolApplied.​targetDisease Base extensible https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget Not Stated Unknown

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... 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/at-aps-ext-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 BindingsPurpose
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(4.0.1) 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
Constraints: imm-1
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.statusReason Base example Immunization Status Reason Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base extensible AT APS Immunitzation Vaccine Codes 📦0.2.0 This IG
Immunization.reportOrigin Base example Immunization Origin Codes 📍4.0.1 FHIR Std.
Immunization.site Base example Codes for Immunization Site of Administration 📍4.0.1 FHIR Std.
Immunization.route Base extensible https://termgit.elga.gv.at/ValueSet/eimpf-medikationartanwendung Not Stated Unknown
Immunization.performer.​function Base extensible Immunization Function Codes 📍4.0.1 FHIR Std.
Immunization.reasonCode Base example Immunization Reason Codes 📍4.0.1 FHIR Std.
Immunization.subpotentReason Base example Immunization Subpotent Reason 📍4.0.1 FHIR Std.
Immunization.programEligibility Base example Immunization Program Eligibility 📍4.0.1 FHIR Std.
Immunization.fundingSource Base example Immunization Funding Source 📍4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base extensible https://termgit.elga.gv.at/ValueSet/eimpf-immunizationtarget Not Stated Unknown

Constraints

Id Grade Path(s) Description Expression
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:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron