gemSpec_SST_LD_BD_V1.6.0_Aend

 

 

 

 

 

Elektronische Gesundheitskarte und Telematikinfrastruktur

 

 

Spezifikation

Logdaten- und

Betriebsdatenerfassung

 

 

 

   

Version	1.46.0
Revision	947301959134
Stand	0323.02.20232024
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

Inhaltsverzeichnis

Dokumentinformationen

Inhaltsverzeichnis

1 Einordnung des Dokuments

1.1 Zielsetzung

1.2 Zielgruppe

1.3 Geltungsbereich

1.4 Abgrenzungen

1.5 Methodik

2 Systemüberblick

3 Schnittstelle I_OpsData_Update

3.1 Transport Layer Security (TLS)

3.2 DNS Resource RecordDatei Upload

3.3 DateiContent Upload XML

3.4 Content Upload XMLJSON Format

3.5 Content Upload JSON Format4 Anhang – Verzeichnisse

4 Anhang – Verzeichnisse.1 Abkürzungen

4.1 Abkürzungen2 Glossar

4.2 Glossar3 Abbildungsverzeichnis

4.3 Abbildungsverzeichnis4 Tabellenverzeichnis

4.4 Tabellenverzeichnis5 Referenzierte Dokumente

4.5 Referenzierte.1 Dokumente der gematik

4.5.1 Dokumente der gematik2 Weitere Dokumente

4.5.2 Weitere Dokumente

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. Dokumentenlandkarte, 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 DNS Resource Record

Die Schnittstelle I_OpsData_Update stellt Funktionen bereit, die über URLs aufgerufen werden können.

A_17731 - Schnittstelle Betriebsdatenerfassung Bereitstellung DNS-Resource-Records

Der Anbieter der Schnittstelle Betriebsdatenerfassung I_OpsData_Update MUSS SRV- und TXT-Resource-Records im DNS bereitstellen. Die Werte der PFADx-Angaben MÜSSEN mit einem "/" beginnen.
Im DNS sind dazu folgende Einträge einzutragen:

Owner                                  TTL Class Type Data
_fdrdif._tcp.<TOP_LEVEL_DOMAIN_TI> <TTL1> <IN> <SRV> <Priorität1>  <Gewicht1>  <Port1>  <FQDN1>
_fdrdif._tcp.<TOP_LEVEL_DOMAIN_TI> <TTL2> <IN> <TXT> "txtvers=<VERSION1>" "path=<PFAD1>"
_fdrdif._tcp.<TOP_LEVEL_DOMAIN_TI> <TTL3> <IN> <SRV> <Priorität2>  <Gewicht2>  <Port2>  <FQDN2>
_fdrdif._tcp.<TOP_LEVEL_DOMAIN_TI> <TTL4> <IN> <TXT> "txtvers=<VERSION2>" "path=<PFAD2>"

_zdrdif._tcp.<TOP_LEVEL_DOMAIN_TI> <TTL1> <IN> <SRV> <Priorität1>  <Gewicht1>  <Port1>  <FQDN1>
_zdrdif._tcp.<TOP_LEVEL_DOMAIN_TI> <TTL2> <IN> <TXT> "txtvers=<VERSION1>" "path=<PFAD1>"
_zdrdif._tcp.<TOP_LEVEL_DOMAIN_TI> <TTL3> <IN> <SRV> <Priorität2>  <Gewicht2>  <Port2>  <FQDN2>
_zdrdif._tcp.<TOP_LEVEL_DOMAIN_TI> <TTL4> <IN> <TXT> "txtvers=<VERSION2>" "path=<PFAD2>"

TOP_LEVEL_DOMAIN_TI: in der PU = telematik.; in der RU/TU = telematik-test. [<=]

Die "fdrdif"-DNS-Resource-Records werden von den Fachdiensten und die "zdrdif"-DNS-Resource-Records von den zentralen Diensten zur Lokalisierung der Schnittstelle genutzt.

3.3 Datei Upload

A_17733-0102 - 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.
 

Tabelle 1: Tab_I_OpsData_Update_002 Operation I_OpsData_Update::fileUpload

[<=]

Hinweise:

   Der Client muss eindeutige Dateinamen für seine Dateien (bspw. durch Anhängen eines Zeitstempels, einer eindeutigen ID, o.ä.) sicherstellen.

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.43 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 2: 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 Für die URL " https://<host>:<port><path>/" MUSS im POST Request folgendes beachtet werden: "<host>:<port>" wird durch Abfrage des DNS SRV-Resource-Records ermittelt. "<path>" wird durch die gematik zur Verfügung gestellt.  https://<host>:<port><path>/" im POST Request wird von der gematik vorgegeben.  Im Top-level-HTTP-Header MUSS ein zusätzliches Feld "CI" angelegt werden. Der Wert für dieses Feld MUSS die CI-ID der logischen Produktinstanz des liefernden Client enthalten (in der Form "CI-nnnnnnn") . Mindestens folgende Top-level-HTTP-Header MÜSSEN mit den angegebenen Werten unterstützt werden:  Content-Type: text/xml; charset="utf-8"  Content-Length: entsprechend [RFC7230] zu setzen  Accept-Encoding: gzip, deflate  Der zu liefernde Content MUSS im POST Request Body geliefert werden.
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. Im Fall von HTTP-Status-Code "400 Bad Request" enthält der HTTP Request einen Fehler.

(Hinweis: Für weitere Informationen zum CI, siehe [gemRL_Betr_TI] Kapitel "Configuration Management".) [<=]

3.54 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 Für die URL " https://<host>:<port><path>/" MUSS im POST Request folgendes beachtet werden: "<host>:<port>" wird durch Abfrage des DNS SRV-Resource-Records ermittelt. "<path>" wird durch die gematik zur Verfügung gestellt. https://<host>:<port><path>/" im POST Request wird von der gematik vorgegeben. Mindestens folgende Top-level-HTTP-Header MÜSSEN mit den angegebenen Werten unterstützt werden:  Content-Type: text/xml; charset="utf-8" application/json Content-Length: entsprechend [RFC7230] zu setzen  Accept-Encoding: gzip, deflate  Der zu liefernde Content MUSS im POST Request Body geliefert werden.
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. Im Fall von HTTP-Status-Code "400 Bad Request" enthält der HTTP Request einen Fehler.

(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.

Tabelle 4: Tab_I_OpsData_Update_001 Operation I_OpsData_Update_Fehlercodes

4 Anhang – Verzeichnisse

4.1 Abkürzungen

4.2 Glossar

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. Der mit der vorliegenden Version korrelierende Entwicklungsstand dieser Konzepte und Spezifikationen wird pro Release in einer Dokumentenlandkarte definiert. Version und Stand der referenzierten Dokumente sind daher in der nachfolgenden Tabelle nicht aufgeführt. Deren zu diesem Dokument jeweils gültige Versionsnummer ist in der aktuellen, von der gematik veröffentlichten Dokumentenlandkarte enthalten, in der die vorliegende Version aufgeführt wird.

4.5.2 Weitere Dokumente