Error Handling
Auf dieser Seite wird das Error-Handling vorgestellt. Dazu werden die Liste der verwendeten Fehlercodes aus dem entsprechenden ValueSet und die Struktur des OperationOutcome zum Transport der Fehlermeldung vorgestellt.
Liste der verwendeten Fehlercodes
Es werden die Fehlercodes aus dem Projekteigenen ValueSet https://gematik.de/fhir/eeb/ValueSet/EEBErrorcodeVS verwendet.
In der FHIR-Ressource OperationOutcome muss in issue.details.coding ein Wert der Tabelle des folgenden Codesystems gemäß Definition des ValueSets verwendet werden. Die folgenden Codes sind gemäß der festgestellten Fehlerursache (siehe Beschreibung) vorgesehen:
| code | display |
|---|---|
| 100 | Der Patient ist nicht bei der adressierten Krankenkasse versichert. |
| 101 | Die übermittelte eEB entspricht nicht den Vorgaben und/oder ist nicht lesbar. |
| 110 | Der Patient ist nicht eindeutig identifizierbar. |
| 111 | Das angefragte Leistungsdatum ist unplausibel. |
| 112 | Es liegt für den Patienten kein gültiges Versichertenverhältnis zum angefragten Leistungsdatum vor. |
| 120 | Die Einwilligung des Patienten zur Freigabe der Bescheinigungsübermittlung an die Praxis liegt nicht vor. |
| 130 | Es liegt ein Sonderfall/ eine Ausnahme vor. Bitten Sie den Patienten, mit der Krankenkasse Kontakt aufzunehmen. |
| 201 | Die Signatur der eEB-Anfrage ist nicht gültig, da ein fehlerhaftes Zertifikat verwendet wurde oder nicht alle zur Zertifikatsprüfung erforderlichen Komponenten bzw. Ressourcen zur Verfügung standen. |
| 202 | Die Signaturprüfung der eEB-Anfrage hat ergeben, dass die signierten Daten nicht mit den übermittelten Daten der eEB-Anfrage übereinstimmen. |
| 210 | Die eEB-Anfrage ist nicht signiert. Die eEB-Anfrage ist ggf. manipuliert worden. |
| 211 | Die Signatur der eEB-Anfrage konnte aufgrund eines falschen Formats nicht geprüft werden. |
| 307 | Übermittlung ist fehlgeschlagen. Grund hierfür ist, dass die KIM-Nachricht zwar als eine verschlüsselte KIM-Nachricht gekennzeichnet wurde, aber auf Grund des falschen Formats nicht von der Krankenkasse entschlüsselt werden konnte. |
| 309 | Übermittlung ist fehlgeschlagen. Grund hierfür ist, dass für die KIM-Nachricht keine Signatur vorhanden ist. |
| 310 | Übermittlung ist fehlgeschlagen. Grund hierfür ist, dass die Signatur für die KIM-Nachricht aufgrund des falschen Formats nicht geprüft werden konnte. |
| 311 | Die Integrität der Nachricht wurde verletzt. Die Prüfung der Signatur hat ergeben, dass die Nachricht manipuliert wurde. |
| 313 | Die KIM-Nachricht konnte auf Grund eines nicht verfügbaren Schlüssels nicht entschlüsselt werden. |
OperationOutcome
Die FHIR-Ressource OperationOutcome transportiert die Fehlermeldung inkl. Fehlerursache, weshalb eine angefragte elektronische Ersatzbescheinigung nicht ausgestellt werden konnte.
Die Ressource wird dabei analog zur Bescheinigung in einer KIM-Nachricht transportiert, OHNE ein klammerndes Bundle.
| OperationOutcome | I | OperationOutcome | There are no (further) constraints on this element Element idOperationOutcome Information about the success/failure of an action DefinitionA collection of error, warning, or information messages that result from a system action. Can result from the failure of a REST call or be part of the response message returned from a request message.
| |
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idOperationOutcome.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idOperationOutcome.meta Metadata about the resource DefinitionThe 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idOperationOutcome.meta.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOperationOutcome.meta.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idOperationOutcome.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. 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.
|
| lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idOperationOutcome.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. 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.
|
| source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idOperationOutcome.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance 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. 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.
|
| profile | Σ | 0..* | canonical(StructureDefinition)Fixed Value | Element idOperationOutcome.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. 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. canonical(StructureDefinition) Constraints
https://gematik.de/fhir/eeb/StructureDefinition/EEBFehler
|
| security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idOperationOutcome.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. 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. Security Labels from the Healthcare Privacy and Security Classification System.
|
| tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idOperationOutcome.meta.tag Tags applied to this resource DefinitionTags 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. 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. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idOperationOutcome.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idOperationOutcome.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idOperationOutcome.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. 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.
| |
| contained | 0..* | Resource | There are no (further) constraints on this element Element idOperationOutcome.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOperationOutcome.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idOperationOutcome.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| issue | S Σ | 1..1 | BackboneElement | There are no (further) constraints on this element Element idOperationOutcome.issue A single issue associated with the action DefinitionAn error, warning, or information message that results from a system action.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idOperationOutcome.issue.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 1..* | Extension | Element idOperationOutcome.issue.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Closed, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| Identifier | S I | 1..1 | Extension(Complex) | Element idOperationOutcome.issue.extension:Identifier Optional Extensions Element Alternate namesextensions, user content DefinitionDiese Extension dient dazu, die Bundle-Identifier der Nachricht abzubilden, welche den Fehler verursacht hat. 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. Extension(Complex) Extension URLhttps://gematik.de/fhir/eeb/StructureDefinition/EEBOperationOutcomeIssueIdentifier Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idOperationOutcome.issue.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
| severity | Σ | 1..1 | codeBindingFixed Value | Element idOperationOutcome.issue.severity fatal | error | warning | information DefinitionAngabe der Fehlerkategorie Indicates how relevant the issue is to the overall success of the action. This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors. How the issue affects the success of the action.
fatal
|
| code | S Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idOperationOutcome.issue.code Error or warning code DefinitionDescribes 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. 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. Note that FHIR strings SHALL NOT exceed 1MB in size A code that describes the type of issue.
|
| details | Σ | 1..1 | CodeableConcept | Element idOperationOutcome.issue.details Additional details about the error Definitionnähere Beschreibung des Fehlers A human readable description of the error issue SHOULD be placed in details.text. A code that provides details as the exact issue.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idOperationOutcome.issue.details.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOperationOutcome.issue.details.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| coding | Σ | 1..1 | CodingBinding | Element idOperationOutcome.issue.details.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idOperationOutcome.issue.details.coding.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOperationOutcome.issue.details.coding.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idOperationOutcome.issue.details.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
|
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idOperationOutcome.issue.details.coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
| code | Σ | 1..1 | code | Element idOperationOutcome.issue.details.coding.code Errorcode DefinitionErrorcode Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| display | Σ | 1..1 | string | Element idOperationOutcome.issue.details.coding.display Errortext DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idOperationOutcome.issue.details.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
| text | Σ | 0..1 | string | Element idOperationOutcome.issue.details.text Errortext für Entwickler DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
| diagnostics | Σ | 0..0 | string | There are no (further) constraints on this element Element idOperationOutcome.issue.diagnostics Additional diagnostic information about the issue DefinitionAdditional diagnostic information about the issue. This may be a description of how a value is erroneous, a stack dump to help trace the issue or other troubleshooting information.
|
| location | Σ | 0..0 | string | There are no (further) constraints on this element Element idOperationOutcome.issue.location Deprecated: Path of element(s) related to issue DefinitionThis 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. Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily. 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.
|
| expression | Σ | 0..0 | string | There are no (further) constraints on this element Element idOperationOutcome.issue.expression FHIRPath of element(s) related to issue DefinitionA simple subset of FHIRPath 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. Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily. The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.
|
Im OperationOutcome wird genau ein issue mit entsprechenden Details übertragen.
Die severity ist dabei immer #fatal, es werden keine Warnungen angegeben.
Das Feld issue.details.coding enthält den von der Kasse angegebenen Fehlercode zur Begründung, weshalb keine elektronische Ersatzbescheinigung ausgestellt werden konnte, der dem Endnutzer mitgeteilt wird.
Der optionale Text in OperationOutcome.issue.details.text dient der Unterstützung in der Entwicklung und wird ggfs. nur in Testsystemen gefüllt.
Der OperationOutcome.issue enthält immer eine Extension die das fehlerverursachende Element (eEB-Anfrage-Bundle oder fehlerhafte KIM-Anfrage-Nachricht) referenziert.
Nachfolgend ist eine Beispiel-Fehlermeldung "Patient hier nicht versichert" dargestellt. D.h. die Fehlerursache ist im AnfrageBundle zu lokalisieren, anhand der Patienteninformationen kann kein Versicherungsverhältnis im Kassensystem lokalisiert werden.
Ein weiteres Beispiel einer Fehlermeldung im OperationOutcome ist hier zu finden, nach welchem die KIM-Anfrage-Nachricht fehlerhaft ist.