gemSpec_SST_LD_BD_V1.6.0
Elektronische Gesundheitskarte und Telematikinfrastruktur
Spezifikation
Logdaten- und
Betriebsdatenerfassung
Version | 1.6.0 |
Revision | 983083 |
Stand | 23.02.2024 |
Status | freigegeben |
Klassifizierung | öffentlich |
Referenzierung | gemSpec_SST_LD_BD |
Dokumentinformationen
Änderungen zur Vorversion
Anpassungen des vorliegenden Dokumentes im Vergleich zur Vorversion können Sie der nachfolgenden Tabelle entnehmen.
Dokumentenhistorie
Version |
Stand |
Kap./Seite |
Grund der Änderung, besondere Hinweise |
Bearbeitung |
---|---|---|---|---|
1.0.0 |
15.05.19 |
freigegeben | gematik | |
1.0.1 | 28.06.19 | Begriffsklarstellung | gematik | |
1.1.0 | 03.02.20 | Einarbeitung lt. Änderungsliste P21.1 | gematik | |
1.1.1 | 26.06.20 | Einarbeitung lt. Änderungsliste P21.3 | gematik | |
1.2.0 | 30.06.20 | Anpassungen gemäß Änderungsliste P22.1 und Scope-Themen aus Systemdesign R4.0.0 | gematik | |
1.3.0 | 02.12.22 | Kap. 3 | Einarbeitung CI_Maintenance_22.5: Entfernen Schnittstelle I_Log_Data, Konkretisierung Betriebsdatenübermittlung Konnektor | gematik |
1.4.0 | 03.02.23 | Einarbeitung Betr_Maintenance_22.3 | gematik | |
1.5.0 | 23.02.24 | Einarbeitung Betr_Maintenance_23.4 | gematik | |
1.6.0 | 23.02.2024 | Einarbeitung HSK_Maintenance_23.6 | gematik |
Inhaltsverzeichnis
1 Einordnung des Dokuments
1.1 Zielsetzung
Dieses Dokument enthält die Anforderungen an die Schnittstelle Betriebsdatenerfassung. Über sie werden von den Clients (z.B. Fachdienste und zentrale Dienste) versendete Betriebsdaten empfangen.
1.2 Zielgruppe
Das Dokument richtet sich an Hersteller und Anbieter der Schnittstelle Betriebsdatenerfassung.
1.3 Geltungsbereich
Dieses Dokument enthält normative Festlegungen zur Telematikinfrastruktur des Deutschen Gesundheitswesens für den Online-Produktivbetrieb (Stufe 2). Der Gültigkeitszeitraum der vorliegenden Version und deren Anwendung in Zulassungs- oder Abnahmeverfahren wird durch die gematik GmbH in gesonderten Dokumenten (z.B. Produkttypsteckbrief, Leistungsbeschreibung) festgelegt und bekannt gegeben.
Wichtiger Schutzrechts-/Patentrechtshinweis
Die nachfolgende Spezifikation ist von der gematik allein unter technischen Gesichtspunkten erstellt worden. Im Einzelfall kann nicht ausgeschlossen werden, dass die Implementierung der Spezifikation in technische Schutzrechte Dritter eingreift. Es ist allein Sache des Anbieters oder Herstellers, durch geeignete Maßnahmen dafür Sorge zu tragen, dass von ihm aufgrund der Spezifikation angebotene Produkte und/oder Leistungen nicht gegen Schutzrechte Dritter verstoßen und sich ggf. die erforderlichen Erlaubnisse/Lizenzen von den betroffenen Schutzrechtsinhabern einzuholen. Die gematik GmbH übernimmt insofern keinerlei Gewährleistungen.
1.4 Abgrenzungen
Spezifiziert werden in diesem Dokument die Anforderungen und das Verhalten der Schnittstelle Betriebsdatenerfassung [I_OpsData_Update].
1.5 Methodik
Anforderungen als Ausdruck normativer Festlegungen werden durch eine eindeutige ID sowie die dem RFC 2119 [RFC2119] entsprechenden, in Großbuchstaben geschriebenen deutschen Schlüsselworte MUSS, DARF NICHT, SOLL, SOLL NICHT, KANN gekennzeichnet.
Sie werden im Dokument wie folgt dargestellt:
<AFO-ID> - <Titel der Afo>
Text / Beschreibung
[<=]
Dabei umfasst die Anforderung sämtliche zwischen Afo-ID und der Textmarke [<=] angeführten Inhalte.
2 Systemüberblick
Die Fachdienste und zentralen Dienste können ihre Betriebsdaten über die Schnittstelle Betriebsdatenerfassung I_OpsData_Update mit Operation [I_OpsData_Update]::fileUpload liefern.
3 Schnittstelle I_OpsData_Update
Die Fachdienste und zentralen Dienste liefern ihre Betriebsdaten (darunter fallen auch die Rohdaten) über die Schnittstelle Betriebsdatenerfassung I_OpsData_Update.
3.1 Transport Layer Security (TLS)
A_17272-01 - Schnittstelle Betriebsdatenerfassung TLS-Authentisierung für Fach- und zentrale Dienste durch den I_OpsData_Update-Server
Die Schnittstelle I_OpsData_Update MUSS bei der Absicherung der Verbindung durch TLS die serverseitige Authentisierung unter Nutzung des X.509-Komponentenzertifikats mit der TLS-Server-Identität ID.ZD.TLS_S zur Serverauthentisierung umsetzen.
[<=]
A_17416-01 - Schnittstelle Betriebsdatenerfassung Prüfung des TLS-Server-Zertifikats durch Fach- und zentrale Dienste
Der Client der Schnittstelle I_OpsData_Update MUSS bei der Absicherung der Verbindung durch TLS die serverseitige Authentisierung durch Prüfung des I_OpsData_Update-X.509-Komponentenzertifikats mit der TLS-Server-Identität ID.ZD.TLS_S zur Serverauthentisierung entsprechend [gemSpec_Krypt#TLS-Verbindungen] umsetzen.
[<=]
Hinweis:
Es ist empfohlen die vereinfachte Zertifikatsprüfung (GS-A_5581 „TUC vereinfachte Zertifikatsprüfung“ (Komponenten-PKI)) zu verwenden.
A_17730 - Schnittstelle Betriebsdatenerfassung Keine Verbindungen ohne TLS
Die Schnittstelle I_OpsData_Update MUSS ausschließlich Verbindungen mit TLS akzeptieren. [<=]
3.2 Datei Upload
A_17733-02 - Schnittstelle Betriebsdatenerfassung Datei-Upload
Die Schnittstelle I_OpsData_Update MUSS die Operation I_OpsData_Update::fileUpload für die Übertragung von Dateien von Clients zur Schnittstelle Betriebsdatenerfassung entsprechend Tabelle Tab_I_OpsData_Update_002 bereitstellen.
Element |
Beschreibung |
---|---|
Name |
I_OpsData_Update::fileUpload |
Beschreibung |
Mit dieser Operation überträgt der Client pro Lieferung genau eine Datei an die Schnittstelle Betriebsdatenerfassung. |
Initiierender Akteur |
Client von I_OpsData_Update |
Weitere Akteure |
keine |
Auslöser |
Client von I_OpsData_Update |
Vorbedingungen |
aufgebaute TLS-Verbindung vom Client |
Nachbedingungen |
Die Datei wurde zur Schnittstelle Betriebsdatenerfassung übertragen. |
Aufruf |
Aufruf von POST Request entsprechend [RFC7231] mit folgenden Optionen
|
Standardablauf |
Die Datei wird vom Client zur Schnittstelle Betriebsdatenerfassung übertragen. Bei erfolgreicher Ablage und Prüfung der Datei wird im POST Response der HTTP-200-OK-Status zurückgegeben. |
Fehlerfälle |
Bei Auftreten eines Fehlers im Standardablauf werden Fehlercodes entsprechend Tab_I_OpsData_Update_001 Operation I_OpsData_Update_Fehlercodes gemeldet. |
A_17734-01 - Schnittstelle Betriebsdatenerfassung Zugriff auf Dateien
Die Schnittstelle I_OpsData_Update MUSS
- das Hochladen (HTTP POST) von Dateien durch Clients (ohne TLS Client Authentisierung) erlauben
3.3 Content Upload XML
A_23107-01 - Schnittstelle Betriebsdatenerfassung Content-Upload XML Format
Die Schnittstelle I_OpsData_Update MUSS die Operation I_OpsData_Update::contentUploadXML für die Übertragung von Content im XML Format von Clients zur Schnittstelle Betriebsdatenerfassung entsprechend Tabelle Tab_I_OpsData_Update_003 bereitstellen.
Tabelle : Tab_I_OpsData_Update_003 Operation I_OpsData_Update::contentUploadXML
Element |
Beschreibung |
Name |
I_OpsData_Update::contentUploadXML |
Beschreibung |
Mit dieser Operation überträgt der Client pro Lieferung genau einen Content im XML Format an die Schnittstelle Betriebsdatenerfassung. |
Initiierender Akteur |
Client von I_OpsData_Update |
Weitere Akteure |
keine |
Auslöser |
Client von I_OpsData_Update |
Vorbedingungen |
aufgebaute TLS-Verbindung vom Client |
Nachbedingungen |
Der Content im XML Format wurde zur Schnittstelle Betriebsdatenerfassung übertragen. |
Aufruf | Aufruf von POST Request entsprechend [RFC7231] mit folgenden Optionen
|
Standardablauf |
Der Content wird vom Client zur Schnittstelle Betriebsdatenerfassung übertragen. Bei erfolgreicher Übermittlung des Contents wird in der Response der HTTP-200-OK-Status zurückgegeben. |
Fehlerfälle |
Bei Auftreten eines Fehlers im Standardablauf werden Fehlercodes entsprechend Tab_I_OpsData_Update_001 Operation I_OpsData_Update_Fehlercodes gemeldet. Bei allen Fehler-HTTP-Status-Codes wird kein Content abgelegt und der POST Request MUSS mit gleicher CI-ID wiederholbar sein. |
(Hinweis: Für weitere Informationen zum CI, siehe [gemRL_Betr_TI] Kapitel "Configuration Management".) [<=]
3.4 Content Upload JSON Format
A_23110-01 - Schnittstelle Betriebsdatenerfassung Content-Upload JSON Format
Die Schnittstelle I_OpsData_Update MUSS die Operation I_OpsData_Update::contentUploadJSON für die Übertragung von Content im JSON Format von Clients zur Schnittstelle Betriebsdatenerfassung entsprechend Tabelle Tab_I_OpsData_Update_004 bereitstellen.
Tabelle : Tab_I_OpsData_Update_004 Operation I_OpsData_Update::contentUploadJSON
Element |
Beschreibung |
Name |
I_OpsData_Update::contentUploadJSON |
Beschreibung |
Mit dieser Operation überträgt der Client pro Lieferung genau einen Content im JSON Format an die Schnittstelle Betriebsdatenerfassung. |
Initiierender Akteur |
Client von I_OpsData_Update |
Weitere Akteure |
keine |
Auslöser |
Client von I_OpsData_Update |
Vorbedingungen |
aufgebaute TLS-Verbindung vom Client |
Nachbedingungen |
Der Content im JSON Format wurde zur Schnittstelle Betriebsdatenerfassung übertragen. |
Aufruf |
Aufruf von POST Request entsprechend [RFC7231] mit folgenden Optionen
|
Standardablauf |
Der Content wird vom Client zur Schnittstelle Betriebsdatenerfassung übertragen. Bei erfolgreicher Übermittlung des Contents wird in der Response der HTTP-200-OK-Status zurückgegeben. |
Fehlerfälle |
Bei Auftreten eines Fehlers im Standardablauf werden Fehlercodes entsprechend Tab_I_OpsData_Update_001 Operation I_OpsData_Update_Fehlercodes gemeldet. Bei allen Fehler-HTTP-Status-Codes wird kein Content abgelegt und der POST Request MUSS mit gleicher CI-ID wiederholbar sein. |
(Hinweis: Für weitere Informationen zum CI, siehe [gemRL_Betr_TI] Kapitel "Configuration Management".) [<=]
Liste mit möglichen Fehlercodes bei den Operationen an der Schnittstelle I_OpsData_Update.
Fehlercode |
ErrorType |
Severity |
Fehlertext |
---|---|---|---|
400 |
Technical |
Error |
Bad Request |
404 | Technical | Error | Not Found |
405 | Technical | Error | method not allowed |
413 |
Technical |
Error |
Payload Too Large |
429 |
Technical |
Error |
Too Many Requests (RFC 6585) |
500 | Technical | Error | Internal Server Error |
502 | Technical | Error | Bad Gateway |
504 | Technical | Error | Gateway Timeout |
4 Anhang – Verzeichnisse
4.1 Abkürzungen
Kürzel |
Erläuterung |
---|---|
DNS |
Domain Name Service |
TLS |
Transport Layer Security |
4.2 Glossar
Begriff |
Erläuterung |
---|---|
Funktionsmerkmal |
Der Begriff beschreibt eine Funktion oder auch einzelne, eine logische Einheit bildende Teilfunktionen der TI im Rahmen der funktionalen Zerlegung des Systems. |
Das Glossar wird als eigenständiges Dokument (vgl. [gemGlossar]) zur Verfügung gestellt.
4.3 Abbildungsverzeichnis
4.4 Tabellenverzeichnis
- Tabelle 1: Tab_I_OpsData_Update_002 Operation I_OpsData_Update::fileUpload
- Tabelle 2: Tab_I_OpsData_Update_003 Operation I_OpsData_Update::contentUploadXML
- Tabelle #: Tab_I_OpsData_Update_004 Operation I_OpsData_Update::contentUploadJSON
- Tabelle 4: Tab_I_OpsData_Update_001 Operation I_OpsData_Update_Fehlercodes
4.5 Referenzierte Dokumente
4.5.1 Dokumente der gematik
Die nachfolgende Tabelle enthält die Bezeichnung der in dem vorliegenden Dokument referenzierten Dokumente der gematik zur Telematikinfrastruktur.
[Quelle] |
Herausgeber: Titel |
---|---|
[gemGlossar] |
gematik: Glossar der Telematikinfrastruktur |
4.5.2 Weitere Dokumente
[Quelle] |
Herausgeber (Erscheinungsdatum): Titel |
---|---|
[RFC7230] |
Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing |
[RFC7231] |
Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content |
[RFC7617] |
The 'Basic' HTTP Authentication Scheme |