Skip to content

DiGA Communication Profil ab 01.10. #233

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

Merged
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
11 changes: 7 additions & 4 deletions docs/erp_diga.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1316,7 +1316,9 @@ Als Kostenträger möchte ich dem Versicherten eine Nachricht über den Bearbeit
Der Aufruf erfolgt als http-`POST`-Operation. Im Aufruf muss das während der Authentisierung erhaltene ACCESS_TOKEN im http-Request-Header `Authorization` übergeben werden. Im http-RequestBody wird die zu verschickende Nachricht als Communication-Ressource übergeben. Der Server prüft den Inhalt auf Zulässigkeit (z.B. um die Verbreitung von Viren und Schadcode zu unterbinden) und ergänzt Metainformationen wie den Sendezeitpunkt und die Angaben des Absenders aus dessen ACCESS_TOKEN.
Die Nachricht steht nun zum Abruf durch den Empfänger bereit, der seine Nachrichten über eine GET-Abfrage herunterladen kann.

NOTE: Die Validierung der JSON-payload wird nach folgendem Schema durchgeführt link:https://github.com/eRP-FD/erp-processing-context/blob/master/resources/production/schema/shared/json/CommunicationReplyPayload.json[Reply JSON-Schema]. Daher muss im Feld "supplyOptionsType" verpflichtend ein Wert angegeben werden. Als default sollte "delivery" gesetzt werden. FdV's SOLLEN diesen Wert ignorieren.
NOTE: Die Verwendung des Profils GEM_ERP_PR_Communication_DiGA ist erst mit Einsatz der Workflow Version 1.5 möglich. Dieses Profil ermöglicht einen Freitext unter .payload.contentString. Bei Verwendung der Workflow Version 1.4 ist das Profil GEM_ERP_PR_Communication_Reply zu verwenden.

NOTE: Wenn das Profil GEM_ERP_PR_Communication_Reply verwendet wird, muss ein JSON in payload.contentString angegeben werden. Die Validierung der JSON-payload wird nach folgendem Schema durchgeführt link:https://github.com/eRP-FD/erp-processing-context/blob/master/resources/production/schema/shared/json/CommunicationReplyPayload.json[Reply JSON-Schema]. Daher muss im Feld "supplyOptionsType" verpflichtend ein Wert angegeben werden. Als default sollte "delivery" gesetzt werden. FdV's SOLLEN diesen Wert ignorieren.

WARNING: Nach Aufruf der $close und $reject Operation werden alle Communications zu einem Task gelöscht.

Expand All @@ -1338,12 +1340,13 @@ NOTE: Mit dem ACCESS_TOKEN im `Authorization`-Header weist sich der Zugreifende
NOTE: Im http-Header des äußeren http-Requests an die VAU (POST /VAU) sind die Header `X-erp-user: l` und `X-erp-resource: Communication` zu setzen.

¦Payload ¦
//TODO: Bei API 1.5 die Variablen wieder einsetzen include::https://raw.githubusercontent.com/gematik/eRezept-Examples/{branch}/API-Examples/{date-folder}/erp_diga/07_communication_to_patient.xml[]
[source,xml]
----
<Communication xmlns="http://hl7.org/fhir">
<id value="erp-diga-07-communication-to-patient"/>
<meta>
<profile value="https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_Communication_Reply|1.4"/>
<profile value="https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_Communication_DiGA|1.5"/>
</meta>
<basedOn>
<reference value="Task/162.000.000.000.000.01"/>
Expand All @@ -1356,11 +1359,11 @@ NOTE: Im http-Header des äußeren http-Requests an die VAU (POST /VAU) sind die
</identifier>
</recipient>
<payload>
<contentString value="{&quot;version&quot;: 1, &quot;supplyOptionsType&quot;: &quot;delivery&quot;, &quot;info_text&quot;: &quot;Die Anfrage zur Ausstellung eines Freischaltcodes für die DiGA wurde abgwiesen, da Sie nicht bei der Gematik-KK versichert sind.&quot;}"/>
<contentString value="Die Anfrage zur Ausstellung eines Freischaltcodes für die DiGA wurde abgwiesen, da Sie nicht bei der Gematik-KK versichert sind."/>
</payload>
</Communication>
----
NOTE: Die vom Kostenträger übermittelte Nachricht ist strukturiert in .payload.contentString unter "info_text" nach gemSpec_eRp_DM abgelegt.
NOTE: Die vom Kostenträger übermittelte Nachricht ist als Freitext in .payload.contentString abgelegt.

