Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Information zu OperationOutcomes des Fachdienstes #75

Merged
merged 2 commits into from
Aug 8, 2023
Merged

Information zu OperationOutcomes des Fachdienstes #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5566fbb
Add Entry for operationoutcome in
florianschoffke Aug 7, 2023
0474b3a
Fix visuals
florianschoffke Aug 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion docs/erp_statuscodes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= E-Rezept API-Dokumentation HTTP-Codes des E-Rezept-Fachdienstes image:gematik_logo.png[width=150, float="right"]
= E-Rezept API-Dokumentation Fehlerbehandlung am E-Rezept-Fachdienst image:gematik_logo.png[width=150, float="right"]
// asciidoc settings for DE (German)
// ==================================
:imagesdir: ../images
Expand All @@ -16,6 +16,32 @@ Fehler können sowohl im inneren http-Requests (bei fachlichen Fehlern) als auch

toc::[]

== Auswertung eines OperationOutcomes

Bei Fehlern zur Validierung von FHIR-Ressourcen gibt der E-Rezept-Fachdienst einen OperationOutcome zurück. Dieser enthält in den Feldern `.severity` und `.code` kodierte Informationen zur Schwere des Fehlers. `.details` gibt eine kurze Beschreibung des Fehlers wieder und `.diagnostics` dient der detaillierten Fehleranalyse.

Folgendes Beispiel soll das veranschaulichen:

[source,xml]
----
<?xml version="1.0" encoding="utf-8"?>

<OperationOutcome xmlns="http://hl7.org/fhir">
<meta>
<profile value="http://hl7.org/fhir/StructureDefinition/OperationOutcome" />
</meta>
<issue>
<severity value="error" />
<code value="invalid" />
<details>
<text value="FHIR-Validation error" />
</details>
<diagnostics
value="Bundle: error: -erp-angabeZuzahlungsstatus: In der Ressource vom Typ Coverage ist kein Zuzahlungsstatus vorhanden, dieser ist aber eine Pflichtangabe bei den Kostentraegern der Typen 'GKV' 'SKT', 'BG' oder 'UK' (from profile: [https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Bundle|1.1.0|https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Bundle|1.1.0]); Bundle.entry[1].resource{MedicationRequest}.extension[0]: error: element doesn't match any slice in closed slicing (from profile: [https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Prescription|1.1.0|https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Prescription|1.1.0]); " />
</issue>
</OperationOutcome>
----

== Status Codes am Endpunkt /VAU
Fehler in der Übertragung auf der Netzwerkstrecke oder eine syntaktisch "falsche" Verschlüsselung des inneren http-Requests führen zu Fehlern am Endpunkt /VAU. Konnte der Verarbeitungskontext innerhalb der VAU den Request entschlüsseln, liefert er bei nutzbarem Antwortschlüssel (AES256-GCM-konform) immer eine verschlüsselte Antwort. Bei fachlichen Fehlern kann diese allerdings selbst einen Fehlercode enthalten (siehe unten).

Expand Down
13 changes: 12 additions & 1 deletion docs_sources/erp_statuscodes-source.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
= E-Rezept API-Dokumentation HTTP-Codes des E-Rezept-Fachdienstes image:gematik_logo.png[width=150, float="right"]
= E-Rezept API-Dokumentation Fehlerbehandlung am E-Rezept-Fachdienst image:gematik_logo.png[width=150, float="right"]
include::./config-source.adoc[]

Folgende http Status Codes können Clients bei der Benutzung der Schnittstellen des E-Rezept-Fachdienstes erwarten.
Fehler können sowohl im inneren http-Requests (bei fachlichen Fehlern) als auch im äußeren http-Request auftreten.

toc::[]

== Auswertung eines OperationOutcomes

Bei Fehlern zur Validierung von FHIR-Ressourcen gibt der E-Rezept-Fachdienst einen OperationOutcome zurück. Dieser enthält in den Feldern `.severity` und `.code` kodierte Informationen zur Schwere des Fehlers. `.details` gibt eine kurze Beschreibung des Fehlers wieder und `.diagnostics` dient der detaillierten Fehleranalyse.

Folgendes Beispiel soll das veranschaulichen:

[source,xml]
----
include::../resources/examples/misc/example_operationOutcome.xml[]
----

== Status Codes am Endpunkt /VAU
Fehler in der Übertragung auf der Netzwerkstrecke oder eine syntaktisch "falsche" Verschlüsselung des inneren http-Requests führen zu Fehlern am Endpunkt /VAU. Konnte der Verarbeitungskontext innerhalb der VAU den Request entschlüsseln, liefert er bei nutzbarem Antwortschlüssel (AES256-GCM-konform) immer eine verschlüsselte Antwort. Bei fachlichen Fehlern kann diese allerdings selbst einen Fehlercode enthalten (siehe unten).

Expand Down
16 changes: 16 additions & 0 deletions resources/examples/misc/example_operationOutcome.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>

<OperationOutcome xmlns="http://hl7.org/fhir">
<meta>
<profile value="http://hl7.org/fhir/StructureDefinition/OperationOutcome" />
</meta>
<issue>
<severity value="error" />
<code value="invalid" />
<details>
<text value="FHIR-Validation error" />
</details>
<diagnostics
value="Bundle: error: -erp-angabeZuzahlungsstatus: In der Ressource vom Typ Coverage ist kein Zuzahlungsstatus vorhanden, dieser ist aber eine Pflichtangabe bei den Kostentraegern der Typen 'GKV' 'SKT', 'BG' oder 'UK' (from profile: [https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Bundle|1.1.0|https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Bundle|1.1.0]); Bundle.entry[1].resource{MedicationRequest}.extension[0]: error: element doesn't match any slice in closed slicing (from profile: [https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Prescription|1.1.0|https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Prescription|1.1.0]); " />
</issue>
</OperationOutcome>