Skip to content
Snippets Groups Projects

515_NEW_Rueckkanal_Dokumentation_ueber_die_Verwendung(planning#515, planning#115)

Closed 515_NEW_Rueckkanal_Dokumentation_ueber_die_Verwendung(planning#515, planning#115)
515_NEW_Rueckkanal_Dokumentation_ueber_die_Verwendung into main
Closed Michael Haidner requested to merge 515_NEW_Rueckkanal_Dokumentation_ueber_die_Verwendung into main
Compare
and
Show latest version
11 files
+ 701
− 124
Compare changes
  • Side-by-side
  • Inline
Files
11
docs/getting-started/event-log/events.mdx
+ 304
− 23
@@ -7,12 +7,28 @@ import ApiLink from '@site/src/components/ApiLink'
Das folgende Statusdiagramm zeigt die Status und Ereignisse einer Einreichung. Die Status sind als orange Ovale dargestellt.
Rechtecke stehen für Ereignisse. Blau dargestellte Ereignisse werden vom Zustelldienst, grüne vom empfangenden System erstellt und signiert.
## Statusdiagramm
### Einreichung
<div className="zoom-picture">
![Statusdiagramm](/images/status/status.svg)
![Statusdiagramm Einreichung](/images/status/status_submission.svg)
</div>
### Antwort
<div className="zoom-picture">
![Statusdiagramm Antwort](/images/status/status_reply.svg)
</div>
#### Legende
![Statusdiagramm Legende](/images/status/status_legend.svg)
Das Akzeptieren oder Zurückweisen von Einreichungen findet auf einer rein technischen Ebene statt und trifft keine Aussage über die fachliche Korrektheit der Einreichungen.
Gründe für technische Rückweisungen wären beispielsweise Probleme bei der Entschlüsselung oder Validierungsfehler der Datenstrukturen.
In der folgenden Tabelle sind die möglichen Ereignisse, ihre Beschreibungen und die Autoren aufgeführt und beschrieben.
@@ -24,17 +40,26 @@ In der folgenden Tabelle sind die möglichen Ereignisse, ihre Beschreibungen und
| `https://schema.fitko.de/fit-connect/events/notify-submission` [↓](#notify-submission) | Zustelldienst | Der Subscriber hat Kenntnis von der Einreichung erlangt (der Subscriber wurde per Callback informiert oder hat die Liste der verfügbaren Submissions abgerufen). |
| `https://schema.fitko.de/fit-connect/events/forward-submission` [↓](#forward-submission) | Empfangendes System | Ein nachgelagertes System hat die Einreichung zur Weiterleitung übernommen. |
| `https://schema.fitko.de/fit-connect/events/reject-submission` [↓](#reject-submission) | Empfangendes System/Zustelldienst | Die Einreichung wurde durch den Empfänger zurückgewiesen *oder* die Einreichung war mehr als 14 Tage im Status `submitted` und wurde deshalb vom Zustelldienst zurückgewiesen. |
| `https://schema.fitko.de/fit-connect/events/accept-submission` [↓](#accept-submission) | Empfangendes System | Die Einreichung wurde durch den Empfänger akzeptiert. |
| `https://schema.fitko.de/fit-connect/events/delete-submission` [↓](#delete-submission) | Zustelldienst | Die Einreichung wurde [durch den Zustelldienst gelöscht](../notifications-and-deletion-deadlines.mdx). |
| `https://schema.fitko.de/fit-connect/events/accept-submission` [↓](#accept-submission) | Empfangendes System | Die Einreichung wurde durch den Empfänger akzeptiert. |
| `https://schema.fitko.de/fit-connect/events/delete-submission` [↓](#delete-submission) | Zustelldienst | Die Einreichung wurde [durch den Zustelldienst gelöscht](../notifications-and-deletion-deadlines.mdx). |
| `https://schema.fitko.de/fit-connect/events/create-reply` [↓](#create-reply) | Zustelldienst | Die Antwort wurde durch den Subscriber angelegt. |
| `https://schema.fitko.de/fit-connect/events/submit-reply` [↓](#submit-reply) | Zustelldienst | Die Antwort wurde durch den Subscriber abgesendet. |
| `https://schema.fitko.de/fit-connect/events/notify-reply` [↓](#notify-reply) | Zustelldienst | Der Empfänger (Sender) wurde per Webhook über die Antwort informiert. |
| `https://schema.fitko.de/fit-connect/events/reject-reply` [↓](#reject-reply) | Zustelldienst | Die Antwort wurde durch den Empfänger zurückgewiesen *oder* die Antwort war mehr als 14 Tage im Status `submitted` und wurde deshalb vom Zustelldienst zurückgewiesen. |
| `https://schema.fitko.de/fit-connect/events/accept-reply` [↓](#accept-reply) | Zustelldienst | Die Antwort wurde durch den Empfänger akzeptiert. |
| `https://schema.fitko.de/fit-connect/events/delete-reply` [↓](#delete-reply) | Zustelldienst | Die Antwort wurde [durch den Zustelldienst gelöscht](../notifications-and-deletion-deadlines.mdx). |
| `https://schema.fitko.de/fit-connect/events/close-case` [↓](#close-case) | Zustelldienst | Der Einreichungsvorgang wurde durch den Zustelldienst geschlossen. Es sind keine weiteren Einreichungen oder Antworten möglich. |
## create-submission {#create-submission}
## Submission Events
### create-submission {#create-submission}
Mit dem Event `https://schema.fitko.de/fit-connect/events/create-submission` dokumentiert der Zustelldienst,
dass eine Einreichung angelegt wurde.
```json
{
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.0.0/set-payload.schema.json",
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.2.0/set-payload.schema.json",
"jti": "ada1b5b4-1bd2-4fab-b236-c30ef88e8c72",
"iss": "https://submission-api-dev.fit-connect.fitko.dev",
"iat": 1622796532,
@@ -47,7 +72,7 @@ dass eine Einreichung angelegt wurde.
}
```
## submit-submission {#submit-submission}
### submit-submission {#submit-submission}
Mit dem Event `https://schema.fitko.de/fit-connect/events/submit-submission` dokumentiert der Zustelldienst,
dass die Einreichung abgesendet wurde.
@@ -59,7 +84,7 @@ Das Event enthält das Objekt `authenticationTags`, das die Authentication Tags
```json
{
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.0.0/set-payload.schema.json",
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.2.0/set-payload.schema.json",
"jti": "25d2eb77-458d-4c9d-991c-6428c4651646",
"iss": "https://submission-api-dev.fit-connect.fitko.dev",
"iat": 1622796532,
@@ -81,7 +106,7 @@ Das Event enthält das Objekt `authenticationTags`, das die Authentication Tags
}
```
## notify-submission {#notify-submission}
### notify-submission {#notify-submission}
Mit dem Event `https://schema.fitko.de/fit-connect/events/notify-submission` dokumentiert der Zustelldienst,
dass das empfangende System Kenntnis von der Einreichung erlangt hat.
@@ -91,7 +116,7 @@ Wie dies erfolgt ist, wird mit dem Eintrag `notifyType` dokumentiert.
```json
{
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.0.0/set-payload.schema.json",
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.2.0/set-payload.schema.json",
"jti": "116c3c03-5f31-4d4c-9e65-d36e1e3895f7",
"iss": "https://submission-api-dev.fit-connect.fitko.dev",
"iat": 1622796532,
@@ -109,7 +134,7 @@ Wie dies erfolgt ist, wird mit dem Eintrag `notifyType` dokumentiert.
```json
{
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.0.0/set-payload.schema.json",
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.2.0/set-payload.schema.json",
"jti": "6127ff87-2786-4d0f-90fe-c531672f5de1",
"iss": "https://submission-api-dev.fit-connect.fitko.dev",
"iat": 1622796532,
@@ -123,14 +148,14 @@ Wie dies erfolgt ist, wird mit dem Eintrag `notifyType` dokumentiert.
}
```
## forward-submission {#forward-submission}
### forward-submission {#forward-submission}
Mit dem Event `https://schema.fitko.de/fit-connect/events/forward-submission` dokumentiert ein nachgelagertes System,
dass es die Einreichung zur Weiterleitung übernommen hat.
```json
{
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.0.0/set-payload.schema.json",
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.2.0/set-payload.schema.json",
"jti": "c0cda2aa-bf79-4427-86f3-9f973bad2ecd",
"iss": "40847c29-06aa-40e2-bf28-c29884c694c4",
"iat": 1622796532,
@@ -143,12 +168,12 @@ dass es die Einreichung zur Weiterleitung übernommen hat.
}
```
## reject-submission {#reject-submission}
### reject-submission {#reject-submission}
Mit dem Event `https://schema.fitko.de/fit-connect/events/reject-submission` dokumentiert das empfangende System,
dass die Einreichung zurückgewiesen wird.
Alternativ kann auch der Zustelldienst Einreichungen als `reject` markieren, wenn diese mehr als 14 Tage im Status `submitted` verbleiben.
Alternativ kann auch der Zustelldienst Einreichungen als `rejected` markieren, wenn diese mehr als 14 Tage im Status `submitted` verbleiben.
Unter [Benachrichtigungen und Löschfristen](../notifications-and-deletion-deadlines.mdx) finden sich hierzu genaue Angaben.
Das Event enthält ein Array `problems`, dass die Fehler der Einreichung dokumentiert.
@@ -163,7 +188,7 @@ lässt jedoch den Status aus, weil hier kein passender HTTP Status Code angegebe
```json
{
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.0.0/set-payload.schema.json",
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.2.0/set-payload.schema.json",
"jti": "4ac47caa-bce1-435a-b04f-3322b224b32e",
"iss": "40847c29-06aa-40e2-bf28-c29884c694c4",
"iat": 1622796532,
@@ -184,8 +209,7 @@ lässt jedoch den Status aus, weil hier kein passender HTTP Status Code angegebe
}
```
## accept-submission {#accept-submission}
### accept-submission {#accept-submission}
Mit dem Event `https://schema.fitko.de/fit-connect/events/accept-submission` dokumentiert das empfangende System,
dass die Einreichung akzeptiert wurde.
@@ -195,7 +219,7 @@ Das empfangende System dokumentiert damit, dass es die Authentication Tags über
```json
{
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.0.0/set-payload.schema.json",
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.2.0/set-payload.schema.json",
"jti": "8538165b-9ce3-4097-871d-5b9581a3b4d9",
"iss": "40847c29-06aa-40e2-bf28-c29884c694c4",
"iat": 1622796532,
@@ -223,7 +247,7 @@ werden diese analog zu der `problems` Liste in [`reject-submission`](#reject-sub
```json
{
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.0.0/set-payload.schema.json",
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.2.0/set-payload.schema.json",
"jti": "6872b19f-5ee2-47d7-a0e9-ebfe87ab2563",
"iss": "40847c29-06aa-40e2-bf28-c29884c694c4",
"iat": 1622796532,
@@ -253,14 +277,15 @@ werden diese analog zu der `problems` Liste in [`reject-submission`](#reject-sub
}
```
## delete-submission {#delete-submission}
### delete-submission {#delete-submission}
Mit dem Event `https://schema.fitko.de/fit-connect/events/delete-submission` dokumentiert der Zustelldienst, dass die Einreichung gelöscht wurde.
Die Fristen, wann eine Einreichungen mit welchem Status gelöscht wird, finden sich unter [Benachrichtigungen und Löschfristen](../notifications-and-deletion-deadlines.mdx).
Mit dem Event `https://schema.fitko.de/fit-connect/events/delete-submission` dokumentiert der Zustelldienst, dass die Einreichung gelöscht wurde.
Die Fristen, wann Einreichungen mit welchem Status gelöscht werden,
finden sich unter [Benachrichtigungen und Löschfristen](../notifications-and-deletion-deadlines.mdx).
```json
{
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.0.0/set-payload.schema.json",
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.2.0/set-payload.schema.json",
"jti": "29d091aa-86ab-4806-beb5-fb462d18e2a1",
"iss": "https://submission-api-dev.fit-connect.fitko.dev",
"iat": 1622796532,
@@ -272,3 +297,259 @@ Die Fristen, wann eine Einreichungen mit welchem Status gelöscht wird, finden s
}
}
```
## Reply Events
### create-reply {#create-reply}
Mit dem Event `https://schema.fitko.de/fit-connect/events/create-reply` dokumentiert der Zustelldienst,
dass eine Antwort angelegt wurde.
```json
{
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.2.0/set-payload.schema.json",
"jti": "ada1b5b4-1bd2-4fab-b236-c30ef88e8c72",
"iss": "https://submission-api-dev.fit-connect.fitko.dev",
"iat": 1622796532,
"sub": "reply:02bf1d9f-282d-4abf-810a-c4104baf0afe",
"txn": "case:452b5ee6-35df-441a-bd39-6141723cf914",
"events": {
"https://schema.fitko.de/fit-connect/events/create-reply": {
}
}
}
```
### submit-reply {#submit-reply}
Mit dem Event `https://schema.fitko.de/fit-connect/events/submit-reply` dokumentiert der Zustelldienst,
dass die Antwort abgesendet wurde.
Das Event enthält das Objekt `authenticationTags`, das die Authentication Tags der verschlüsselten Inhalte enthält.
- `metadata`: Authentication Tag des Metadatensatzes
- `data`: Authentication Tag des Fachdatensatzes
- `attachments`: Objekt mit den Authentication Tags der Anlagen mit ihren `attachmentId`s als Schlüssel
```json
{
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.2.0/set-payload.schema.json",
"jti": "25d2eb77-458d-4c9d-991c-6428c4651646",
"iss": "https://submission-api-dev.fit-connect.fitko.dev",
"iat": 1622796532,
"sub": "reply:02bf1d9f-282d-4abf-810a-c4104baf0afe",
"txn": "case:452b5ee6-35df-441a-bd39-6141723cf914",
"events": {
"https://schema.fitko.de/fit-connect/events/submit-reply": {
"authenticationTags": {
"metadata": "XFBoMYUZodetZdvTiFvSkQ",
"data": "UCGiqJxhBI3IFVdPalHHvA",
"attachments": {
"0b799252-deb9-42b0-98d3-c50d24bbafe0": "rT99rwrBTbTI7IJM8fU3El",
"25abf553-0e53-43b9-a14a-1581b32a9ee5": "i7226HEB7IchCxNuh7lCiu",
"046a9fa5-bed6-494b-aab6-d41056c6db79": "d48LxeolRdtFF4nzQibeYO"
}
}
}
}
}
```
### notify-reply {#notify-reply}
Mit dem Event `https://schema.fitko.de/fit-connect/events/notify-reply` dokumentiert der Zustelldienst,
dass das sendende System Kenntnis von der Antwort erlangt hat.
Wie dies erfolgt ist, wird mit dem Eintrag `notifyType` dokumentiert.
1. `"notifyType": "callback"` - Der Sender wurde per Callback informiert.
```json
{
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.2.0/set-payload.schema.json",
"jti": "116c3c03-5f31-4d4c-9e65-d36e1e3895f7",
"iss": "https://submission-api-dev.fit-connect.fitko.dev",
"iat": 1622796532,
"sub": "reply:02bf1d9f-282d-4abf-810a-c4104baf0afe",
"txn": "case:452b5ee6-35df-441a-bd39-6141723cf914",
"events": {
"https://schema.fitko.de/fit-connect/events/notify-reply": {
"notifyType": "callback"
}
}
}
```
2. `"notifyType": "polling"` - Der Sender hat die Liste der Antworten über <ApiLink api="submission-api" to="/v1/replys " withMethod="get"/> abgerufen.
```json
{
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.2.0/set-payload.schema.json",
"jti": "6127ff87-2786-4d0f-90fe-c531672f5de1",
"iss": "https://submission-api-dev.fit-connect.fitko.dev",
"iat": 1622796532,
"sub": "reply:02bf1d9f-282d-4abf-810a-c4104baf0afe",
"txn": "case:452b5ee6-35df-441a-bd39-6141723cf914",
"events": {
"https://schema.fitko.de/fit-connect/events/notify-reply": {
"notifyType": "polling"
}
}
}
```
### reject-reply {#reject-reply}
Mit dem Event `https://schema.fitko.de/fit-connect/events/reject-reply` dokumentiert der Zustelldienst,
dass die Antwort zurückgewiesen wird.
Alternativ kann auch der Zustelldienst Antworten als `rejected` markieren, wenn diese mehr als 14 Tage im Status `submitted` verbleiben.
Unter [Benachrichtigungen und Löschfristen](../notifications-and-deletion-deadlines.mdx) finden sich hierzu genaue Angaben.
Das Event enthält ein Array `problems`, dass die Fehler der Antwort dokumentiert.
Der Aufbau ist an [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807) angelehnt,
lässt jedoch den Status aus, weil hier kein passender HTTP Status Code angegeben werden kann.
- `type`: Fehlercode in Form einer URI.
- `title`: Für Menschen verständliche Fehlermeldung
- `detail`: Details zum Fehler, z.B. eine technische Fehlermeldung (optional)
- `instance`: Betroffener Teil der Übertragung.
Mögliche Werte: `reply`, `metadata`, `data`, `attachment:` + UUID des Attachments oder `other`
```json
{
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.2.0/set-payload.schema.json",
"jti": "4ac47caa-bce1-435a-b04f-3322b224b32e",
"iss": "40847c29-06aa-40e2-bf28-c29884c694c4",
"iat": 1622796532,
"sub": "reply:02bf1d9f-282d-4abf-810a-c4104baf0afe",
"txn": "case:452b5ee6-35df-441a-bd39-6141723cf914",
"events": {
"https://schema.fitko.de/fit-connect/events/reject-reply": {
"problems": [
{
"type": "https://schema.fitko.de/fit-connect/events/problems/authentication-tag-incorrect",
"title": "Das Authentication Tag des Metadatensatzes ist ungültig",
"detail": "Das Authentication Tag des Metadatensatzes stimmt nicht mit dem im Submit-Submission-Event angegebenen Wert überein.",
"instance": "metadata"
}
]
}
}
}
```
### accept-reply {#accept-reply}
Mit dem Event `https://schema.fitko.de/fit-connect/events/accept-reply` dokumentiert der Zustelldienst,
dass die Antwort akzeptiert wurde.
Das Event muss eine mit dem [`submit-reply`](#submit-reply) Event übereinstimmende Liste von Authentication Tags enthalten.
Das sendende System dokumentiert damit, dass es die Authentication Tags überprüft hat.
```json
{
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.2.0/set-payload.schema.json",
"jti": "8538165b-9ce3-4097-871d-5b9581a3b4d9",
"iss": "40847c29-06aa-40e2-bf28-c29884c694c4",
"iat": 1622796532,
"sub": "reply:F65FEAB2-4883-4DFF-85FB-169448545D9F",
"txn": "case:F73D30C6-8894-4444-8687-00AE756FEA90",
"events": {
"https://schema.fitko.de/fit-connect/events/accept-reply": {
"authenticationTags": {
"metadata": "XFBoMYUZodetZdvTiFvSkQ",
"data": "UCGiqJxhBI3IFVdPalHHvA",
"attachments": {
"0b799252-deb9-42b0-98d3-c50d24bbafe0": "rT99rwrBTbTI7IJM8fU3El",
"25abf553-0e53-43b9-a14a-1581b32a9ee5": "i7226HEB7IchCxNuh7lCiu",
"046a9fa5-bed6-494b-aab6-d41056c6db79": "d48LxeolRdtFF4nzQibeYO"
}
}
}
}
}
```
Sofern Probleme in der Antwort gefunden wurden,
die jedoch nicht zu einer Zurückweisung geführt haben,
werden diese analog zu der `problems` Liste in [`reject-reply`](#reject-reply) dokumentiert.
```json
{
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.2.0/set-payload.schema.json",
"jti": "6872b19f-5ee2-47d7-a0e9-ebfe87ab2563",
"iss": "40847c29-06aa-40e2-bf28-c29884c694c4",
"iat": 1622796532,
"sub": "reply:F65FEAB2-4883-4DFF-85FB-169448545D9F",
"txn": "case:F73D30C6-8894-4444-8687-00AE756FEA90",
"events": {
"https://schema.fitko.de/fit-connect/events/accept-reply": {
"problems": [
{
"type": "https://schema.fitko.de/fit-connect/events/problems/schema-missing",
"title": "Schemareferenz fehlt im Metadatensatz",
"detail": "Die Referenz auf das Metadatenschema ('$schema') fehlt im Metadatensatz.",
"instance": "metadata"
}
],
"authenticationTags": {
"metadata": "XFBoMYUZodetZdvTiFvSkQ",
"data": "UCGiqJxhBI3IFVdPalHHvA",
"attachments": {
"0b799252-deb9-42b0-98d3-c50d24bbafe0": "rT99rwrBTbTI7IJM8fU3El",
"25abf553-0e53-43b9-a14a-1581b32a9ee5": "i7226HEB7IchCxNuh7lCiu",
"046a9fa5-bed6-494b-aab6-d41056c6db79": "d48LxeolRdtFF4nzQibeYO"
}
}
}
}
}
```
### delete-reply {#delete-reply}
Mit dem Event `https://schema.fitko.de/fit-connect/events/delete-reply` dokumentiert der Zustelldienst, dass die Antwort gelöscht wurde.
Die Fristen, wann Antworten mit welchem Status gelöscht werden,
finden sich unter [Benachrichtigungen und Löschfristen](../notifications-and-deletion-deadlines.mdx).
```json
{
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.2.0/set-payload.schema.json",
"jti": "29d091aa-86ab-4806-beb5-fb462d18e2a1",
"iss": "https://submission-api-dev.fit-connect.fitko.dev",
"iat": 1622796532,
"sub": "reply:02bf1d9f-282d-4abf-810a-c4104baf0afe",
"txn": "case:452b5ee6-35df-441a-bd39-6141723cf914",
"events": {
"https://schema.fitko.de/fit-connect/events/delete-reply": {
}
}
}
```
## Case Events
### close-case {#close-case}
Mit dem Event `https://schema.fitko.de/fit-connect/events/close-case` dokumentiert der Zustelldienst, dass der Vorgang geschlossen wurde.
Es können keine neuen Einreichungen oder Antworten mehr angelegt werden.
Die Angabe `closedBy` gibt an, wer den Vorgang geschlossen hat:
- `delivery-service`: Der Zustelldienst hat den Vorgang aufgrund von Inaktivität geschlossen.
- `sender`: Das sendende System hat den Vorgang geschlossen.
- `subscriber`: Das empfangende System hat den Vorgang geschlossen.
```json
{
"$schema": "https://schema.fitko.de/fit-connect/set-payload/1.1.0/set-payload.schema.json",
"jti": "29d091aa-86ab-4806-beb5-fb462d18e2a1",
"iss": "https://submission-api-dev.fit-connect.fitko.dev",
"iat": 1622796532,
"sub": "case:452b5ee6-35df-441a-bd39-6141723cf914",
"txn": "case:452b5ee6-35df-441a-bd39-6141723cf914",
"events": {
"https://schema.fitko.de/fit-connect/events/close-case": {
"closedBy": "delivery-service"
}
}
}
```