|===

Expand Down
9 changes: 6 additions & 3 deletions docs_sources/erp_diga-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,9 @@ Als Kostenträger möchte ich dem Versicherten eine Nachricht über den Bearbeit
Der Aufruf erfolgt als http-`POST`-Operation. Im Aufruf muss das während der Authentisierung erhaltene ACCESS_TOKEN im http-Request-Header `Authorization` übergeben werden. Im http-RequestBody wird die zu verschickende Nachricht als Communication-Ressource übergeben. Der Server prüft den Inhalt auf Zulässigkeit (z.B. um die Verbreitung von Viren und Schadcode zu unterbinden) und ergänzt Metainformationen wie den Sendezeitpunkt und die Angaben des Absenders aus dessen ACCESS_TOKEN.
Die Nachricht steht nun zum Abruf durch den Empfänger bereit, der seine Nachrichten über eine GET-Abfrage herunterladen kann.

NOTE: Die Validierung der JSON-payload wird nach folgendem Schema durchgeführt link:https://github.com/eRP-FD/erp-processing-context/blob/master/resources/production/schema/shared/json/CommunicationReplyPayload.json[Reply JSON-Schema]. Daher muss im Feld "supplyOptionsType" verpflichtend ein Wert angegeben werden. Als default sollte "delivery" gesetzt werden. FdV's SOLLEN diesen Wert ignorieren.
NOTE: Die Verwendung des Profils GEM_ERP_PR_Communication_DiGA ist erst mit Einsatz der Workflow Version 1.5 möglich. Dieses Profil ermöglicht einen Freitext unter .payload.contentString. Bei Verwendung der Workflow Version 1.4 ist das Profil GEM_ERP_PR_Communication_Reply zu verwenden.

NOTE: Wenn das Profil GEM_ERP_PR_Communication_Reply verwendet wird, muss ein JSON in payload.contentString angegeben werden. Die Validierung der JSON-payload wird nach folgendem Schema durchgeführt link:https://github.com/eRP-FD/erp-processing-context/blob/master/resources/production/schema/shared/json/CommunicationReplyPayload.json[Reply JSON-Schema]. Daher muss im Feld "supplyOptionsType" verpflichtend ein Wert angegeben werden. Als default sollte "delivery" gesetzt werden. FdV's SOLLEN diesen Wert ignorieren.

WARNING: Nach Aufruf der $close und $reject Operation werden alle Communications zu einem Task gelöscht.

Expand All @@ -474,11 +476,12 @@ NOTE: Mit dem ACCESS_TOKEN im `Authorization`-Header weist sich der Zugreifende
NOTE: Im http-Header des äußeren http-Requests an die VAU (POST /VAU) sind die Header `X-erp-user: l` und `X-erp-resource: Communication` zu setzen.

¦Payload ¦
//TODO: Bei API 1.5 die Variablen wieder einsetzen include::https://raw.githubusercontent.com/gematik/eRezept-Examples/{branch}/API-Examples/{date-folder}/erp_diga/07_communication_to_patient.xml[]
[source,xml]
----
include::https://raw.githubusercontent.com/gematik/eRezept-Examples/{branch}/API-Examples/{date-folder}/erp_diga/07_communication_to_patient.xml[]
include::https://raw.githubusercontent.com/gematik/eRezept-Examples/feature/eu-examples/API-Examples/2025-10-01-preview/erp_diga/07_communication_to_patient.xml[]
----
NOTE: Die vom Kostenträger übermittelte Nachricht ist strukturiert in .payload.contentString unter "info_text" nach gemSpec_eRp_DM abgelegt.
NOTE: Die vom Kostenträger übermittelte Nachricht ist als Freitext in .payload.contentString abgelegt.

|===

Expand Down