Implementation Guide
ePA Common
Version 1.0.5-ballot.1 - draft

Resource Profile: EPA OperationOutcome

Official URL: https://gematik.de/fhir/epa/StructureDefinition/epa-operation-outcome Version: 1.0.5-ballot.1
Draft as of 2025-02-14 Computable Name: EPAOperationOutcome

Das Operation Outcome-Profil für die ePA FHIR Data Services

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
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-6: A resource should have narrative for robust management
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
... 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
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
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
... issue Σ 1..* BackboneElement A single issue associated with the action
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
.... severity SΣ 1..1 code fatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.


ele-1: All FHIR elements must have a @value or children
.... code SΣ 1..1 code Error or warning code
Binding: IssueType (required): A code that describes the type of issue.


ele-1: All FHIR elements must have a @value or children
.... details SΣ 1..1 CodeableConcept Additional details about the error
Binding: EPA OperationOutcome Value Set (required)
ele-1: All FHIR elements must have a @value or children

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.coderequiredIssueType
http://hl7.org/fhir/ValueSet/issue-type|4.0.1
from the FHIR Standard
OperationOutcome.issue.detailsrequiredEPAOperationOutcomeVS
https://gematik.de/fhir/epa/ValueSet/epa-operation-outcome-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** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from OperationOutcome

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
... issue
.... severity S 1..1 code fatal | error | warning | information
.... code S 1..1 code Error or warning code
.... details S 1..1 CodeableConcept Additional details about the error
Binding: EPA OperationOutcome Value Set (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
OperationOutcome.issue.detailsrequiredEPAOperationOutcomeVS
https://gematik.de/fhir/epa/ValueSet/epa-operation-outcome-vs
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... contained 0..* Resource Contained, inline Resources
... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... issue Σ 1..* BackboneElement A single issue associated with the action
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... severity SΣ 1..1 code fatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.

.... code SΣ 1..1 code Error or warning code
Binding: IssueType (required): A code that describes the type of issue.

.... details SΣ 1..1 CodeableConcept Additional details about the error
Binding: EPA OperationOutcome Value Set (required)
.... diagnostics Σ 0..1 string Additional diagnostic information about the issue
.... 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.coderequiredIssueType
http://hl7.org/fhir/ValueSet/issue-type|4.0.1
from the FHIR Standard
OperationOutcome.issue.detailsrequiredEPAOperationOutcomeVS
https://gematik.de/fhir/epa/ValueSet/epa-operation-outcome-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** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from OperationOutcome

Summary

Mandatory: 1 element
Must-Support: 3 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
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-6: A resource should have narrative for robust management
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
... 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
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
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
... issue Σ 1..* BackboneElement A single issue associated with the action
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
.... severity SΣ 1..1 code fatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.


ele-1: All FHIR elements must have a @value or children
.... code SΣ 1..1 code Error or warning code
Binding: IssueType (required): A code that describes the type of issue.


ele-1: All FHIR elements must have a @value or children
.... details SΣ 1..1 CodeableConcept Additional details about the error
Binding: EPA OperationOutcome Value Set (required)
ele-1: All FHIR elements must have a @value or children

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.coderequiredIssueType
http://hl7.org/fhir/ValueSet/issue-type|4.0.1
from the FHIR Standard
OperationOutcome.issue.detailsrequiredEPAOperationOutcomeVS
https://gematik.de/fhir/epa/ValueSet/epa-operation-outcome-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** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from OperationOutcome

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationOutcome 0..* OperationOutcome Information about the success/failure of an action
... issue
.... severity S 1..1 code fatal | error | warning | information
.... code S 1..1 code Error or warning code
.... details S 1..1 CodeableConcept Additional details about the error
Binding: EPA OperationOutcome Value Set (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
OperationOutcome.issue.detailsrequiredEPAOperationOutcomeVS
https://gematik.de/fhir/epa/ValueSet/epa-operation-outcome-vs
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... contained 0..* Resource Contained, inline Resources
... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... issue Σ 1..* BackboneElement A single issue associated with the action
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... severity SΣ 1..1 code fatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.

.... code SΣ 1..1 code Error or warning code
Binding: IssueType (required): A code that describes the type of issue.

.... details SΣ 1..1 CodeableConcept Additional details about the error
Binding: EPA OperationOutcome Value Set (required)
.... diagnostics Σ 0..1 string Additional diagnostic information about the issue
.... 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.coderequiredIssueType
http://hl7.org/fhir/ValueSet/issue-type|4.0.1
from the FHIR Standard
OperationOutcome.issue.detailsrequiredEPAOperationOutcomeVS
https://gematik.de/fhir/epa/ValueSet/epa-operation-outcome-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** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from OperationOutcome

Summary

Mandatory: 1 element
Must-Support: 3 elements

 

Other representations of profile: CSV, Excel, Schematron