Skip to content

Commit be1f3f1

Browse files
Merge pull request #30 from gematik/feature/folder-structure
Feature/folder structure
2 parents c1e70ad + 1fba441 commit be1f3f1

29 files changed

+81
-79
lines changed
File renamed without changes.

resources/docs/authentisieren-source.adoc docs_sources/authentisieren-source.adoc

+7-7
Original file line numberDiff line numberDiff line change
@@ -98,15 +98,15 @@ SOAPAction: "http://ws.gematik.de/conn/CertificateService/v7.4#ReadCardCertifica
9898
|Payload |
9999
[source,xml]
100100
----
101-
include::../examples/konnektorservice/request_ReadCardCertificate.xml[]
101+
include::../resources/examples/konnektorservice/request_ReadCardCertificate.xml[]
102102
----
103103
NOTE: In `<ns8:CertRef>C.AUT</ns8:CertRef>` wird angegeben, dass das Zertifikat zur Authentisierung gegenüber dem IDP aus der SMC-B ausgelesen werden soll.
104104
|===
105105

106106
*Response*
107107
[source,xml]
108108
----
109-
include::../examples/konnektorservice/response_ReadCardCertificate.xml[]
109+
include::../resources/examples/konnektorservice/response_ReadCardCertificate.xml[]
110110
----
111111
NOTE: Der Konnektor liefert das Zertifikat in `<ns5:X509Certificate>` zurück, wie es auf der Karte gespeichert ist, ASN.1 DER codiert in Base64-Darstellung.
112112

