gemSpec_SST_LD_BD_V1.3.0

PDF HTML Excel XML
 gemSpec_SST_LD_BD_V1.3.0






Elektronische Gesundheitskarte und Telematikinfrastruktur



Spezifikation

Logdaten- und

Betriebsdatenerfassung 




    

     

      Version
      1.3.0
     

     

      Revision
      548770
     

     

      Stand
      02.12.2022
     

     

      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

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. 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.
[<=]

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-01 - 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

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
  • 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 Abfrage des DNS TXT-Resource-Records ermittelt.
  •  Im Top-level-HTTP-Header MUSS ein zusätzliches Feld "filename" angelegt werden. Der Wert für dieses Feld MUSS den Namen der übertragenen Datei enthalten.
  • Mindestens folgende Top-level-HTTP-Header MÜSSEN mit den angegebenen Werten unterstützt werden:
    • Content-Type: application/octet-stream
    • Content-Lenght: entsprechend [RFC7230] zu setzen
    • Accept-Encoding: gzip, deflate
  • Die zu liefernde Datei MUSS im POST Request Body geliefert werden. D.h. der Request Body MUSS auf die Datei an sich in Binärform (binary data) beschränkt sein.
Standardablauf
 Die Datei wird vom Client zur Schnittstelle Betriebsdatenerfassung übertragen.
Die Datei wird auf Fehler überprüft. 
Bei erfolgreicher Ablage und Prüfung der Datei wird im POST Response der HTTP-200-OK-Status zurückgegeben. Der Client muss für die Prüfung der übermittelten Datei genügend Zeit berücksichtigen (Timer für das Warten auf das HTTP Response entsprechend konfigurieren).
Wenn die Prüfung der Datei länger als 10 Sekunden dauert, MUSS die Schnittstelle I_OpsData_Update nach jeweils 10 Sekunden einen POST Response mit dem HTTP-102 Processing Status zurückgeben um bei dem Client ein Timeout zu verhindern.  
Fehlerfälle
 Neben den registrierten HTTP-Status-Codes des aufgerufenen HTTP POST können keine weiteren Fehlercodes auftreten.
Bei allen Fehler-HTTP-Status-Codes wird keine Datei abgelegt und der POST Request MUSS mit gleichem "filename" wiederholbar sein.
Im Fall von HTTP-Status-Code "400 Bad Request" enthält der HTTP POST bzw. die Datei einen Fehler. Dieser Fehler kann sich in der enthaltenen Datei befinden.
[<=]

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.4 Content Upload XML

A_23107 - 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
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.
 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 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.5 Content Upload JSON Format

A_23110 - 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.
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 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".) [<=]

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

    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.

    [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