Austrian Patient Summary (R4)
1.1.0 - STU2

Austrian Patient Summary (R4) - Local Development build (v1.1.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-immunizationrecommendation | Version: 1.1.0
Active as of 2026-02-17 | Computable Name: AtApsImmunizationRecommendation

Das AT APS-Profil für die ImmunizationRecommendation-Ressource berücksichtigt die österreichischen Vorgaben (z.B. Patient und zu verwendende Value-Sets).

Usages:

- Refer to this Profile: AT APS Composition
- Examples for this Profile: ImmunizationRecommendation/AtApsExampleImmunizationRecommendation01

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.

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ImmunizationRecommendation |  | 0..* | ImmunizationRecommendation | AT APS Immunization
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
patient | Σ | 1..1 | Reference(AT APS Patient) | Who this profile is for
date | Σ | 1..1 | dateTime | Date recommendation(s) created
authority |  | 0..1 | Reference(AT APS Organization) | Who is responsible for protocol
recommendation | Σ C | 1..* | BackboneElement | Vaccine administration recommendations Constraints: imr-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
forecastStatus | ?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: https://termgit.elga.gv.at/ValueSet/eimpf-specialcasevaccination (extensible)
supportingImmunization |  | 0..* | Reference(AT APS Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
ImmunizationRecommendation.​recommendation.forecastStatus | Base | extensible | https://termgit.elga.gv.at/ValueSet/eimpf-specialcasevaccination | Not State | Unknown

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | ImmunizationRecommendation | 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 | ImmunizationRecommendation | 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 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | ImmunizationRecommendation | 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()`
imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present | `vaccineCode.exists() or targetDisease.exists()`

This structure is derived from ImmunizationRecommendation

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ImmunizationRecommendation |  | 0..* | ImmunizationRecommendation | AT APS Immunization
patient |  | 1..1 | Reference(AT APS Patient) | Who this profile is for
authority |  | 0..1 | Reference(AT APS Organization) | Who is responsible for protocol
recommendation |  |  |  |
forecastStatus |  | 1..1 | CodeableConcept | Vaccine recommendation status Binding: https://termgit.elga.gv.at/ValueSet/eimpf-specialcasevaccination (extensible)
supportingImmunization |  | 0..* | Reference(AT APS Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
ImmunizationRecommendation.​recommendation.forecastStatus | Base | extensible | https://termgit.elga.gv.at/ValueSet/eimpf-specialcasevaccination | Not State | Unknown

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ImmunizationRecommendation |  | 0..* | ImmunizationRecommendation | AT APS Immunization
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Business identifier
patient | Σ | 1..1 | Reference(AT APS Patient) | Who this profile is for
date | Σ | 1..1 | dateTime | Date recommendation(s) created
authority |  | 0..1 | Reference(AT APS Organization) | Who is responsible for protocol
recommendation | Σ C | 1..* | BackboneElement | Vaccine administration recommendations Constraints: imr-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
vaccineCode | Σ | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
targetDisease | Σ | 0..1 | CodeableConcept | Disease to be immunized against Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.
contraindicatedVaccineCode | Σ | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
forecastStatus | ?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: https://termgit.elga.gv.at/ValueSet/eimpf-specialcasevaccination (extensible)
forecastReason | Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
dateCriterion |  | 0..* | BackboneElement | Dates governing proposed 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
code |  | 1..1 | CodeableConcept | Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
value |  | 1..1 | dateTime | Recommended date
description |  | 0..1 | string | Protocol details
series |  | 0..1 | string | Name of vaccination series
doseNumber[x] | Σ | 0..1 |  | Recommended dose number within series
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
seriesDoses[x] |  | 0..1 |  | Recommended number of doses for immunity
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
supportingImmunization |  | 0..* | Reference(AT APS Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation
supportingPatientInformation |  | 0..* | Reference(Resource) | Patient observations supporting recommendation
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
ImmunizationRecommendation.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode | Base | example | Vaccine Administered Value Set | 📍4.0.1 | FHIR Std.
ImmunizationRecommendation.​recommendation.targetDisease | Base | example | Immunization Recommendation Target Disease Codes | 📍4.0.1 | FHIR Std.
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode | Base | example | Vaccine Administered Value Set | 📍4.0.1 | FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus | Base | extensible | https://termgit.elga.gv.at/ValueSet/eimpf-specialcasevaccination | Not State | Unknown
ImmunizationRecommendation.​recommendation.forecastReason | Base | example | Immunization Recommendation Reason Codes | 📍4.0.1 | FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code | Base | example | Immunization Recommendation Date Criterion Codes | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | ImmunizationRecommendation | 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 | ImmunizationRecommendation | 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 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | ImmunizationRecommendation | 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()`
imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present | `vaccineCode.exists() or targetDisease.exists()`

This structure is derived from ImmunizationRecommendation

Summary

Structures

This structure refers to these other structures:

- AT APS Patient (https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-patient)
- AT APS Organization (https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-organization)
- AT APS Immunization (https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-immunization)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ImmunizationRecommendation |  | 0..* | ImmunizationRecommendation | AT APS Immunization
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
patient | Σ | 1..1 | Reference(AT APS Patient) | Who this profile is for
date | Σ | 1..1 | dateTime | Date recommendation(s) created
authority |  | 0..1 | Reference(AT APS Organization) | Who is responsible for protocol
recommendation | Σ C | 1..* | BackboneElement | Vaccine administration recommendations Constraints: imr-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
forecastStatus | ?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: https://termgit.elga.gv.at/ValueSet/eimpf-specialcasevaccination (extensible)
supportingImmunization |  | 0..* | Reference(AT APS Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
ImmunizationRecommendation.​recommendation.forecastStatus | Base | extensible | https://termgit.elga.gv.at/ValueSet/eimpf-specialcasevaccination | Not State | Unknown

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | ImmunizationRecommendation | 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 | ImmunizationRecommendation | 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 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | ImmunizationRecommendation | 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()`
imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present | `vaccineCode.exists() or targetDisease.exists()`

Differential View

This structure is derived from ImmunizationRecommendation

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ImmunizationRecommendation |  | 0..* | ImmunizationRecommendation | AT APS Immunization
patient |  | 1..1 | Reference(AT APS Patient) | Who this profile is for
authority |  | 0..1 | Reference(AT APS Organization) | Who is responsible for protocol
recommendation |  |  |  |
forecastStatus |  | 1..1 | CodeableConcept | Vaccine recommendation status Binding: https://termgit.elga.gv.at/ValueSet/eimpf-specialcasevaccination (extensible)
supportingImmunization |  | 0..* | Reference(AT APS Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
ImmunizationRecommendation.​recommendation.forecastStatus | Base | extensible | https://termgit.elga.gv.at/ValueSet/eimpf-specialcasevaccination | Not State | Unknown

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ImmunizationRecommendation |  | 0..* | ImmunizationRecommendation | AT APS Immunization
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Business identifier
patient | Σ | 1..1 | Reference(AT APS Patient) | Who this profile is for
date | Σ | 1..1 | dateTime | Date recommendation(s) created
authority |  | 0..1 | Reference(AT APS Organization) | Who is responsible for protocol
recommendation | Σ C | 1..* | BackboneElement | Vaccine administration recommendations Constraints: imr-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
vaccineCode | Σ | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
targetDisease | Σ | 0..1 | CodeableConcept | Disease to be immunized against Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.
contraindicatedVaccineCode | Σ | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
forecastStatus | ?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: https://termgit.elga.gv.at/ValueSet/eimpf-specialcasevaccination (extensible)
forecastReason | Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
dateCriterion |  | 0..* | BackboneElement | Dates governing proposed 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
code |  | 1..1 | CodeableConcept | Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
value |  | 1..1 | dateTime | Recommended date
description |  | 0..1 | string | Protocol details
series |  | 0..1 | string | Name of vaccination series
doseNumber[x] | Σ | 0..1 |  | Recommended dose number within series
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
seriesDoses[x] |  | 0..1 |  | Recommended number of doses for immunity
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
supportingImmunization |  | 0..* | Reference(AT APS Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation
supportingPatientInformation |  | 0..* | Reference(Resource) | Patient observations supporting recommendation
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
ImmunizationRecommendation.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode | Base | example | Vaccine Administered Value Set | 📍4.0.1 | FHIR Std.
ImmunizationRecommendation.​recommendation.targetDisease | Base | example | Immunization Recommendation Target Disease Codes | 📍4.0.1 | FHIR Std.
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode | Base | example | Vaccine Administered Value Set | 📍4.0.1 | FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus | Base | extensible | https://termgit.elga.gv.at/ValueSet/eimpf-specialcasevaccination | Not State | Unknown
ImmunizationRecommendation.​recommendation.forecastReason | Base | example | Immunization Recommendation Reason Codes | 📍4.0.1 | FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code | Base | example | Immunization Recommendation Date Criterion Codes | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | ImmunizationRecommendation | 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 | ImmunizationRecommendation | 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 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | ImmunizationRecommendation | 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()`
imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present | `vaccineCode.exists() or targetDisease.exists()`

This structure is derived from ImmunizationRecommendation

Summary

Structures

This structure refers to these other structures:

- AT APS Patient (https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-patient)
- AT APS Organization (https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-organization)
- AT APS Immunization (https://fhir.hl7.at/elga/aps/r4/StructureDefinition/at-aps-immunization)

Other representations of profile: CSV, Excel, Schematron