diff --git a/docs/erp_chargeItem.adoc b/docs/erp_chargeItem.adoc index ce80ea0d..b5a84e04 100644 --- a/docs/erp_chargeItem.adoc +++ b/docs/erp_chargeItem.adoc @@ -181,7 +181,7 @@ NOTE: In den Profilen ist unter meta.profile auch die Version mit anzugeben. (Bs - + @@ -211,7 +211,7 @@ NOTE: In den Profilen ist unter meta.profile auch die Version mit anzugeben. (Bs - + @@ -268,15 +268,15 @@ Content-Type: application/fhir+xml;charset=utf-8 - + - + - + @@ -388,25 +388,25 @@ NOTE: Mit dem ACCESS_TOKEN im `Authorization`-Header weist sich der Zugreifende - + - - + + - - + + - + - + @@ -515,10 +515,10 @@ NOTE: Mit dem ACCESS_TOKEN im `Authorization`-Header weist sich der Zugreifende - + - + @@ -931,7 +931,7 @@ NOTE: Mit dem ACCESS_TOKEN im `Authorization`-Header weist sich der Zugreifende - + @@ -1193,7 +1193,7 @@ NOTE: In den Profilen ist unter meta.profile auch die Version mit anzugeben. (Bs - + @@ -1223,15 +1223,15 @@ NOTE: In den Profilen ist unter meta.profile auch die Version mit anzugeben. (Bs - + - + - + @@ -1277,15 +1277,15 @@ NOTE: In `` fügt die abgebende LEI ihren geänderten Abgabe - + - + - + @@ -1421,15 +1421,15 @@ NOTE: Mit dem ACCESS_TOKEN im `Authorization`-Header weist sich der Zugreifende "supportingInformation": [ { "display": "https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Bundle", - "reference": "urn:uuid:d9a98ce4-9585-4031-ba85-3719bf0fc14a" + "reference": "urn:uuid:ChargeItem-KBV-Bundle" }, { - "display": "http://fhir.abda.de/eRezeptAbgabedaten/StructureDefinition/DAV-PKV-PR-ERP-AbgabedatenBundle", - "reference": "urn:uuid:f1909de6-7d21-443b-a2ae-230b9cb62f70-1" + "display": "https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_Bundle", + "reference": "urn:uuid:ChargeItem-Receipt-Bundle" }, { - "display": "https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_Bundle", - "reference": "urn:uuid:d45fa5b0-7b01-457f-a41f-b1ea28982963" + "display": "http://fhir.abda.de/eRezeptAbgabedaten/StructureDefinition/DAV-PKV-PR-ERP-AbgabedatenBundle", + "reference": "urn:uuid:ChargeItem-Abgabedaten-Bundle" } ], "code": { @@ -1605,15 +1605,15 @@ NOTE: Mit dem ACCESS_TOKEN im `Authorization`-Header weist sich der Zugreifende "supportingInformation": [ { "display": "https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Bundle", - "reference": "urn:uuid:42a8260d-579f-4cde-a288-4de0bfb6e6d9" + "reference": "urn:uuid:ChargeItem-PKV-KBV-Bundle" }, { "display": "http://fhir.abda.de/eRezeptAbgabedaten/StructureDefinition/DAV-PKV-PR-ERP-AbgabedatenBundle", - "reference": "urn:uuid:f1909de6-7d21-443b-a2ae-230b9cb62f70-1" + "reference": "urn:uuid:ChargeItem-PKV-Abgabedaten-Bundle" }, { "display": "https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_Bundle", - "reference": "urn:uuid:42772ecc-3d67-4351-a719-2d728426a06b" + "reference": "urn:uuid:ChargeItem-Receipt-Bundle" } ], "code": { @@ -1628,10 +1628,10 @@ NOTE: Mit dem ACCESS_TOKEN im `Authorization`-Header weist sich der Zugreifende } }, { - "fullUrl": "urn:uuid:f1909de6-7d21-443b-a2ae-230b9cb62f70-1", + "fullUrl": "urn:uuid:ChargeItem-Receipt-Bundle", "resource": { "resourceType": "Bundle", - "id": "f1909de6-7d21-443b-a2ae-230b9cb62f70-1", + "id": "ChargeItem-Receipt-Bundle", "meta": { "profile": [ "https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_Bundle|1.5" @@ -1769,10 +1769,10 @@ NOTE: Mit dem ACCESS_TOKEN im `Authorization`-Header weist sich der Zugreifende } }, { - "fullUrl": "urn:uuid:42a8260d-579f-4cde-a288-4de0bfb6e6d9", + "fullUrl": "urn:uuid:ChargeItem-PKV-KBV-Bundle", "resource": { "resourceType": "Bundle", - "id": "42a8260d-579f-4cde-a288-4de0bfb6e6d9", + "id": "ChargeItem-PKV-KBV-Bundle", "meta": { "profile": [ "https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Bundle|1.3" @@ -2333,7 +2333,7 @@ NOTE: Mit dem ACCESS_TOKEN im `Authorization`-Header weist sich der Zugreifende } }, { - "fullUrl": "urn:uuid:42772ecc-3d67-4351-a719-2d728426a06b", + "fullUrl": "urn:uuid:ChargeItem-PKV-Abgabedaten-Bundle", "resource": { "resourceType": "Bundle", "id": "6d240a29-144f-477b-b8e7-92d4b4bcebfd", @@ -2754,15 +2754,15 @@ NOTE: Im `"valueString": "ChargeItem.extension('https://gematik.de/fhir/erpchrg/ "supportingInformation": [ { "display": "https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Bundle", - "reference": "urn:uuid:d9a98ce4-9585-4031-ba85-3719bf0fc14a" + "reference": "urn:uuid:ChargeItem-KBV-Bundle" }, { "display": "http://fhir.abda.de/eRezeptAbgabedaten/StructureDefinition/DAV-PKV-PR-ERP-AbgabedatenBundle", - "reference": "urn:uuid:f1909de6-7d21-443b-a2ae-230b9cb62f70-1" + "reference": "urn:uuid:ChargeItem-Receipt-Bundle" }, { "display": "https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_Bundle", - "reference": "urn:uuid:d45fa5b0-7b01-457f-a41f-b1ea28982963" + "reference": "urn:uuid:ChargeItem-Abgabedaten-Bundle" } ], "code": { diff --git a/docs/erp_diga.adoc b/docs/erp_diga.adoc index 9b779d5c..c935af33 100644 --- a/docs/erp_diga.adoc +++ b/docs/erp_diga.adoc @@ -1437,17 +1437,17 @@ NOTE: Im http-Header des äußeren http-Requests an die VAU (POST /VAU) sind die - + - + - + diff --git a/docs/erp_fhirversion_change_20251001.adoc b/docs/erp_fhirversion_change_20251001.adoc index 6577b94e..3cf29024 100644 --- a/docs/erp_fhirversion_change_20251001.adoc +++ b/docs/erp_fhirversion_change_20251001.adoc @@ -133,7 +133,7 @@ Weiterhin sind die Releasenotes der FHIR-Packages zu beachten: [%autowidth] |=== h| Herausgeber h|FHIR Package h| Beispiele -| gematik | link:https://simplifier.net/packages/de.gematik.erezept-workflow.r4/1.5.1[de.gematik.erezept-workflow.r4 Package 1.5.1^] | link:https://github.com/gematik/eRezept-Examples/tree/main/Standalone-Examples/de.gematik.erezept-workflow.r4/1.5.1[Beispiele 1.5.1^] +| gematik | link:https://simplifier.net/packages/de.gematik.erezept-workflow.r4/1.5.2[de.gematik.erezept-workflow.r4 Package 1.5.2^] | link:https://github.com/gematik/eRezept-Examples/tree/2025-10-01/Standalone-Examples/de.gematik.erezept-workflow.r4[Beispiele 1.5.2^] | gematik | link:https://simplifier.net/packages/de.gematik.erezept-patientenrechnung.r4/1.1.0[de.gematik.erezept-patientenrechnung.r4 Package 1.1.0^] | link:https://github.com/gematik/eRezept-Examples/tree/main/Standalone-Examples/de.gematik.erezept-patientenrechnung.r4/1.1.0[Beispiele 1.1.0] | gematik | link:https://simplifier.net/packages/de.gematik.erezept.eu/1.0.0[de.gematik.erezept.eu Package 1.0.0^] | link:https://github.com/gematik/eRezept-Examples/tree/main/Standalone-Examples/de.gematik.erezept.eu/1.0.0[TODO] | DAV | link:https://simplifier.net/packages/de.abda.erezeptabgabedaten/1.5.0[de.abda.eRezeptAbgabedaten Package 1.5.0^] | link:https://github.com/gematik/eRezept-Examples/tree/main/Standalone-Examples/de.abda.eRezeptAbgabedaten/1.5.0[Beispiele 1.5.0] diff --git a/docs/erp_push_notifications.adoc b/docs/erp_push_notifications.adoc index 01d97a09..5c15edc2 100644 --- a/docs/erp_push_notifications.adoc +++ b/docs/erp_push_notifications.adoc @@ -44,139 +44,28 @@ Ist `kind` nicht `null`, wird der Pusher mit dieser `app_id` und `pushkey` für [cols="h,a", width="100%", separator=¦] [%autowidth] |=== -¦URI ¦https://erp.zentral.erp.splitdns.ti-dienste.de/pushers/set -¦Method ¦POST -¦Requester ¦image:{FdV}[] +¦URI ¦https://erp.zentral.erp.splitdns.ti-dienste.de/pushers/set +¦Method ¦POST +¦Requester ¦image:{FdV}[] ¦HTTP Header ¦ ---- Authorization: Bearer (string, required) ---- -¦Payload ¦ -.Schema (application/json) (Klicken zum Ausklappen) +¦Payload ¦ +.Request Body für registration (Klicken zum Ausklappen) [%collapsible] ==== -[source,json] +[source] ---- -{ - "type": "object", - "title": "Pusher", - "properties": { - "pushkey": { - "type": "string", - "description": "This is a unique identifier for this pusher. The value you\nshould use for this is the routing or destination address\ninformation for the notification, for example, the APNS token\nfor APNS or the Registration ID for GCM. If your notification\nclient has no such concept, use any unique identifier.\nMax length, 512 bytes.\n\nIf the `kind` is `\"email\"`, this is the email address to\nsend notifications to." - }, - "kind": { - "description": "The kind of pusher to configure. `\"http\"` makes a pusher that\nsends HTTP pokes. `\"email\"` makes a pusher that emails the\nuser with unread notifications. `null` deletes the pusher.", - "type": "string", - "nullable": true - }, - "app_id": { - "type": "string", - "description": "This is a reverse-DNS style identifier for the application.\nIt is recommended that this end with the platform, such that\ndifferent platform versions get different app identifiers.\nMax length, 64 chars.\n\nIf the `kind` is `\"email\"`, this is `\"m.email\"`." - }, - "app_display_name": { - "type": "string", - "description": "Required if `kind` is not `null`. A string that will allow the\nuser to identify what application owns this pusher." - }, - "device_display_name": { - "type": "string", - "description": "Required if `kind` is not `null`. A string that will allow the\nuser to identify what device owns this pusher." - }, - "profile_tag": { - "type": "string", - "description": "This string determines which set of device specific rules this\npusher executes." - }, - "lang": { - "type": "string", - "description": "Required if `kind` is not `null`. The preferred language for\nreceiving notifications (e.g. 'en' or 'en-US')." - }, - "data": { - "type": "object", - "description": "Required if `kind` is not `null`. A dictionary of information\nfor the pusher implementation itself.\n\nIf `kind` is `http`, this MUST contain `url` which is the URL\nto use for sending notifications. Clients MAY use this object\nto pass custom data to their push gateway. Servers MUST forward\nthe entire content including `format` and any custom keys but excluding `url`\nwhen calling [`/notify`](./push_gateway_openapi.html#tag/Push-Gateway/operation/push_v1_notify_plain) \nor [`/notifyEncrypted`](./push_gateway_openapi.html#tag/Push-Gateway/operation/push_v1_notify_batch_encrypted).", - "title": "PusherData", - "properties": { - "url": { - "type": "string", - "format": "uri", - "description": "Required if `kind` is `http`. The URL to use for sending\nnotifications. MUST be an HTTPS URL with a path of\n`/_matrix/push/v1/`.", - "example": "https://push-gateway.location.here/_matrix/push/v1/" - }, - "format": { - "type": "string", - "description": "The format to send notifications in to Push Gateways if the\n`kind` is `http`. The details about what fields the\nhomeserver should send to the push gateway are defined in the\n[Push Gateway Specification](/push-gateway-api/).\n\n**TIM:** Currently the only format available is `event_id_only`.\n\n**Others:** This property is not used and should be omitted unless\nspecified explicitly by the service implementing this specification." - } - } - }, - "encryption": { - "type": "object", - "description": "This object contains information on how to encrypt the notifications for the pusher.\nThis property may be `required` or `forbidden` depending on what service it is called on.", - "properties": { - "method": { - "type": "string", - "description": "The encryption method to use. As currently only AES/GCM with a key generated using HKDF is supported, this value is static and should be 'aes-hmac-sha256'." - }, - "time_iss_created": { - "type": "string", - "description": "A string in the format \"yyyy-MM\" that specifies the first period the cypher key is generated for." - }, - "iss": { - "type": "string", - "description": "A string containing the hex representation of the 256 bit initial shared secret." - }, - "key_identifier": { - "type": "string", - "description": "A string containing an identifier for the key. This is used\nto identify the key and the corresponding service (Fachdienst)\nwhen a push notification is received within the FdV. The\n`key_identifier` must be random and must not be reused for a\ndifferent ISS. An UUID is recommended." - } - } - }, - "append": { - "type": "boolean", - "description": "If true, the homeserver should add another pusher with the\ngiven pushkey and App ID in addition to any others with\ndifferent user IDs. Otherwise, the homeserver must remove any\nother pushers with the same App ID and pushkey for different\nusers. The default is `false`." - } - }, - "required": [ - "kind", - "app_id", - "pushkey" - ] -} +https://raw.githubusercontent.com/gematik/gem-push-notifications-concept/refs/tags/1.0.0/docs_sources/definitions/pusher_post_put_delete.yaml#/examples/registration ---- ==== -.Request Body (application/json) für registration (Klicken zum Ausklappen) +.Request Body für deletion (Klicken zum Ausklappen) [%collapsible] ==== -[source,json] +[source] ---- -{ - "lang": "en", - "kind": "http", - "app_display_name": "Mat Rix", - "device_display_name": "iPhone 9", - "app_id": "com.example.app.ios", - "pushkey": "", - "data": { - "url": "https://push-gateway.location.here/_matrix/push/v1/" - }, - "encryption": { - "method": "aes-hmac-sha256", - "time_iss_created": "2023-10", - "iss": "000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f", - "key_identifier": "f47ac10b-58cc-4372-a567-0e02b2c3d479" - }, - "append": false -} ----- -==== -.Request Body (application/json) für deletion (Klicken zum Ausklappen) -[%collapsible] -==== -[source,json] ----- -{ - "app_id": "com.example.app.ios", - "pushkey": "", - "kind": null -} +https://raw.githubusercontent.com/gematik/gem-push-notifications-concept/refs/tags/1.0.0/docs_sources/definitions/pusher_post_put_delete.yaml#/examples/deletion ---- ==== |=== @@ -185,27 +74,13 @@ Authorization: Bearer (string, required) [cols="h,a", width="100%", separator=¦] [%autowidth] |=== -¦HTTP Header ¦ ----- ----- -¦Payload ¦ -.Schema (200, application/json) (Klicken zum Ausklappen) +¦Payload ¦ +.Response Body (200) für response (Klicken zum Ausklappen) [%collapsible] ==== -[source,json] +[source,] ---- -{ - "type": "object", - "description": "An empty object." -} ----- -==== -.Response Body (200, application/json) für response (Klicken zum Ausklappen) -[%collapsible] -==== -[source,json] ----- -{} +include::[] ---- ==== @@ -241,14 +116,14 @@ Ruft alle aktuell aktiven Pusher für den authentifizierten Nutzer ab. [cols="h,a", width="100%", separator=¦] [%autowidth] |=== -¦URI ¦https://erp.zentral.erp.splitdns.ti-dienste.de/pushers -¦Method ¦GET -¦Requester ¦image:{FdV}[] +¦URI ¦https://erp.zentral.erp.splitdns.ti-dienste.de/pushers +¦Method ¦GET +¦Requester ¦image:{FdV}[] ¦HTTP Header ¦ ---- Authorization: Bearer (string, required) ---- -¦Payload ¦ +¦Payload ¦ No request body. |=== ==== Response @@ -256,110 +131,121 @@ No request body. [cols="h,a", width="100%", separator=¦] [%autowidth] |=== -¦HTTP Header ¦ ----- ----- -¦Payload ¦ -.Schema (200, application/json) (Klicken zum Ausklappen) +¦Payload ¦ +.Response Body (200) für response (Klicken zum Ausklappen) [%collapsible] ==== -[source,json] ----- -{ - "properties": { - "pushers": { - "type": "array", - "title": "Pushers", - "description": "An array containing the current pushers for the user", - "items": { - "type": "object", - "properties": { - "pushkey": { - "type": "string" - }, - "kind": { - "description": "The kind of pusher to configure. `\"http\"` makes a pusher that\nsends HTTP pokes. `null` deletes the pusher.", - "type": "string", - "nullable": true - }, - "app_id": { - "type": "string", - "description": "This is a reverse-DNS style identifier for the application.\nIt is recommended that this end with the platform, such that\ndifferent platform versions get different app identifiers.\nMax length, 64 chars." - }, - "app_display_name": { - "type": "string", - "description": "Required if `kind` is not `null`. A string that will allow the\nuser to identify what application owns this pusher." - }, - "device_display_name": { - "type": "string", - "description": "Required if `kind` is not `null`. A string that will allow the\nuser to identify what device owns this pusher." - }, - "profile_tag": { - "type": "string", - "description": "**UNUSED** This string determines which set of device specific rules this\npusher executes." - }, - "lang": { - "type": "string", - "description": "Required if `kind` is not `null`. The preferred language for\nreceiving notifications (e.g. 'en' or 'en-US')." - }, +[source,] +---- +examples: + response: + value: { + "pushers": [ + { + "pushkey": "Xp/MzCt8/9DcSNE9cuiaoT5Ac55job3TdLSSmtmYl4A=", + "kind": "http", + "app_id": "face.mcapp.appy.prod", + "app_display_name": "Appy McAppface", + "device_display_name": "Alice's Phone", + "profile_tag": "xyz", + "lang": "en-US", "data": { - "type": "object", - "description": "Required if `kind` is not `null`. A dictionary of information\nfor the pusher implementation itself.\n\nIf `kind` is `http`, this MUST contain `url` which is the URL\nto use for sending notifications. Clients MAY use this object\nto pass custom data to their push gateway. Servers MUST forward\nthe entire content including `format` and any custom keys but excluding `url`\nwhen calling [`/push/v1/notify*`](/push-gateway-api/#postpushv1notify).", - "title": "PusherData", - "properties": { - "url": { - "type": "string", - "format": "uri", - "description": "Required if `kind` is `http`. The URL to use for sending\nnotifications. MUST be an HTTPS URL with a path of\n`/push/v1/` that can be extended by `notify`, `notify/batch`\nor `notifyEncrypted/batch`, so that the FD can pick the method, if not\nspecified otherwise by the FD specification.", - "example": "https://push-gateway.location.here/push/v1/" - }, - "format": { - "type": "string", - "description": "The format to send notifications in to Push Gateways if the\n`kind` is `http`. The details about what fields the\nhomeserver should send to the push gateway are defined in the\n[Push Gateway Specification](/push-gateway-api/). Currently the only format\navailable is 'event_id_only'." - } - } - }, - "append": { - "type": "boolean", - "description": "If true, the FD should add another pusher with the\ngiven pushkey and App ID in addition to any others with\ndifferent user IDs. Otherwise, the homeserver must remove any\nother pushers with the same App ID and pushkey for different\nusers. The default is `false`." + "url": "https://example.com/_matrix/push/v1/" } - }, - "required": [ - "pushkey", - "app_id", - "kind", - "app_display_name", - "device_display_name", - "lang", - "data" - ] - } - } - } -} ----- -==== -.Response Body (200, application/json) für response (Klicken zum Ausklappen) -[%collapsible] -==== -[source,json] ----- -{ - "pushers": [ - { - "pushkey": "Xp/MzCt8/9DcSNE9cuiaoT5Ac55job3TdLSSmtmYl4A=", - "kind": "http", - "app_id": "face.mcapp.appy.prod", - "app_display_name": "Appy McAppface", - "device_display_name": "Alice's Phone", - "profile_tag": "xyz", - "lang": "en-US", - "data": { - "url": "https://example.com/_matrix/push/v1/" - } + } + ] } - ] -} +schema: + properties: + pushers: + type: array + title: Pushers + description: An array containing the current pushers for the user + items: + type: object + properties: + pushkey: + type: string + kind: + description: |- + The kind of pusher to configure. `"http"` makes a pusher that + sends HTTP pokes. `null` deletes the pusher. + type: string + nullable: true + app_id: + type: string + description: |- + This is a reverse-DNS style identifier for the application. + It is recommended that this end with the platform, such that + different platform versions get different app identifiers. + Max length, 64 chars. + app_display_name: + type: string + description: |- + Required if `kind` is not `null`. A string that will allow the + user to identify what application owns this pusher. + device_display_name: + type: string + description: |- + Required if `kind` is not `null`. A string that will allow the + user to identify what device owns this pusher. + profile_tag: + type: string + description: |- + **UNUSED** This string determines which set of device specific rules this + pusher executes. + lang: + type: string + description: |- + Required if `kind` is not `null`. The preferred language for + receiving notifications (e.g. 'en' or 'en-US'). + data: + type: object + description: |- + Required if `kind` is not `null`. A dictionary of information + for the pusher implementation itself. + + If `kind` is `http`, this MUST contain `url` which is the URL + to use for sending notifications. Clients MAY use this object + to pass custom data to their push gateway. Servers MUST forward + the entire content including `format` and any custom keys but excluding `url` + when calling [`/push/v1/notify*`](/push-gateway-api/#postpushv1notify). + title: PusherData + properties: + url: + type: string + format: uri + description: |- + Required if `kind` is `http`. The URL to use for sending + notifications. MUST be an HTTPS URL with a path of + `/push/v1/` that can be extended by `notify`, `notify/batch` + or `notifyEncrypted/batch`, so that the FD can pick the method, if not + specified otherwise by the FD specification. + example: https://push-gateway.location.here/push/v1/ + format: + type: string + description: |- + The format to send notifications in to Push Gateways if the + `kind` is `http`. The details about what fields the + homeserver should send to the push gateway are defined in the + [Push Gateway Specification](/push-gateway-api/). Currently the only format + available is 'event_id_only'. + append: + type: boolean + description: |- + If true, the FD should add another pusher with the + given pushkey and App ID in addition to any others with + different user IDs. Otherwise, the homeserver must remove any + other pushers with the same App ID and pushkey for different + users. The default is `false`. + required: + - pushkey + - app_id + - kind + - app_display_name + - device_display_name + - lang + - data ---- ==== @@ -398,14 +284,14 @@ Ruft alle verfügbaren Channels für den authentifizierten Nutzer ab. [cols="h,a", width="100%", separator=¦] [%autowidth] |=== -¦URI ¦https://erp.zentral.erp.splitdns.ti-dienste.de/channels -¦Method ¦GET -¦Requester ¦image:{FdV}[] +¦URI ¦https://erp.zentral.erp.splitdns.ti-dienste.de/channels +¦Method ¦GET +¦Requester ¦image:{FdV}[] ¦HTTP Header ¦ ---- Authorization: Bearer (string, required) ---- -¦Payload ¦ +¦Payload ¦ No request body. |=== ==== Response @@ -413,65 +299,45 @@ No request body. [cols="h,a", width="100%", separator=¦] [%autowidth] |=== -¦HTTP Header ¦ ----- ----- -¦Payload ¦ -.Schema (200, application/json) (Klicken zum Ausklappen) +¦Payload ¦ +.Response Body (200) für response (Klicken zum Ausklappen) [%collapsible] ==== -[source,json] ----- -{ - "type": "object", - "properties": { - "channels": { - "type": "array", - "title": "channels", - "description": "An array containing channels", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The name of the channel" - }, - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - } +[source,] +---- +examples: + response: + value: { + "channels": [ + { + "id": "channel1", + "status": "enabled" }, - "required": [ - "id", - "status" - ] - } - } - } -} ----- -==== -.Response Body (200, application/json) für response (Klicken zum Ausklappen) -[%collapsible] -==== -[source,json] ----- -{ - "channels": [ - { - "id": "channel1", - "status": "enabled" - }, - { - "id": "channel2", - "status": "disabled" + { + "id": "channel2", + "status": "disabled" + } + ] } - ] -} +schema: + type: object + properties: + channels: + type: array + title: channels + description: An array containing channels + items: + type: object + properties: + id: + type: string + description: The name of the channel + status: + type: string + enum: ["enabled", "disabled", "not_set"] + required: + - id + - status ---- ==== @@ -507,14 +373,14 @@ Ruft alle Channels und deren Konfigurationsstatus für das Gerät des authentifi [cols="h,a", width="100%", separator=¦] [%autowidth] |=== -¦URI ¦https://erp.zentral.erp.splitdns.ti-dienste.de/channels/ -¦Method ¦GET -¦Requester ¦image:{FdV}[] +¦URI ¦https://erp.zentral.erp.splitdns.ti-dienste.de/channels/ +¦Method ¦GET +¦Requester ¦image:{FdV}[] ¦HTTP Header ¦ ---- Authorization: Bearer (string, required) ---- -¦Payload ¦ +¦Payload ¦ No request body. |=== ==== Response @@ -522,65 +388,45 @@ No request body. [cols="h,a", width="100%", separator=¦] [%autowidth] |=== -¦HTTP Header ¦ ----- ----- -¦Payload ¦ -.Schema (200, application/json) (Klicken zum Ausklappen) +¦Payload ¦ +.Response Body (200) für response (Klicken zum Ausklappen) [%collapsible] ==== -[source,json] ----- -{ - "type": "object", - "properties": { - "channels": { - "type": "array", - "title": "channels", - "description": "An array containing channels", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The name of the channel" - }, - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - } +[source,] +---- +examples: + response: + value: { + "channels": [ + { + "id": "channel1", + "status": "enabled" }, - "required": [ - "id", - "status" - ] - } + { + "id": "channel2", + "status": "disabled" + } + ] } - } -} ----- -==== -.Response Body (200, application/json) für response (Klicken zum Ausklappen) -[%collapsible] -==== -[source,json] ----- -{ - "channels": [ - { - "id": "channel1", - "status": "enabled" - }, - { - "id": "channel2", - "status": "disabled" - } - ] -} +schema: + type: object + properties: + channels: + type: array + title: channels + description: An array containing channels + items: + type: object + properties: + id: + type: string + description: The name of the channel + status: + type: string + enum: ["enabled", "disabled", "not_set"] + required: + - id + - status ---- ==== @@ -616,69 +462,20 @@ Dieser Endpunkt ermöglicht die Erstellung, Änderung und Löschung von Channel- [cols="h,a", width="100%", separator=¦] [%autowidth] |=== -¦URI ¦https://erp.zentral.erp.splitdns.ti-dienste.de/channels/ -¦Method ¦POST -¦Requester ¦image:{FdV}[] +¦URI ¦https://erp.zentral.erp.splitdns.ti-dienste.de/channels/ +¦Method ¦POST +¦Requester ¦image:{FdV}[] ¦HTTP Header ¦ ---- Authorization: Bearer (string, required) ---- -¦Payload ¦ -.Schema (application/json) (Klicken zum Ausklappen) -[%collapsible] -==== -[source,json] ----- -{ - "type": "object", - "properties": { - "channels": { - "type": "array", - "title": "channels", - "description": "An array containing channels", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the channel" - }, - "value": { - "type": "string", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - } - }, - "required": [ - "name", - "value" - ] - } - } - } -} ----- -==== -.Request Body (application/json) für update (Klicken zum Ausklappen) +¦Payload ¦ +.Request Body für update (Klicken zum Ausklappen) [%collapsible] ==== -[source,json] +[source] ---- -{ - "channels": [ - { - "name": "channel1", - "value": "enabled" - }, - { - "name": "channel2", - "value": "disabled" - } - ] -} +https://raw.githubusercontent.com/gematik/gem-push-notifications-concept/refs/tags/1.0.0/docs_sources/definitions/channels_post.yaml#/examples/update ---- ==== |=== @@ -687,27 +484,13 @@ Authorization: Bearer (string, required) [cols="h,a", width="100%", separator=¦] [%autowidth] |=== -¦HTTP Header ¦ ----- ----- -¦Payload ¦ -.Schema (200, application/json) (Klicken zum Ausklappen) -[%collapsible] -==== -[source,json] ----- -{ - "type": "object", - "description": "An empty object." -} ----- -==== -.Response Body (200, application/json) für response (Klicken zum Ausklappen) +¦Payload ¦ +.Response Body (200) für response (Klicken zum Ausklappen) [%collapsible] ==== -[source,json] +[source,] ---- -{} +include::[] ---- ==== diff --git a/docs_sources/erp_fhirversion_change_20251001-source.adoc b/docs_sources/erp_fhirversion_change_20251001-source.adoc index 52a49036..80632d9d 100644 --- a/docs_sources/erp_fhirversion_change_20251001-source.adoc +++ b/docs_sources/erp_fhirversion_change_20251001-source.adoc @@ -89,7 +89,7 @@ Weiterhin sind die Releasenotes der FHIR-Packages zu beachten: [%autowidth] |=== h| Herausgeber h|FHIR Package h| Beispiele -| gematik | link:https://simplifier.net/packages/de.gematik.erezept-workflow.r4/1.5.1[de.gematik.erezept-workflow.r4 Package 1.5.1^] | link:https://github.com/gematik/eRezept-Examples/tree/main/Standalone-Examples/de.gematik.erezept-workflow.r4/1.5.1[Beispiele 1.5.1^] +| gematik | link:https://simplifier.net/packages/de.gematik.erezept-workflow.r4/1.5.2[de.gematik.erezept-workflow.r4 Package 1.5.2^] | link:https://github.com/gematik/eRezept-Examples/tree/2025-10-01/Standalone-Examples/de.gematik.erezept-workflow.r4[Beispiele 1.5.2^] | gematik | link:https://simplifier.net/packages/de.gematik.erezept-patientenrechnung.r4/1.1.0[de.gematik.erezept-patientenrechnung.r4 Package 1.1.0^] | link:https://github.com/gematik/eRezept-Examples/tree/main/Standalone-Examples/de.gematik.erezept-patientenrechnung.r4/1.1.0[Beispiele 1.1.0] | gematik | link:https://simplifier.net/packages/de.gematik.erezept.eu/1.0.0[de.gematik.erezept.eu Package 1.0.0^] | link:https://github.com/gematik/eRezept-Examples/tree/main/Standalone-Examples/de.gematik.erezept.eu/1.0.0[TODO] | DAV | link:https://simplifier.net/packages/de.abda.erezeptabgabedaten/1.5.0[de.abda.eRezeptAbgabedaten Package 1.5.0^] | link:https://github.com/gematik/eRezept-Examples/tree/main/Standalone-Examples/de.abda.eRezeptAbgabedaten/1.5.0[Beispiele 1.5.0]