Skip to content

API specification for gematik Directory, a service which provides Information about organizations and practitioners in the german healthcare.

License

Notifications You must be signed in to change notification settings

gematik/api-vzd

Repository files navigation

Verzeichnisdienst der Telematikinfrastruktur

gem Spec VZD v1.18 gemILF Pflege VZD v1.5 simplifier.net 1.0
Admin API 1.12 Application Maintenance API 1.4

Aktuelles

GitHub Branches

Der Verzeichnisdienst wird auf verschiedenen GitHub Branches dokumentiert:

  • main Branch: Enthält die Dokumentation passend für die aktuelle Verzeichnisdienst Produktivumgebung (PU)

  • develop Branch: Enthält die Dokumentation passend für den aktuelle in Entwicklung befindlichen Verzeichnisdienst.

  • feature/* Branches: Diese Branches werden zur Vorbereitung und Diskussion von neuen Themen genutzt, die noch nicht in Entwickung sind. Diese Dokumente können unvollständig sein und sich bis zur Fertigstellung ändern.

Kontextabgrenzung

VZD Systemkontext
Figure 1. Verzeichnisdienst Systemkontext


Verzeichnisdienst der TI verwaltet Einträge von Leistungserbringern und Organisationen/Institutionen mit allen definierten Attributen, die in das Verzeichnis aufgenommen werden sollen. Anhand einer Suchanfrage können diese Daten abgefragt werden (z. B. Adressdaten, X.509-Zertifikate). Ferner können Einträge des Verzeichnisses durch Kartenherausgeber (Basisdaten) oder berechtigte fachanwendungsspezifische Dienste (Fachanwendungsdaten) geändert, hinzugefügt und gelöscht (Kartenherausgeber vollständige Einträge, fachanwendungsspezifische Dienste nur die jeweiligen Fachdaten) werden.

Verzeichnisdienst bietet folgende Außenschnittstellen an (s. Nummerierung in der Abbildung):

  1. Über den TI-Konnektor wird dem KIM-Client sowie Primärsystemen eine LDAP Schnittstelle zur Abfrage der Daten bereitgestellt. Schnittstelle I_Directory_Query, dezentral.

  2. Die Konnektoren leiten die Anfragen zustandslos über das zentrale Netz der TI an den Verzeichnisdienst weiter. Über die LDAP Schnittstelle des zentrale betriebenen VZD werden speziell für solche Abfragen aufbereitete und optimierte Daten durchsucht (so genannte flache Liste). Schnittstelle I_Directory_Query, zentral.

  3. Die Kartenherausgeber (bspw. Landesärztekammer oder Kassenzahnärztliche Vereinigungen) in Kooperation mit Trust Service Provider sind verantwortlich für die Befüllung des VZD mit Basisdaten und Zertifikaten. Hierfür stell VZD eine REST API für die Administration der Daten im Verzeichnisdienst. Schnittstelle I_Directory_Administration.

  4. Die KIM Anbieter ergänzen die Basisdaten um eigene Inhalte, insb. um die KIM-EMail-Adressen. Schnittstelle I_Application_Maintenance.

  5. Für die Suche der Apotheken, z.B. in der gematik eRezept APP, wird der FHIR VZD genutzt. Die AVS der Apotheken bzw. der Apotheker über das FHIR VZD Self-Service Portal ergänzen die FHIR VZD Daten um weitere Inhalte (z.B. Öffnungszeiten der Apotheken). Schnittstellen FHIRDirectoryFdvSearchAPI (/fdv/search) für die Suche und FHIRDirectoryOwnerAPI (/owner) für die Ergänzung der Daten.

  6. Für die Suche der Leistungserbringer-Institutionen im Rahmen der Berechtigungsvergabe in der elektronischen Patientenakte (ePA),vermittelt das ePA-Aktensystem die Kommunikation zwischen VZD und ePA-Frontend. Schnittstelle FHIRDirectoryFdvSearchAPI (/fdv/search).

  7. TIM Anbieter registrieren sich und verifizieren sich gegenseitig mit Hilfe von VZD Schnittstelle. I_Directory_TIM_Provider_Services

  8. VZD bietet direkten Zugriff zu den Daten über FHIR REST Schnittstellen für die Clients (z.B. TIM, FDV, eRezept App,…​). Schnittstellen FHIRDirectoryFdvSearchAPI (/fdv/search) & FHIRDirectoryFdvSearchAPI (/fdv/search).

  9. In Entwicklung: Die Leistungserbringer können ihre Daten selbstständig administrieren, um z.B. die Organisationsstrukturen und Standorte zur erfassen. Schnittstelle FHIRDirectoryOwnerAPI (/owner). Für TIM Clients und für die Ergänzung von Mehrwertdaten der Apotheken wurde diese Schnittstelle schon freigegeben.

Systemarchitektur

Die folgende Abbildung gibt einen Überblick über die Systemarchitektur des Verzeichnisdienstes.

VZD overview

LDAP-Directory Datenmodell

FHIR-Directory Datenmodell

Datenmodell

License

Copyright 2025 gematik GmbH

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

See the [LICENSE](./LICENSE) for the specific language governing permissions and limitations under the License.

Additional Notes and Disclaimer from gematik GmbH

  1. Copyright notice: Each published work result is accompanied by an explicit statement of the license conditions for use. These are regularly typical conditions in connection with open source or free software. Programs described/provided/linked here are free software, unless otherwise stated.

  2. Permission notice: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions::

  3. The copyright notice (Item 1) and the permission notice (Item 2) shall be included in all copies or substantial portions of the Software.

  4. The software is provided "as is" without warranty of any kind, either express or implied, including, but not limited to, the warranties of fitness for a particular purpose, merchantability, and/or non-infringement. The authors or copyright holders shall not be liable in any manner whatsoever for any damages or other claims arising from, out of or in connection with the software or the use or other dealings with the software, whether in an action of contract, tort, or otherwise.

  5. The software is the result of research and development activities, therefore not necessarily quality assured and without the character of a liable product. For this reason, gematik does not provide any support or other user assistance (unless otherwise stated in individual cases and without justification of a legal obligation). Furthermore, there is no claim to further development and adaptation of the results to a more current state of the art.

  6. Gematik may remove published results temporarily or permanently from the place of publication at any time without prior notice or justification.

  7. Please note: Parts of this code may have been generated using AI-supported technology.’ Please take this into account, especially when troubleshooting, for security analyses and possible adjustments.

About

API specification for gematik Directory, a service which provides Information about organizations and practitioners in the german healthcare.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 10