Implementation Guide
Version 1.4.0 - release

Resource Profile: ATF Operation Outcome

Official URL: https://gematik.de/fhir/atf/StructureDefinition/atf-operation-outcome Version: 1.4.0
Active as of 2025-07-29 Computable Name: ATFOperationOutcome

Antwort auf eine eingegangene ATF Anfrage

Motivation

Um sicherzustellen, dass die Nachricht verarbeitet werden kann wird über das ATF eine OperationOutcome übermittelt. Diese enthält die information, ob die Verarbeitung der Nachricht erfolgreich war (.issue.code = #informational), oder ob die Anfrage aufgrund von Verarbeitungs- (.issue.code = #processing) oder strukturellen Fehlern (.issue.code = #invalid) nicht bearbeitet werden kann.

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
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:MessageID S 1..1 string Extension
URL: https://gematik.de/fhir/atf/StructureDefinition/atf-message-id-ex
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... severity Σ 1..1 code fatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.
.... code SΣ 1..1 code Art der Antwort
Binding: Issue Type VS (required)
.... diagnostics SΣ 1..1 string Zusatzinformationen

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
OperationOutcome.issue.severityrequiredIssueSeverity
http://hl7.org/fhir/ValueSet/issue-severity|4.0.1
From the FHIR Standard
OperationOutcome.issue.coderequiredIssueTypeVS
https://gematik.de/fhir/atf/ValueSet/issue-type-vs
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOperationOutcomeIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOperationOutcomeIf 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-4errorOperationOutcomeIf 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-5errorOperationOutcomeIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOperationOutcomeA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from OperationOutcome

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:MessageID S 1..1 string Extension
URL: https://gematik.de/fhir/atf/StructureDefinition/atf-message-id-ex
... issue S 1..* BackboneElement A single issue associated with the action
.... code S 1..1 code Art der Antwort
Binding: Issue Type VS (required)
.... diagnostics S 1..1 string Zusatzinformationen

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
OperationOutcome.issue.coderequiredIssueTypeVS
https://gematik.de/fhir/atf/ValueSet/issue-type-vs
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
... 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
... 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 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:MessageID S 1..1 string Extension
URL: https://gematik.de/fhir/atf/StructureDefinition/atf-message-id-ex
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... issue SΣ 1..* BackboneElement A single issue associated with the action
.... 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
.... severity Σ 1..1 code fatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.
.... code SΣ 1..1 code Art der Antwort
Binding: Issue Type VS (required)
.... details Σ 0..1 CodeableConcept Additional details about the error
Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.
.... diagnostics SΣ 1..1 string Zusatzinformationen
.... location Σ 0..* string Deprecated: Path of element(s) related to issue
.... expression Σ 0..* string FHIRPath of element(s) related to issue

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
OperationOutcome.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
OperationOutcome.issue.severityrequiredIssueSeverity
http://hl7.org/fhir/ValueSet/issue-severity|4.0.1
From the FHIR Standard
OperationOutcome.issue.coderequiredIssueTypeVS
https://gematik.de/fhir/atf/ValueSet/issue-type-vs
From this IG
OperationOutcome.issue.detailsexampleOperationOutcomeCodes
http://hl7.org/fhir/ValueSet/operation-outcome
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOperationOutcomeIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOperationOutcomeIf 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-4errorOperationOutcomeIf 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-5errorOperationOutcomeIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOperationOutcomeA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from OperationOutcome

Summary

Mandatory: 3 elements
Must-Support: 4 elements

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:MessageID S 1..1 string Extension
URL: https://gematik.de/fhir/atf/StructureDefinition/atf-message-id-ex
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... severity Σ 1..1 code fatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.
.... code SΣ 1..1 code Art der Antwort
Binding: Issue Type VS (required)
.... diagnostics SΣ 1..1 string Zusatzinformationen

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
OperationOutcome.issue.severityrequiredIssueSeverity
http://hl7.org/fhir/ValueSet/issue-severity|4.0.1
From the FHIR Standard
OperationOutcome.issue.coderequiredIssueTypeVS
https://gematik.de/fhir/atf/ValueSet/issue-type-vs
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOperationOutcomeIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOperationOutcomeIf 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-4errorOperationOutcomeIf 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-5errorOperationOutcomeIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOperationOutcomeA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from OperationOutcome

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:MessageID S 1..1 string Extension
URL: https://gematik.de/fhir/atf/StructureDefinition/atf-message-id-ex
... issue S 1..* BackboneElement A single issue associated with the action
.... code S 1..1 code Art der Antwort
Binding: Issue Type VS (required)
.... diagnostics S 1..1 string Zusatzinformationen

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
OperationOutcome.issue.coderequiredIssueTypeVS
https://gematik.de/fhir/atf/ValueSet/issue-type-vs
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
... 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
... 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 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:MessageID S 1..1 string Extension
URL: https://gematik.de/fhir/atf/StructureDefinition/atf-message-id-ex
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... issue SΣ 1..* BackboneElement A single issue associated with the action
.... 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
.... severity Σ 1..1 code fatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.
.... code SΣ 1..1 code Art der Antwort
Binding: Issue Type VS (required)
.... details Σ 0..1 CodeableConcept Additional details about the error
Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.
.... diagnostics SΣ 1..1 string Zusatzinformationen
.... location Σ 0..* string Deprecated: Path of element(s) related to issue
.... expression Σ 0..* string FHIRPath of element(s) related to issue

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
OperationOutcome.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
OperationOutcome.issue.severityrequiredIssueSeverity
http://hl7.org/fhir/ValueSet/issue-severity|4.0.1
From the FHIR Standard
OperationOutcome.issue.coderequiredIssueTypeVS
https://gematik.de/fhir/atf/ValueSet/issue-type-vs
From this IG
OperationOutcome.issue.detailsexampleOperationOutcomeCodes
http://hl7.org/fhir/ValueSet/operation-outcome
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOperationOutcomeIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOperationOutcomeIf 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-4errorOperationOutcomeIf 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-5errorOperationOutcomeIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOperationOutcomeA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from OperationOutcome

Summary

Mandatory: 3 elements
Must-Support: 4 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron