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.

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

Verbessern der Beispiele für ChargeItem #98

Merged
merged 5 commits into from
Nov 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1,273 changes: 280 additions & 993 deletions docs/erp_chargeItem.adoc
florianschoffke marked this conversation as resolved.
Show resolved Hide resolved

Large diffs are not rendered by default.

36 changes: 20 additions & 16 deletions docs_sources/erp_chargeItem-source.adoc
florianschoffke marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Der Aufruf erfolgt als http-`POST`-Operation auf die Ressource `/ChargeItem`. Im
*Request*
[cols="h,a",separator=¦]
|===
¦URI ¦https://prescriptionserver.telematik/ChargeItem?task=200.086.824.605.539.20&secret=c36ca26502892b371d252c99b496e31505ff449aca9bc69e231c58148f6233cf +
¦URI ¦https://prescriptionserver.telematik/ChargeItem?task=200.000.001.944.091.20&secret=c36ca26502892b371d252c99b496e31505ff449aca9bc69e231c58148f6233cf +
Mit dem Parameter `task=...` wird die Zuordnung zum Task des eingelösten Rezepts hergestellt. +
Zum Nachweis als berechtigte Apotheke, die das E-Rezept gerade in Bearbeitung hält, muss im URL-Parameter `secret` das beim Abrufen generierte Secret übergeben werden.
¦Method ¦POST
Expand All @@ -54,13 +54,13 @@ NOTE: In den Profilen ist unter meta.profile auch die Version mit anzugeben. (Bs
¦Payload ¦
[source,xml]
----
include::../resources/examples/prescriptionserver/request_PostChargeItem.xml[]
include::../resources/examples/prescriptionserver/abrechnungsdaten/01_POST_ChargeItem_Request.xml[]
----
NOTE: Der PKV-Abgabesatz in Binary.data ist aus Platzgründen stark gekürzt.

NOTE: In `<id value="Abg123"/>` befindet sich der Abgabgedatensatz als Contained-Bundle. Das Contained-Bundle wird später durch den Fachdienst als eigenständiges Bundle in "supportingInformation" referenziert.

NOTE: In `<value value="X234567890"/>` findet sich die Angabe eines PKV-Identifier.
NOTE: In `<value value="X110465770"/>` findet sich die Angabe eines PKV-Identifier.

NOTE: `<reference value="#Abg123"/>` enthält die Referenz auf das Contained-Objekt. Das Symbol '#' sagt dabei aus, dass es sich auf eine lokale Referenz innerhalb des Objektes bezieht.
|===
Expand All @@ -72,9 +72,13 @@ NOTE: `<reference value="#Abg123"/>` enthält die Referenz auf das Contained-Obj
¦HTTP Status Code¦201 Created
¦HTTP Header ¦Content-Type: application/fhir+xml;charset=utf-8
¦Payload¦

HTTP/1.1 201 Created
Content-Type: application/fhir+xml;charset=utf-8

[source,xml]
----
include::../resources/examples/prescriptionserver/response_PostChargeItem.xml[]
include::../resources/examples/prescriptionserver/abrechnungsdaten/02_POST_ChargeItem_Response.xml[]
----
|===

Expand Down Expand Up @@ -120,7 +124,7 @@ Der Aufruf erfolgt als http-`GET`-Operation auf die Ressource `/ChargeItem/'Pres
*Request*
[cols="h,a"]
|===
|URI |https://prescriptionserver.telematik/ChargeItem/200.000.000.022.127.38?ac=777bea0e13cc9c42ceec14aec3ddee2263325dc2c6c699db115f58fe423607ea
|URI |https://prescriptionserver.telematik/ChargeItem/200.000.001.944.091.20?ac=777bea0e13cc9c42ceec14aec3ddee2263325dc2c6c699db115f58fe423607ea
|Method |GET
|HTTP Header |
----
Expand All @@ -139,7 +143,7 @@ NOTE: Mit dem ACCESS_TOKEN im `Authorization`-Header weist sich der Zugreifende
¦Payload ¦
[source,xml]
----
include::../resources/examples/prescriptionserver/Bundle-Response-Apotheker-GetChargeIItemById.xml[]
include::../resources/examples/prescriptionserver/abrechnungsdaten/03_GET_ChargeItem_Response.xml[]
----
NOTE: Aus Gründen der besseren Lesbarkeit ist das PKV-Abgabdedatenbundle hier nicht vollständig dargestellt und wurde mit `...` abgekürzt. Es kann aber vollständig unter https://simplifier.net/erezept-patientenrechnung/~resources?category=Example&exampletype=Bundle eingesehen werden.

Expand Down Expand Up @@ -184,7 +188,7 @@ Der Aufruf erfolgt als http-`PUT`-Operation auf die Ressource `/ChargeItem/'Pres
*Request*
[cols="h,a",separator=¦]
|===
¦URI ¦https://prescriptionserver.telematik/ChargeItem/200.086.824.605.539.20?ac=777bea0e13cc9c42ceec14aec3ddee2263325dc2c6c699db115f58fe423607ea
¦URI ¦https://prescriptionserver.telematik/ChargeItem/200.000.001.944.091.20?ac=777bea0e13cc9c42ceec14aec3ddee2263325dc2c6c699db115f58fe423607ea
¦Method ¦PUT
¦HTTP Header ¦
----
Expand All @@ -197,7 +201,7 @@ NOTE: In den Profilen ist unter meta.profile auch die Version mit anzugeben. (Bs
¦Payload ¦
[source,xml]
----
include::../resources/examples/prescriptionserver/request_PutChargeItem.xml[]
include::../resources/examples/prescriptionserver/abrechnungsdaten/04_PUT_ChargeItem_Request.xml[]
----
NOTE: In `<id value="Abg456"/>` fügt die abgebende LEI ihren geänderten Abgabedatensatz ein.
|===
Expand All @@ -210,7 +214,7 @@ NOTE: In `<id value="Abg456"/>` fügt die abgebende LEI ihren geänderten Abgabe
¦Payload ¦
[source,xml]
----
include::../resources/examples/prescriptionserver/response_PutChargeItem.xml[]
include::../resources/examples/prescriptionserver/abrechnungsdaten/05_PUT_ChargeItem_Response.xml[]
----

|===
Expand Down Expand Up @@ -272,7 +276,7 @@ NOTE: Mit dem ACCESS_TOKEN im `Authorization`-Header weist sich der Zugreifende
¦Payload ¦
[source,json]
----
include::../resources/examples/prescriptionserver/response_GetChargeItemsVersicherter.json[]
include::../resources/examples/prescriptionserver/abrechnungsdaten/06_GET_ChargeItems_Response.json[]
----

NOTE: Die angegebenen Referenzen werden in diesem Request nicht mitgeliefert. Im folgenden Request der das Chargeitem nach der Id abfragt sind diese Informationen dagegen enthalten.
Expand All @@ -289,7 +293,7 @@ Rückgabewert ist ein Bundle, welches das ChargeItem, den Verordnungsdatensatz,
*Request*
[cols="h,a"]
|===
|URI |https://prescriptionserver.telematik/ChargeItem/200.086.824.605.539.20
|URI |https://prescriptionserver.telematik/ChargeItem/200.000.001.944.091.20
|Method |GET
|HTTP Header |
----
Expand All @@ -309,7 +313,7 @@ NOTE: Mit dem ACCESS_TOKEN im `Authorization`-Header weist sich der Zugreifende
¦Payload ¦
[source,json]
----
include::../resources/examples/prescriptionserver/Bundle-Response-App-GETChargeItemById.json[]
include::../resources/examples/prescriptionserver/abrechnungsdaten/07_GET_ChargeItem_Response.json[]
----

NOTE: Das `signature` Element enthält die Signatur des Bundles über alle enthaltenen Objekte als Enveloping-CAdES-Signatur in Base64-Codierung.
Expand Down Expand Up @@ -353,7 +357,7 @@ Der Aufruf erfolgt als http-`PATCH`-Operation auf die Ressource `/ChargeItem`.
*Request*
[cols="h,a",separator=¦]
|===
¦URI ¦https://prescriptionserver.telematik/ChargeItem/200.086.824.605.539.20
¦URI ¦https://prescriptionserver.telematik/ChargeItem/200.000.001.944.091.20
¦Method ¦PATCH
¦HTTP Header ¦
----
Expand All @@ -365,7 +369,7 @@ NOTE: Mit dem ACCESS_TOKEN im `Authorization`-Header weist sich der Zugreifende
¦Payload ¦
[source,json]
----
include::../resources/examples/prescriptionserver/request_PatchChargeItem.json[]
include::../resources/examples/prescriptionserver/abrechnungsdaten/08_PATCH_ChargeItem_Request.json[]
----
NOTE: In `"valueString": "ChargeItem.extension('https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_EX_MarkingFlag').extension('taxOffice')"` ist der Pfadanfang, an dem das zu ändernde Attribut hängt definiert.

Expand All @@ -381,7 +385,7 @@ NOTE: Im `"valueString": "ChargeItem.extension('https://gematik.de/fhir/erpchrg/
¦Payload ¦
[source,json]
----
include::../resources/examples/prescriptionserver/response_PatchChargeItem.json[]
include::../resources/examples/prescriptionserver/abrechnungsdaten/09_PATCH_ChargeItem_Response.json[]
----

|===
Expand Down Expand Up @@ -417,7 +421,7 @@ Der Aufruf erfolgt als http-`DELETE`-Operation auf die Ressource `/ChargeItem`.
*Request*
[cols="h,a"]
|===
|URI |https://prescriptionserver.telematik/ChargeItem/200.086.824.605.539.20
|URI |https://prescriptionserver.telematik/ChargeItem/200.000.001.944.091.20
|Method |DELETE
|HTTP Header |
----
Expand Down
Loading