1. Einleitung

1.1. Typographische Konventionen

Konvention Bedeutung

Fett

Systembezeichnungen, Dateinamen, Befehle, Schaltflächen

Italic

Eigennamen, (englische) Fachbegriffe

monospaced

Code

Highlighted

Änderungen zur vorhergehenden Dokumentenversion

"Anführungszeichen"

Statusnamen

<Bezeichner>

Platzhalter

1.2. Symbole

In den Handbüchern werden folgende Symbole verwendet:

Ergänzender Hinweis
Ergänzender Tip
Wichtiger Hinweis

Forderung nach Aufmerksamkeit
Warnung vor eine Gefahr

2. Übersicht

2.1. Einordung in die TIM-Architektur

Der Registrierungsdienst ist eine mandantenübergreifende Komponente, die Kommunikation mit den TI-Messenger-Proxy-Diensten und dem VZD-FHIR-Directory pflegt. Zusätzlich wird das Frontend des Registrierungsdienstes angeboten, über das der Betrieb deaktivierte Messenger-Services wieder aktivieren kann. Mit diesem Org-Admin-Account kann dann auf die Schnittstelle I_Admin zugegriffen werden, die die Konfiguration der Messenger-Services einer Organisation erlaubt. Die jeweiligen Schnittstellen sind im Kapitel Schnittstellen des Registrierungsdienstes beschrieben.

3. Schnittstellen des Registrierungsdienstes

Der Registrierungsdienst bietet zwei Schnittstellen an, die von TI-Messenger-Proxy-Diensten genutzt werden:

3.1. Abfrage der Föderationsliste

Der Registrierungsdienst wird von TI-Messenger-Proxy-Diensten aufgerufen, um die aktuelle Föderationsliste abzufragen, die für die Berechtigungsprüfung benötigt wird. Dazu bietet der Registrierungsdienst folgenden Endpunkt an:

Tabelle 1. REST-Endpunkte
Pfad Methode Bedeutung

/federationList

GET

Versionierte Föderationsliste des VZD-FHIR-Directory

Der Endpunkt liefert im Erfolgsfall ein Objekt folgenden Typs zurück:

Listing 1. JSON-Struktur der Föderationsliste
{
  "vorgangsId": "d9accf1a-6881-4bae-8294-53a4169a9b4a",
  "returnCode": "OK",
  "result": {
    "federationList": {
      "version": 1,
      "domainList": [
        {
          "domain": "example-patient.com",
          "telematikID": "patient-ID",
          "isInsurance": true,
          "timProvider": "Betreiber-patient"
        },
        {
          "domain": "example-le.com",
          "telematikID": "le-ID",
          "isInsurance": false,
          "timProvider": "Betreiber-le"
        }
      ]
    },
    "abfragezeitpunkt": "2025-03-19T14:39:17.086070253Z"
  }
}

Neben dem Erfolgsfall werden auch in Fehlerfällen spezifizierte Antworten geliefert. Im Folgenden werden die möglichen Return-Codes beschrieben:

Tabelle 2. Return-Codes für das Abholen der Föderationsliste
Return-Code Beschreibung

200

Gibt die aktuelle Föderationsliste zurück

500

Interner Server Fehler

503

Föderationsliste ist derzeit nicht verfügbar

3.2. Org-Admin-API ("I_Admin")

Die Org-Admin-API erlaubt die Verwaltung von eigenen Messenger-Services sowie von Matrix-Nutzern dieser Messenger-Services. Für den Zugriff ist eine Authentifizierung als Org-Admin am Registrierungsdienst-IDP notwendig.

Tabelle 3. Endpunkte der Org-Admin-API

Pfad

Verb

Beschreibung

/domains

GET

Alle eigenen Messenger-Services anfragen

/domains/{domain}

GET

Einzelnen Messenger-Service anfragen

/domains/{domain}

PATCH

Einzelnen Messenger-Service modifizieren

3.3. Client-API

Die Client-API stellt einen Endpunkt zur Abfrage der Löschfrist bereit. Dafür wird ein gültiger Access-Token des Matrix-Homeservers benötigt.

Tabelle 4. Endpunkte der Client-API

Pfad

Verb

Beschreibung

/{domain}/loeschfrist

GET

Liefert die Löschfrist zurück

Abkürzungen

TIM

TI-Messenger

IK

Institutionskennzeichen

Kinhid

Karteninhaber-ID

OIDC

OpenID Connect

Basisdokumentation

  • [I_VZD_TIM_Provider_Services] Schnittstelle des FHIR-Proxy zum Registrierungsdienst, Github

  • [I_TiMessengerContactManagement] Schnittstelle des Registrierungsdienst zur Kontaktverwaltung, Github