Profil: Fehler (OperationOutcome)
Fachlicher Kontext
Im Fehlerfall wird das vorliegende Operation Outcome mit Details zum aufgetretenen Fehler zurückgegeben.
Sollte es systemseitig eine Fehlermeldung geben, die noch nicht in der FHIR-Spezifikation veröffentlicht (also dem entsprechenden CodeSystem hinzugefügt) wurde, so werden folgende Daten zurückgegeben:
OperationOutcome.issue.details.coding.code |
VCA000 |
OperationOutcome.issue.details.coding.display |
Sonstiger Fehler. Unter diagnostics finden Sie nähere Informationen zum Fehler. |
OperationOutcome.issue.diagnostics |
[Hier steht die eigentliche (noch nicht in FHIR veröffentlichte) Fehlermeldung mit Fehlerdetails.] |
FHIR-Profil
Name | KBV_PR_116117_TERMINSERVICE_VCA_OperationOutcome_Error |
---|---|
Type | OperationOutcome |
Base Definition | http://hl7.org/fhir/StructureDefinition/OperationOutcome (Version: R4) |
Canonical URL | https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_VCA_OperationOutcome_Error |
KBV_PR_116117_TERMINSERVICE_VCA_OperationOutcome_Error (OperationOutcome) | I | OperationOutcome | |
id | Σ | 0..1 | string |
meta | Σ | 1..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | Σ | 0..0 | id |
lastUpdated | Σ | 0..0 | instant |
source | Σ | 0..0 | uri |
profile | Σ | 1..* | canonical(StructureDefinition) |
kvdigitalProfil | Σ | 1..1 | canonical(StructureDefinition)Pattern |
security | Σ | 0..0 | CodingBinding |
tag | Σ | 0..0 | Coding |
implicitRules | Σ ?! | 0..0 | uri |
language | 0..0 | codeBinding | |
text | S | 0..1 | Narrative |
id | 0..1 | string | |
extension | I | 0..* | Extension |
status | S | 1..1 | codeBindingFixed Value |
div | S I | 1..1 | xhtml |
contained | 0..0 | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
issue | S Σ | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
severity | S Σ | 1..1 | codeBindingFixed Value |
code | S Σ | 1..1 | codeBinding |
details | S Σ | 1..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..1 | Coding |
id | S | 0..1 | string |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriFixed Value |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 1..1 | string |
userSelected | Σ | 0..0 | boolean |
text | Σ | 0..0 | string |
diagnostics | S Σ | 0..1 | string |
location | Σ | 0..0 | string |
expression | Σ | 0..0 | string |
OperationOutcome | |
Definition | OperationOutcome, welches im Fehlerfall zurückgegeben wird und Details zum aufgetretenen Fehler enthält. |
Cardinality | 0...* |
Comments | Can result from the failure of a REST call or be part of the response message returned from a request message. |
Invariants |
|
Mappings |
|
OperationOutcome.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
OperationOutcome.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 1...1 |
Type | Meta |
Summary | True |
Invariants |
|
OperationOutcome.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
OperationOutcome.meta.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
OperationOutcome.meta.versionId | |
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
Cardinality | 0...0 |
Type | id |
Summary | True |
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. |
Invariants |
|
OperationOutcome.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...0 |
Type | instant |
Summary | True |
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
Invariants |
|
OperationOutcome.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
Cardinality | 0...0 |
Type | uri |
Summary | True |
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
Invariants |
|
OperationOutcome.meta.profile | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 1...* |
Type | canonical(StructureDefinition) |
Summary | True |
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
Slicing | Unordered, Open, by $this(Value) |
Invariants |
|
OperationOutcome.meta.profile:kvdigitalProfil | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 1...1 |
Type | canonical(StructureDefinition) |
Summary | True |
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
Invariants |
|
Pattern | https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_VCA_OperationOutcome_Error|1.0.0 |
OperationOutcome.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...0 |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Summary | True |
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants |
|
OperationOutcome.meta.tag | |
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
Cardinality | 0...0 |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Summary | True |
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants |
|
OperationOutcome.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...0 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
OperationOutcome.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...0 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
OperationOutcome.text | |
Definition | In diesem Element können die in der Instanz enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden dürfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind. |
Cardinality | 0...1 |
Type | Narrative |
Must Support | True |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
OperationOutcome.text.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
OperationOutcome.text.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
OperationOutcome.text.status | |
Definition | The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. |
Cardinality | 1...1 |
Type | code |
Binding | The status of a resource narrative. |
Must Support | True |
Invariants |
|
Fixed Value | extensions |
Mappings |
|
OperationOutcome.text.div | |
Definition | The actual narrative content, a stripped down version of XHTML. |
Cardinality | 1...1 |
Type | xhtml |
Must Support | True |
Comments | The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects. |
Invariants |
|
Mappings |
|
OperationOutcome.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...0 |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
OperationOutcome.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
OperationOutcome.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
OperationOutcome.issue | |
Definition | Details zum aufgetretenen Fehler |
Cardinality | 1...1 |
Type | BackboneElement |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
OperationOutcome.issue.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
OperationOutcome.issue.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
OperationOutcome.issue.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
OperationOutcome.issue.severity | |
Definition | Indicates whether the issue indicates a variation from successful processing. |
Cardinality | 1...1 |
Type | code |
Binding | How the issue affects the success of the action. |
Must Support | True |
Summary | True |
Requirements | Indicates how relevant the issue is to the overall success of the action. |
Comments | This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors. |
Invariants |
|
Fixed Value | fatal |
Mappings |
|
OperationOutcome.issue.code | |
Definition | Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element. |
Cardinality | 1...1 |
Type | code |
Binding | A code that describes the type of issue. |
Must Support | True |
Summary | True |
Requirements | Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue. The required element provides a base level of computable interoperability across all systems for processing an outcome, allowing systems to respond appropriately regardless of the internal system error codes returned. |
Invariants |
|
Mappings |
|
OperationOutcome.issue.details | |
Definition | Additional details about the error. This may be a text description of the error or a system code that identifies the error. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | A code that provides details as the exact issue. |
Must Support | True |
Summary | True |
Comments | A human readable description of the error issue SHOULD be placed in details.text. |
Invariants |
|
Mappings |
|
OperationOutcome.issue.details.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
OperationOutcome.issue.details.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
OperationOutcome.issue.details.coding | |
Definition | Coding mit Informationen zum aufgetretenen Fehler |
Cardinality | 1...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Hinweis: Es gibt kein festes CodeSystem oder ValueSet für die Fehlercodes, da dieses aufgrund relativ häufiger Änderungen an den Codes (v.a. das Aktualisierung der Beschreibung und das Hinzufügen neuer Codes) entsprechend oft aktualisiert werden müsste. |
Invariants |
|
Mappings |
|
OperationOutcome.issue.details.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Mappings |
|
OperationOutcome.issue.details.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
OperationOutcome.issue.details.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Fixed Value | https://fhir.kbv.de/CodeSystem/KBV_CS_116117_TERMINSERVICE_VCA_Errors |
Mappings |
|
OperationOutcome.issue.details.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
OperationOutcome.issue.details.coding.code | |
Definition | Eindeutiger Fehlercode zum aufgetrenen Fehler (bspw. "VCA001") |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
OperationOutcome.issue.details.coding.display | |
Definition | Informationen zum aufgetrenen Fehler in menschenlesbarer Form (bspw. "Ungültiger Input-Parameter") |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
OperationOutcome.issue.details.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
OperationOutcome.issue.details.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...0 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
OperationOutcome.issue.diagnostics | |
Definition | Hier werden ggf. weitere Details zum aufgetretenen Fehler angegeben. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | This may be a description of how a value is erroneous, a stack dump to help trace the issue or other troubleshooting information. |
Invariants |
|
Mappings |
|
OperationOutcome.issue.location | |
Definition | This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be "http." + the parameter name. |
Cardinality | 0...0 |
Type | string |
Summary | True |
Requirements | Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily. |
Comments | The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. This element is deprecated, and is being replaced by expression. |
Invariants |
|
Mappings |
|
OperationOutcome.issue.expression | |
Definition | A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. |
Cardinality | 0...0 |
Type | string |
Summary | True |
Requirements | Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily. |
Comments | The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="KBV-PR-116117-TERMINSERVICE-VCA-OperationOutcome-Error" /> <text> <status value="generated" /> --- We have skipped the narrative for better readability of the resource --- </text> <url value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_VCA_OperationOutcome_Error" /> <version value="1.0.0" /> <name value="KBV_PR_116117_TERMINSERVICE_VCA_OperationOutcome_Error" /> <title value="KBV_PR_116117_TERMINSERVICE_VCA_OperationOutcome_Error" /> <status value="active" /> <publisher value="kv.digital GmbH" /> <contact> <name value="kv.digital GmbH" /> <telecom> <system value="url" /> <value value="https://www.kv.digital" /> </telecom> </contact> <description value="Dieses Operation Outcome enthält genauere Details zum aufgetretenen Fehler." /> <copyright value="Im folgenden Profil können Codes aus den Code-Systemen SNOMED CT®, LOINC, Ucum, ATC, ICD-10-GM, ICD-10-WHO, OPS, Alpha-ID/Alpha-ID-SE und ICF enthalten sein, die dem folgenden Urheberrecht unterliegen: This material includes SNOMED CT® Clinical Terms® (SNOMED CT® CT®) which is used by permission of SNOMED CT® International. All rights reserved. SNOMED CT® CT®, was originally created by The College of American Pathologists. SNOMED CT® and SNOMED CT® CT are registered trademarks of SNOMED CT® International. Implementers of these artefacts must have the appropriate SNOMED CT® CT Affiliate license. This material contains content from LOINC (http://LOINC.org). LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://LOINC.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc. This product includes all or a portion of the UCUM table, UCUM codes, and UCUM definitions or is derived from it, subject to a license from Regenstrief Institute, Inc. and The UCUM Organization. Your use of the UCUM table, UCUM codes, UCUM definitions also is subject to this license, a copy of which is available at http://unitsofmeasure.org. The current complete UCUM table, UCUM Specification are available for download at http://unitsofmeasure.org. The UCUM table and UCUM codes are copyright © 1995-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. THE UCUM TABLE (IN ALL FORMATS), UCUM DEFINITIONS, AND SPECIFICATION ARE PROVIDED 'AS IS.' ANY EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Dieses Material enthält Inhalte aus ATC. Die Erstellung erfolgte unter Verwendung der Datenträger der amtlichen Fassung der ATCKlassifikation mit DDD des Bundesinstituts für Arzneimittel und Medizinprodukte (BfArM). Dieses Material enthält Inhalte aus ICD-10-GM, ICD-10-WHO, OPS Alpha-ID ans Alpha-ID-SE. Die Erstellung erfolgt unter Verwendung der maschinenlesbaren Fassung des Bundesinstituts für Arzneimittel und Medizinprodukte (BfArM). Dieses Material enthält Inhalte aus ICF. Die Erstellung erfolgt unter Verwendung der maschinenlesbaren Fassung des Deutschen Instituts für Medizinische Dokumentation und Information (DIMDI). ICF-Kodes, -Begriffe und -Texte © Weltgesundheitsorganisation, übersetzt und herausgegeben durch das Deutsche Institut für Medizinische Dokumentation und Information von der International classification of functioning, disability and health - ICF, herausgegeben durch die Weltgesundheitsorganisation." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="OperationOutcome" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/OperationOutcome" /> <derivation value="constraint" /> <differential> <element id="OperationOutcome"> <path value="OperationOutcome" /> <short value="Details zum aufgetretenen Fehler" /> <definition value="OperationOutcome, welches im Fehlerfall zurückgegeben wird und Details zum aufgetretenen Fehler enthält." /> </element> <element id="OperationOutcome.meta"> <path value="OperationOutcome.meta" /> <min value="1" /> </element> <element id="OperationOutcome.meta.versionId"> <path value="OperationOutcome.meta.versionId" /> <max value="0" /> </element> <element id="OperationOutcome.meta.lastUpdated"> <path value="OperationOutcome.meta.lastUpdated" /> <max value="0" /> </element> <element id="OperationOutcome.meta.source"> <path value="OperationOutcome.meta.source" /> <max value="0" /> </element> <element id="OperationOutcome.meta.profile"> <path value="OperationOutcome.meta.profile" /> <slicing> <discriminator> <type value="value" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> </element> <element id="OperationOutcome.meta.profile:kvdigitalProfil"> <path value="OperationOutcome.meta.profile" /> <sliceName value="kvdigitalProfil" /> <min value="1" /> <max value="1" /> <patternCanonical value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_VCA_OperationOutcome_Error|1.0.0" /> </element> <element id="OperationOutcome.meta.security"> <path value="OperationOutcome.meta.security" /> <max value="0" /> </element> <element id="OperationOutcome.meta.tag"> <path value="OperationOutcome.meta.tag" /> <max value="0" /> </element> <element id="OperationOutcome.implicitRules"> <path value="OperationOutcome.implicitRules" /> <max value="0" /> </element> <element id="OperationOutcome.language"> <path value="OperationOutcome.language" /> <max value="0" /> </element> <element id="OperationOutcome.text"> <path value="OperationOutcome.text" /> <definition value="In diesem Element können die in der Instanz enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden dürfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind." /> <mustSupport value="true" /> </element> <element id="OperationOutcome.text.status"> <path value="OperationOutcome.text.status" /> <fixedCode value="extensions" /> <mustSupport value="true" /> </element> <element id="OperationOutcome.text.div"> <path value="OperationOutcome.text.div" /> <mustSupport value="true" /> </element> <element id="OperationOutcome.contained"> <path value="OperationOutcome.contained" /> <max value="0" /> </element> <element id="OperationOutcome.issue"> <path value="OperationOutcome.issue" /> <short value="Fehlerinformationen" /> <definition value="Details zum aufgetretenen Fehler" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="OperationOutcome.issue.severity"> <path value="OperationOutcome.issue.severity" /> <fixedCode value="fatal" /> <mustSupport value="true" /> </element> <element id="OperationOutcome.issue.code"> <path value="OperationOutcome.issue.code" /> <mustSupport value="true" /> </element> <element id="OperationOutcome.issue.details"> <path value="OperationOutcome.issue.details" /> <short value="Informationen zum Fehler" /> <min value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://fhir.kbv.de/ValueSet/KBV_VS_116117_TERMINSERVICE_VCA_Errors" /> </binding> </element> <element id="OperationOutcome.issue.details.coding"> <path value="OperationOutcome.issue.details.coding" /> <short value="Coding zum Fehler" /> <definition value="Coding mit Informationen zum aufgetretenen Fehler" /> <comment value="Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.\n\nHinweis: Es gibt kein festes CodeSystem oder ValueSet für die Fehlercodes, da dieses aufgrund relativ häufiger Änderungen an den Codes (v.a. das Aktualisierung der Beschreibung und das Hinzufügen neuer Codes) entsprechend oft aktualisiert werden müsste." /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="OperationOutcome.issue.details.coding.id"> <path value="OperationOutcome.issue.details.coding.id" /> <mustSupport value="true" /> </element> <element id="OperationOutcome.issue.details.coding.system"> <path value="OperationOutcome.issue.details.coding.system" /> <min value="1" /> <fixedUri value="https://fhir.kbv.de/CodeSystem/KBV_CS_116117_TERMINSERVICE_VCA_Errors" /> <mustSupport value="true" /> </element> <element id="OperationOutcome.issue.details.coding.version"> <path value="OperationOutcome.issue.details.coding.version" /> <mustSupport value="true" /> </element> <element id="OperationOutcome.issue.details.coding.code"> <path value="OperationOutcome.issue.details.coding.code" /> <short value="Fehlercode" /> <definition value="Eindeutiger Fehlercode zum aufgetrenen Fehler (bspw. "VCA001")" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="OperationOutcome.issue.details.coding.display"> <path value="OperationOutcome.issue.details.coding.display" /> <short value="Fehlerinformationen" /> <definition value="Informationen zum aufgetrenen Fehler in menschenlesbarer Form (bspw. "Ungültiger Input-Parameter")" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="OperationOutcome.issue.details.coding.userSelected"> <path value="OperationOutcome.issue.details.coding.userSelected" /> <max value="0" /> </element> <element id="OperationOutcome.issue.details.text"> <path value="OperationOutcome.issue.details.text" /> <max value="0" /> </element> <element id="OperationOutcome.issue.diagnostics"> <path value="OperationOutcome.issue.diagnostics" /> <short value="Weitere Details zum Fehler" /> <definition value="Hier werden ggf. weitere Details zum aufgetretenen Fehler angegeben." /> <mustSupport value="true" /> </element> <element id="OperationOutcome.issue.location"> <path value="OperationOutcome.issue.location" /> <max value="0" /> </element> <element id="OperationOutcome.issue.expression"> <path value="OperationOutcome.issue.expression" /> <max value="0" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "KBV-PR-116117-TERMINSERVICE-VCA-OperationOutcome-Error", "text": { "status": "generated", --- We have skipped the narrative for better readability of the resource --- }, "url": "https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_VCA_OperationOutcome_Error", "version": "1.0.0", "name": "KBV_PR_116117_TERMINSERVICE_VCA_OperationOutcome_Error", "title": "KBV_PR_116117_TERMINSERVICE_VCA_OperationOutcome_Error", "status": "active", "publisher": "kv.digital GmbH", "contact": [ { "name": "kv.digital GmbH", "telecom": [ { "system": "url", "value": "https://www.kv.digital" } ] } ], "description": "Dieses Operation Outcome enthält genauere Details zum aufgetretenen Fehler.", "copyright": "Im folgenden Profil können Codes aus den Code-Systemen SNOMED CT®, LOINC, Ucum, ATC, ICD-10-GM, ICD-10-WHO, OPS, Alpha-ID/Alpha-ID-SE und ICF enthalten sein, die dem folgenden Urheberrecht unterliegen: This material includes SNOMED CT® Clinical Terms® (SNOMED CT® CT®) which is used by permission of SNOMED CT® International. All rights reserved. SNOMED CT® CT®, was originally created by The College of American Pathologists. SNOMED CT® and SNOMED CT® CT are registered trademarks of SNOMED CT® International. Implementers of these artefacts must have the appropriate SNOMED CT® CT Affiliate license. This material contains content from LOINC (http://LOINC.org). LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://LOINC.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc. This product includes all or a portion of the UCUM table, UCUM codes, and UCUM definitions or is derived from it, subject to a license from Regenstrief Institute, Inc. and The UCUM Organization. Your use of the UCUM table, UCUM codes, UCUM definitions also is subject to this license, a copy of which is available at http://unitsofmeasure.org. The current complete UCUM table, UCUM Specification are available for download at http://unitsofmeasure.org. The UCUM table and UCUM codes are copyright © 1995-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. THE UCUM TABLE (IN ALL FORMATS), UCUM DEFINITIONS, AND SPECIFICATION ARE PROVIDED 'AS IS.' ANY EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Dieses Material enthält Inhalte aus ATC. Die Erstellung erfolgte unter Verwendung der Datenträger der amtlichen Fassung der ATCKlassifikation mit DDD des Bundesinstituts für Arzneimittel und Medizinprodukte (BfArM). Dieses Material enthält Inhalte aus ICD-10-GM, ICD-10-WHO, OPS Alpha-ID ans Alpha-ID-SE. Die Erstellung erfolgt unter Verwendung der maschinenlesbaren Fassung des Bundesinstituts für Arzneimittel und Medizinprodukte (BfArM). Dieses Material enthält Inhalte aus ICF. Die Erstellung erfolgt unter Verwendung der maschinenlesbaren Fassung des Deutschen Instituts für Medizinische Dokumentation und Information (DIMDI). ICF-Kodes, -Begriffe und -Texte © Weltgesundheitsorganisation, übersetzt und herausgegeben durch das Deutsche Institut für Medizinische Dokumentation und Information von der International classification of functioning, disability and health - ICF, herausgegeben durch die Weltgesundheitsorganisation.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "OperationOutcome", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/OperationOutcome", "derivation": "constraint", "differential": { "element": [ { "id": "OperationOutcome", "path": "OperationOutcome", "short": "Details zum aufgetretenen Fehler", "definition": "OperationOutcome, welches im Fehlerfall zurückgegeben wird und Details zum aufgetretenen Fehler enthält." }, { "id": "OperationOutcome.meta", "path": "OperationOutcome.meta", "min": 1 }, { "id": "OperationOutcome.meta.versionId", "path": "OperationOutcome.meta.versionId", "max": "0" }, { "id": "OperationOutcome.meta.lastUpdated", "path": "OperationOutcome.meta.lastUpdated", "max": "0" }, { "id": "OperationOutcome.meta.source", "path": "OperationOutcome.meta.source", "max": "0" }, { "id": "OperationOutcome.meta.profile", "path": "OperationOutcome.meta.profile", "slicing": { "discriminator": [ { "type": "value", "path": "$this" } ], "rules": "open" }, "min": 1 }, { "id": "OperationOutcome.meta.profile:kvdigitalProfil", "path": "OperationOutcome.meta.profile", "sliceName": "kvdigitalProfil", "min": 1, "max": "1", "patternCanonical": "https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_VCA_OperationOutcome_Error|1.0.0" }, { "id": "OperationOutcome.meta.security", "path": "OperationOutcome.meta.security", "max": "0" }, { "id": "OperationOutcome.meta.tag", "path": "OperationOutcome.meta.tag", "max": "0" }, { "id": "OperationOutcome.implicitRules", "path": "OperationOutcome.implicitRules", "max": "0" }, { "id": "OperationOutcome.language", "path": "OperationOutcome.language", "max": "0" }, { "id": "OperationOutcome.text", "path": "OperationOutcome.text", "definition": "In diesem Element können die in der Instanz enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden dürfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind.", "mustSupport": true }, { "id": "OperationOutcome.text.status", "path": "OperationOutcome.text.status", "fixedCode": "extensions", "mustSupport": true }, { "id": "OperationOutcome.text.div", "path": "OperationOutcome.text.div", "mustSupport": true }, { "id": "OperationOutcome.contained", "path": "OperationOutcome.contained", "max": "0" }, { "id": "OperationOutcome.issue", "path": "OperationOutcome.issue", "short": "Fehlerinformationen", "definition": "Details zum aufgetretenen Fehler", "max": "1", "mustSupport": true }, { "id": "OperationOutcome.issue.severity", "path": "OperationOutcome.issue.severity", "fixedCode": "fatal", "mustSupport": true }, { "id": "OperationOutcome.issue.code", "path": "OperationOutcome.issue.code", "mustSupport": true }, { "id": "OperationOutcome.issue.details", "path": "OperationOutcome.issue.details", "short": "Informationen zum Fehler", "min": 1, "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://fhir.kbv.de/ValueSet/KBV_VS_116117_TERMINSERVICE_VCA_Errors" } }, { "id": "OperationOutcome.issue.details.coding", "path": "OperationOutcome.issue.details.coding", "short": "Coding zum Fehler", "definition": "Coding mit Informationen zum aufgetretenen Fehler", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.\n\nHinweis: Es gibt kein festes CodeSystem oder ValueSet für die Fehlercodes, da dieses aufgrund relativ häufiger Änderungen an den Codes (v.a. das Aktualisierung der Beschreibung und das Hinzufügen neuer Codes) entsprechend oft aktualisiert werden müsste.", "min": 1, "max": "1", "mustSupport": true }, { "id": "OperationOutcome.issue.details.coding.id", "path": "OperationOutcome.issue.details.coding.id", "mustSupport": true }, { "id": "OperationOutcome.issue.details.coding.system", "path": "OperationOutcome.issue.details.coding.system", "min": 1, "fixedUri": "https://fhir.kbv.de/CodeSystem/KBV_CS_116117_TERMINSERVICE_VCA_Errors", "mustSupport": true }, { "id": "OperationOutcome.issue.details.coding.version", "path": "OperationOutcome.issue.details.coding.version", "mustSupport": true }, { "id": "OperationOutcome.issue.details.coding.code", "path": "OperationOutcome.issue.details.coding.code", "short": "Fehlercode", "definition": "Eindeutiger Fehlercode zum aufgetrenen Fehler (bspw. \"VCA001\")", "min": 1, "mustSupport": true }, { "id": "OperationOutcome.issue.details.coding.display", "path": "OperationOutcome.issue.details.coding.display", "short": "Fehlerinformationen", "definition": "Informationen zum aufgetrenen Fehler in menschenlesbarer Form (bspw. \"Ungültiger Input-Parameter\")", "min": 1, "mustSupport": true }, { "id": "OperationOutcome.issue.details.coding.userSelected", "path": "OperationOutcome.issue.details.coding.userSelected", "max": "0" }, { "id": "OperationOutcome.issue.details.text", "path": "OperationOutcome.issue.details.text", "max": "0" }, { "id": "OperationOutcome.issue.diagnostics", "path": "OperationOutcome.issue.diagnostics", "short": "Weitere Details zum Fehler", "definition": "Hier werden ggf. weitere Details zum aufgetretenen Fehler angegeben.", "mustSupport": true }, { "id": "OperationOutcome.issue.location", "path": "OperationOutcome.issue.location", "max": "0" }, { "id": "OperationOutcome.issue.expression", "path": "OperationOutcome.issue.expression", "max": "0" } ] } }
Beispiele
Alle Beispiele sind hier im vorliegenden Projekt zu finden.
<OperationOutcome xmlns="http://hl7.org/fhir"> <id value="aae373f1-7bfb-4fb4-92ce-8e5322f4d65z" /> <meta> <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_VCA_OperationOutcome_Error|1.0.0" /> </meta> <text> <status value="extensions" /> --- We have skipped the narrative for better readability of the resource --- </text> <issue> <severity value="fatal" /> <code value="value" /> <details> <coding> <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_116117_TERMINSERVICE_VCA_Errors" /> <code value="VCA000" /> <display value="Sonstiger Fehler. Unter diagnostics finden Sie nähere Informationen zum Fehler." /> </coding> </details> <diagnostics value="Ungültiger Input-Parameter" /> </issue> </OperationOutcome>
<OperationOutcome xmlns="http://hl7.org/fhir"> <id value="aae373f1-5bfb-4fb5-92ce-8e5322f4d63x" /> <meta> <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_VCA_OperationOutcome_Error|1.0.0" /> </meta> <text> <status value="extensions" /> --- We have skipped the narrative for better readability of the resource --- </text> <issue> <severity value="fatal" /> <code value="value" /> <details> <coding> <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_116117_TERMINSERVICE_VCA_Errors" /> <code value="VCA002" /> <display value="Dringlichkeit passt nicht für mitgegebene Leistungsmerkmale" /> </coding> </details> </issue> </OperationOutcome>