Skip to content

Latest commit

 

History

History
100 lines (67 loc) · 5.59 KB

FHIR-Directory.adoc

File metadata and controls

100 lines (67 loc) · 5.59 KB

gematik logo

VZD-FHIR-Directory

Beim VZD-FHIR-Directory handelt es sich um einen zentralen Verzeichnisdient der TI. Im Rahmen des TI-Messenger-Dienstes wird das VZD-FHIR-Directory für die deutschlandweite Suche von Organisationen und Akteuren verwendet. Zusätzlich stellt das VZD-FHIR-Directory Funktionalitäten bereit, um die in den Messenger-Proxy implementierten Berechtigungsstufen zu unterstützen.

Dabei besteht das VZD-FHIR-Directory aus den Teilkomponenten:

  • FHIR-Directory,

  • OAuth-Service,

  • Auth-Service und

  • FHIR-Proxy

die benötigt werden, um alle Funktionsmerkmale abbilden zu können.

In der folgenden Abbildung sind die Teilkomponenten sowie deren Schnittstellen und die für deren Zugriff benötigten Zugriffstoken dargestellt:

1. FHIR-Directory / Verzeichnistypen

Das FHIR-Directory basiert auf FHIR R4 und stellt die zwei Verzeichnisse HealthcareServiceDirectory- und PractitionerRoleDirectory bereit. Die Profilierung der FHIR-Ressourcen ist im Simplifier aufrufbar.

Im folgenden sind die beiden Verzeichnisse mit deren Struktur beispielhaft dargestellt:

  • HealthcareService

  • PractitionerRole

Im Rahmen des TI-Messenger-Dienstes sollen die folgenden Attribute eines Endpoints eines HealthcareService oder einer PractitionerRole wie folgt gesetzt werden:

Attribut Wert Beschreibung

endpoint.status

active

Sichtbarkeit des Endpunktes im Verzeichnisdienst

endpoint.connectionType

tim

Gibt an, um welche Anwendung es sich handelt

endpoint.name

<Bezeichnung>

Identifier des Endpoints

endpoint.PayloadType

tim-chat

Kennung der Übertragenen Inhalte

endpoint.address

<MXID>

Matrix-UserID eines Akteurs

Beispiel: * HealthcareService.endpoint.address = <MXID>

Weitere Informationen zu den Verzeichnistypen können hier nachgelesen werden.

2. OAuth-Service

Der OAuth-Service stellt ein ti-provider-accesstoken aus, welches am /ti-provider-authenticate-Endpunkt übergeben werden muss. Hierfür muss sich ein Anbieter eines TI-Messenger-Fachdienstes mittels seiner Zugangsdaten am OAuth-Service authentisieren. Der Aufruf des Endpunktes kann hier nachgelesen werden.

3. Auth-Service

Der Auth-Service stellt Zugriffstoken aus, die für den Zugriff auf die Endpunkte am FHIR-Proxy benötigt werden. Der Aufruf der Endpunkte am Auth-Service ist dort beschrieben.

4. FHIR-Proxy

Der FHIR-Proxy gibt Zugriff auf das FHIR-Directory unter Vorlage eines validen ACCESS_TOKEN und somit auf die FHIR-Ressourcen. Die vom FHIR-Proxy zur Verfügung gestellten Endpunkte werden für die Suche und Pflege von FHIR-Ressourcen verwendet sowie zur Pflege eigener TIM Provider Einträge. Der Aufruf der Endpunkte am FHIR-Proxy sind der folgenden Aufzählung zu entnehmen:

💡
Die Anbieter eines TI-Messenger-Fachdienstes nutzen die Schnittstelle /tim-provider-services, um die Föderationsliste des TI-Messenger-Dienstes abzufragen und um die Domains der von ihnen betriebenen Messenger-Services als Teil der TI-Messenger Föderation zu verwalten.
Die Volltextsuche über die Schnittstellen /search und /owner wird aktuell nicht vom VZD-FHIR-Directory unterstützt. Hierfür können die folgenden RegEx _text and _content verwendet werden. Für mehr Informationen kann die folgende Dokumentation verwendet werden.