@@ -145,7 +145,7 @@ IMPORTANT: Die Länge des Soap-Requests, muss entsprechend im Header mit der Eig
145145
|Payload |
146146
[source,xml]
147147
----
148-
include::../examples/konnektorservice/request_VerifyCertificate.xml[]
148+
include::../resources/examples/konnektorservice/request_VerifyCertificate.xml[]
149149
----
150150
NOTE: Das zu prüfende Zertifikat in Base64-DER-Codierung ist mit `<m2:X509Certificate></m2:X509Certificate>` identifiziert.
151151
|===
@@ -155,7 +155,7 @@ NOTE: Das zu prüfende Zertifikat in Base64-DER-Codierung ist mit `<m2:X509Certi
155155
----
156156
HTTP/1.1 200 OK
157157
Content-Type: text/xml;charset=utf-8
158-
include::../examples/konnektorservice/response_VerifyCertificate.xml[]
158+
include::../resources/examples/konnektorservice/response_VerifyCertificate.xml[]
159159
----
160160
NOTE: In `<ns4:VerificationResult></ns4:VerificationResult>` wird das Prüfergebnis des Zertifikats [VALID = gültig, INCONCLUSIVE = offline-gültig ohne Sperrstatus, INVALID = ungültig] angegeben
161161

@@ -185,7 +185,7 @@ SOAPAction: "http://ws.gematik.de/conn/SignatureService/v7.4#ExternalAuthenticat
185185
|Payload |
186186
[source,xml]
187187
----
188-
include::../examples/konnektorservice/request_ExternalAuthenticate.xml[]
188+
include::../resources/examples/konnektorservice/request_ExternalAuthenticate.xml[]
189189
----
190190
NOTE: Entsprechend der Mandantenkonfiguration wird in `<ns1:CardHandle></ns1:CardHandle>` die SMC-B referenziert, welche der IDP authentifizieren soll.
191191

@@ -197,7 +197,7 @@ NOTE: In `<ns7:Base64Data></ns7:Base64Data>` befindet sich der zu signierende Ha
197197
----
198198
HTTP/1.1 200 OK
199199
Content-Type: text/xml;charset=utf-8
200-
include::../examples/konnektorservice/response_ExternalAuthenticate.xml[]
200+
include::../resources/examples/konnektorservice/response_ExternalAuthenticate.xml[]
201201
----
202202

203203

@@ -378,7 +378,7 @@ Nach dem erfolgreichen Abschluss der Bearbeitung des Requests durch die VAU des
378378
Der HTTP-Statuscode 200 signalisiert dabei die korrekte Verarbeitung und Erstellung der verschlüsselten Antwort. Die innere HTTP-Response des fachlichen Ergebnisses aus der VAU kann dabei einen abweichenden HTTP-Statuscode beinhalten, wenn aufgrund der Daten oder Verarbeitung innerhalb der VAU Fehlerzustände eintreten oder ungültige Daten übergeben wurden. Sei `001111101111100110001001001111010110010010111110101100100011110...` die verschlüsselte Response zum obigen Beispiel. Die Entschlüsselung mit dem für den Request generierten Antwortschlüssel `16bac90134c635e4ec85fae0e4885d9f`mittels AES-GCM liefert die innere HTTP-Response der VAU als leerzeichengetrennte Zeichenkette:
379379
[source,json]
380380
----
381-
include::../examples/vau/response_InnerVau.json[]
381+
include::../resources/examples/vau/response_InnerVau.json[]
382382
----
383383

384384
NOTE: Die innere HTTP-Response hat die folgende Struktur "1" + " " + ursprüngliche-Request-ID + " " + Response-Header-und-Body
File renamed without changes.

resources/docs/erp_abrufen-source.adoc docs_sources/erp_abrufen-source.adoc

+7-7
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ NOTE: Im http-Header des äußeren http-Requests an die VAU (POST /VAU) sind die
8282
*Response*
8383
[source,xml]
8484
----
85-
include::../examples/ti-dienste/task/response_taskAccept.xml[]
85+
include::../resources/examples/ti-dienste/task/response_taskAccept.xml[]
8686
----
8787
NOTE: Das generierte `Secret` stellt den Zugriffscode der abrufenden Apotheke dar und muss in allen folgenden Workflowschritten als `<identifier><value value="*"/></identifier>` angegeben werden, damit nicht eine fremde Apotheke den Prozess übernehmen kann.
8888

@@ -143,7 +143,7 @@ Content-Length: 1234
143143
|Payload |
144144
[source,xml]
145145
----
146-
include::../examples/konnektorservice/request_VerifySignatureTask.xml[]
146+
include::../resources/examples/konnektorservice/request_VerifySignatureTask.xml[]
147147
----
148148

149149
NOTE: Das Element `<m2:Base64Signature></m2:Base64Signature>`enthält das Signaturelement inkl. des signierten E-Rezept-Datensatzes (CAdES-enveloping) als PKCS#7-Datei in Base64-Codierung
@@ -162,7 +162,7 @@ IMPORTANT: Im Verzeichnis link:../samples/qes-cases/HBA-gueltig-bis-24.4.2021[HB
162162
*Response*
163163
[source,xml]
164164
----
165-
include::../examples/konnektorservice/response_VerifySignatureTask.xml[]
165+
include::../resources/examples/konnektorservice/response_VerifySignatureTask.xml[]
166166
----
167167
NOTE: Hier dargestellt ist die QES-Signaturvalidierung einer Koco-Box der durch einen Secunet-Konnektor erzeugten Signatur aus `4fe2013d-ae94-441a-a1b1-78236ae65680_S_SECUN_secu_kon_4.8.2_4.1.3_V_KOCOC_kocobox_3.6.0_2.3.24_resp.xml`. Weitere Beispiele finden sich im Unterordner der link:../samples/qes/signed[Beispiele].
168168

@@ -203,7 +203,7 @@ NOTE: Im http-Header des äußeren http-Requests an die VAU (POST /VAU) sind die
203203
¦Payload ¦
204204
[source,xml]
205205
----
206-
include::../examples/ti-dienste/task/request_taskClose.xml[]
206+
include::../resources/examples/ti-dienste/task/request_taskClose.xml[]
207207
----
208208
NOTE: Mit der Übergabe der MedicationDispense signalisiert der Apotheker den Abschluss des E-Rezept-Workflows. Der Versicherte erhält Informationen über das abgegebene Medikament.
209209

@@ -225,7 +225,7 @@ NOTE: Der Fachdienst wird diese Funktion vorraussichtlich ab ende des ersten Qua
225225
226226
[source,xml]
227227
----
228-
include::../examples/ti-dienste/task/request_taskCloseMultiple.xml[]
228+
include::../resources/examples/ti-dienste/task/request_taskCloseMultiple.xml[]
229229
----
230230
231231
====
@@ -234,7 +234,7 @@ include::../examples/ti-dienste/task/request_taskCloseMultiple.xml[]
234234
*Response*
235235
[source,xml]
236236
----
237-
include::../examples/ti-dienste/task/response_taskClose.xml[]
237+
include::../resources/examples/ti-dienste/task/response_taskClose.xml[]
238238
----
239239
NOTE: Im Ergebnis der Operation wird ein signiertes Bundle als Nachweis des ordnungsgemäßen Durchlaufs des E-Rezept-Workflows zurückgegeben.
240240

@@ -429,7 +429,7 @@ NOTE: Im http-Header des äußeren http-Requests an die VAU (POST /VAU) sind die
429429
*Response*
430430
[source,xml]
431431
----
432-
include::../examples/ti-dienste/task/response_taskGet.xml[]
432+
include::../resources/examples/ti-dienste/task/response_taskGet.xml[]
433433
----
434434
In `<resource><Bundle/></resource>` wird die Quittung wird als Objekt zusammen mit dem Task zurückgegeben
435435

resources/docs/erp_abrufen_egk-source.adoc docs_sources/erp_abrufen_egk-source.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ NOTE: Im http-Header des äußeren http-Requests an die VAU (POST /VAU) sind die
246246
*Response*
247247
[source,xml]
248248
----
249-
include::../examples/ti-dienste/task/response_taskGet_eGK.xml[]
249+
include::../resources/examples/ti-dienste/task/response_taskGet_eGK.xml[]
250250
----
251251

252252
NOTE: Alle gelieferten Tasks haben den Status `<status value="ready" />` und können im Folgenden durch die Apotheke einzeln abgerufen und beliefert werden.

resources/docs/erp_alternative_zuweisung-source.adoc docs_sources/erp_alternative_zuweisung-source.adoc

+8-8
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ SOAPAction: "http://ws.gematik.de/conn/SignatureService/v7.4#SignDocument"
7171
|Payload |
7272
[source,xml]
7373
----
74-
include::../examples/alternative_zuweisung/sign_avs_request.xml[]
74+
include::../resources/examples/alternative_zuweisung/sign_avs_request.xml[]
7575
----
7676
NOTE: Mit der Referenz `<m2:SignatureType>urn:ietf:rfc:5652</m2:SignatureType>` auf den RFC-5652 erfolgt die Erzeugung der nonQES als CMS-Signatur (CAdES).
7777

@@ -85,7 +85,7 @@ NOTE: In `<ns5:Document ID="CMS-Doc1" ShortText="a CMSDocument2sign">` erfolgt d
8585
*Response*
8686
[source,xml]
8787
----
88-
include::../examples/alternative_zuweisung/sign_avs_response.xml[]
88+
include::../resources/examples/alternative_zuweisung/sign_avs_response.xml[]
8989
----
9090
NOTE: Das Ergebnis der erfolgreichen nonQES wird Base64-codiert in `<ns7:SignatureObject>` zurückgegeben. Darin enthalten ist eine PKCS#7-Datei in HEX-Codierung, die mit einem ASN1-Decoder angesehen werden kann.
9191

@@ -159,7 +159,7 @@ Das APOVZD stellt jedes Zertifikat in einer eigenen FHIR-Binary-Ressource bereit
159159
Beispiel eines solchen Binaries:
160160
[[apovzd-cert-binary]]
161161
----
162-
include::../examples/alternative_zuweisung/certificate_in_apovzd.json[]
162+
include::../resources/examples/alternative_zuweisung/certificate_in_apovzd.json[]
163163
----
164164

165165
Das Synchronisieren vom Upload-Container in das APOVZD erfolgt täglich zwischen 0 und 6 Uhr. Spätestens ab 6 Uhr ist die Änderung für das E-Rezept-FdV verfügbar.
@@ -177,7 +177,7 @@ Dem E-Rezept-FdV werden über das APOVZD die URLs innerhalb der LocationRessourc
177177

178178
Beispiel:
179179
----
180-
include::../examples/alternative_zuweisung/url_in_apovzd.json[]
180+
include::../resources/examples/alternative_zuweisung/url_in_apovzd.json[]
181181
----
182182

183183
Um aus dem E-Rezept-FdV nach Apotheken zu filtern, die dieses Feature unterstützen, wird ein zusätzlicher Type DELEGATOR aus dem Codesystem http://terminology.hl7.org/CodeSystem/v3-RoleCode eingeführt.
@@ -213,7 +213,7 @@ Als Versicherter möchte ich mein Rezept an die Apotheke meiner Wahl übermittel
213213
Der folgende Datensatz wird erstellt:
214214

215215
----
216-
include::../examples/alternative_zuweisung/message_from_fdv.json[]
216+
include::../resources/examples/alternative_zuweisung/message_from_fdv.json[]
217217
----
218218

219219
=== Verschlüsselung des Datensatzes
@@ -239,7 +239,7 @@ Diese ASN.1-Struktur muss Base64-DER codiert im Aufruf der Verschlüsselungsoper
239239
Das folgende beispielhafte Kommando verschlüsselt einen Datensatz für ein ENC-Zertifikat inkl. Einbettung der unsafe-Attribute (kotlin-Code).
240240

241241
----
242-
include::../examples/alternative_zuweisung/example_encryption.java[]
242+
include::../resources/examples/alternative_zuweisung/example_encryption.java[]
243243
----
244244

245245
Der erhaltene CMS-Datensatz enthält unter der genannten OID die Entschlüsselungsinformationen für den Empfänger:
@@ -259,13 +259,13 @@ Wenn das FdV eine mit dem Zertifikat der SMB-C verschlüsselte Nachricht an den
259259
=== Entschlüsselung der Nachricht
260260
Der übermittelte CMS-Datensatz enthält die notwendigen Informationen zur Lokalisierung der für die Entschlüsselung zu nutzende SMC-B. Der Datensatz kann mit der Operation `DecryptDocument` des Konnektors entschlüsselt werden.
261261
----
262-
include::../examples/alternative_zuweisung/decrypt_request.xml[]
262+
include::../resources/examples/alternative_zuweisung/decrypt_request.xml[]
263263
----
264264

265265
Der entschlüsselte Datensatz enthält folgende Informationen:
266266

267267
----
268-
include::../examples/alternative_zuweisung/message_from_fdv.json[]
268+
include::../resources/examples/alternative_zuweisung/message_from_fdv.json[]
269269
----
270270

271271
NOTE: "transactionID" beinhaltet die von der E-Rezept-App erzeuge UUID zur eindeutigen Identifikation der Transaktion.

resources/docs/erp_alternative_zuweisung.adoc docs_sources/erp_alternative_zuweisung.adoc

+8-8
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ SOAPAction: "http://ws.gematik.de/conn/SignatureService/v7.4#SignDocument"
7171
|Payload |
7272
[source,xml]
7373
----
74-
include::../examples/alternative_zuweisung/sign_avs_request.xml[]
74+
include::../resources/examples/alternative_zuweisung/sign_avs_request.xml[]
7575
----
7676
NOTE: Mit der Referenz `<m2:SignatureType>urn:ietf:rfc:5652</m2:SignatureType>` auf den RFC-5652 erfolgt die Erzeugung der nonQES als CMS-Signatur (CAdES).
7777

@@ -85,7 +85,7 @@ NOTE: In `<ns5:Document ID="CMS-Doc1" ShortText="a CMSDocument2sign">` erfolgt d
8585
*Response*
8686
[source,xml]
8787
----
88-
include::../examples/alternative_zuweisung/sign_avs_response.xml[]
88+
include::../resources/examples/alternative_zuweisung/sign_avs_response.xml[]
8989
----
9090
NOTE: Das Ergebnis der erfolgreichen nonQES wird Base64-codiert in `<ns7:SignatureObject>` zurückgegeben. Darin enthalten ist eine PKCS#7-Datei in HEX-Codierung, die mit einem ASN1-Decoder angesehen werden kann.
9191

@@ -159,7 +159,7 @@ Das APOVZD stellt jedes Zertifikat in einer eigenen FHIR-Binary-Ressource bereit
159159
Beispiel eines solchen Binaries:
160160
[[apovzd-cert-binary]]
161161
----
162-
include::../examples/alternative_zuweisung/certificate_in_apovzd.json[]
162+
include::../resources/examples/alternative_zuweisung/certificate_in_apovzd.json[]
163163
----
164164

165165
Das Synchronisieren vom Upload-Container in das APOVZD erfolgt täglich zwischen 0 und 6 Uhr. Spätestens ab 6 Uhr ist die Änderung für das E-Rezept-FdV verfügbar.
@@ -177,7 +177,7 @@ Dem E-Rezept-FdV werden über das APOVZD die URLs innerhalb der LocationRessourc
177177

178178
Beispiel:
179179
----
180-
include::../examples/alternative_zuweisung/url_in_apovzd.json[]
180+
include::../resources/examples/alternative_zuweisung/url_in_apovzd.json[]
181181
----
182182

183183
Um aus dem E-Rezept-FdV nach Apotheken zu filtern, die dieses Feature unterstützen, wird ein zusätzlicher Type DELEGATOR aus dem Codesystem http://terminology.hl7.org/CodeSystem/v3-RoleCode eingeführt.
@@ -213,7 +213,7 @@ Als Versicherter möchte ich mein Rezept an die Apotheke meiner Wahl übermittel
213213
Der folgende Datensatz wird erstellt:
214214

215215
----
216-
include::../examples/alternative_zuweisung/message_from_fdv.json[]
216+
include::../resources/examples/alternative_zuweisung/message_from_fdv.json[]
217217
----
218218

219219
=== Verschlüsselung des Datensatzes
@@ -239,7 +239,7 @@ Diese ASN.1-Struktur muss Base64-DER codiert im Aufruf der Verschlüsselungsoper
239239
Das folgende beispielhafte Kommando verschlüsselt einen Datensatz für ein ENC-Zertifikat inkl. Einbettung der unsafe-Attribute (kotlin-Code).
240240

241241
----
242-
include::../examples/alternative_zuweisung/example_encryption.java[]
242+
include::../resources/examples/alternative_zuweisung/example_encryption.java[]
243243
----
244244

245245
Der erhaltene CMS-Datensatz enthält unter der genannten OID die Entschlüsselungsinformationen für den Empfänger:
@@ -259,13 +259,13 @@ Wenn das FdV eine mit dem Zertifikat der SMB-C verschlüsselte Nachricht an den
259259
=== Entschlüsselung der Nachricht
260260
Der übermittelte CMS-Datensatz enthält die notwendigen Informationen zur Lokalisierung der für die Entschlüsselung zu nutzende SMC-B. Der Datensatz kann mit der Operation `DecryptDocument` des Konnektors entschlüsselt werden.
261261
----
262-
include::../examples/alternative_zuweisung/decrypt_request.xml[]
262+
include::../resources/examples/alternative_zuweisung/decrypt_request.xml[]
263263
----
264264

265265
Der entschlüsselte Datensatz enthält folgende Informationen:
266266

267267
----
268-
include::../examples/alternative_zuweisung/message_from_fdv.json[]
268+
include::../resources/examples/alternative_zuweisung/message_from_fdv.json[]
269269
----
270270

271271
NOTE: "transactionID" beinhaltet die von der E-Rezept-App erzeuge UUID zur eindeutigen Identifikation der Transaktion.

resources/docs/erp_bereitstellen-source.adoc docs_sources/erp_bereitstellen-source.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ NOTE: Der Parameter `<code value="*"/>` steuert den Typ des dem Task zugrunde l
9090
HTTP/1.1 201 Created
9191
Content-Type: application/fhir+xml; charset=UTF-8
9292
93-
include::../examples/ti-dienste/task/response_taskCreate.xml[]
93+
include::../resources/examples/ti-dienste/task/response_taskCreate.xml[]
9494
----
9595

9696
NOTE: Der unter dem Identifier `GEM_ERP_NS_PrescriptionId` hinterlegte `<identifier><value value="*"/></identifier>` stellt die 10 Jahre lang eineindeutige Rezept-ID dar.
@@ -141,7 +141,7 @@ CAUTION: DEPRECATED KBV-Bundle, zulässig bis 30.06.2023
141141
142142
[source,xml]
143143
----
144-
include::../examples/kbv/Prescription_bundle.xml[]
144+
include::../resources/examples/kbv/Prescription_bundle.xml[]
145145
----
146146
====
147147

@@ -174,7 +174,7 @@ SOAPAction: "http://ws.gematik.de/conn/SignatureService/v7.4#SignDocument"
174174
|Payload |
175175
[source,xml]
176176
----
177-
include::../examples/konnektorservice/request_SignDocument.xml[]
177+
include::../resources/examples/konnektorservice/request_SignDocument.xml[]
178178
----
179179
NOTE: Mit der Referenz `<m2:SignatureType>urn:ietf:rfc:5652</m2:SignatureType>` auf den RFC-5652 erfolgt die Erzeugung der QES als CMS-Signatur (CAdES).
180180

@@ -192,7 +192,7 @@ IMPORTANT: Der Parameter `IncludeRevocationInfo = true` ist von herausragender B
192192
*Response*
193193
[source,xml]
194194
----
195-
include::../examples/konnektorservice/response_SignDocument.xml[]
195+
include::../resources/examples/konnektorservice/response_SignDocument.xml[]
196196
----
197197
NOTE: Das Ergebnis der erfolgreichen qualifizierten Signatur wird Base64-codiert in `<ns5:SignatureObject>` zurückgegeben. Darin enthalten ist eine PKCS#7-Datei in HEX-Codierung, die mit einem ASN1-Decoder angesehen werden kann.
198198

@@ -252,7 +252,7 @@ NOTE: Bei dem Wert in `<Binary><data value="*"/></Binary>` handelt es sich um di
252252
*Response*
253253
[source,xml]
254254
----
255-
include::../examples/ti-dienste/task/response_taskActivate.xml[]
255+
include::../resources/examples/ti-dienste/task/response_taskActivate.xml[]
256256
----
257257
NOTE: Der E-Rezept-Fachdienst prüft die Gültigkeit der qualifizierten Signatur des übergebenen FHIR-Bundles. Bei Gültigkeit wird der Task aktiviert und die Zuordnung des Task zum Patienten auf Basis der KVNR im Task unter dem `value` von `<system value="http://fhir.de/sid/gkv/kvid-10"/>` hinterlegt.
258258

0 commit comments

Comments
 (0)