Skip to content

gematik provides a comprehensive overview of the e-prescription interfaces. This API documentation serves as a supplement to gematik's standard regulatory documents and details the e-prescription profiles based on the FHIR standard.

License

gematik/api-erp

Repository files navigation

E-Rezept API-Dokumentation gematik logo

Hier dokumentiert die gematik die Nutzung der Schnittstellen rund um das E-Rezept.

Inhaltsverzeichnis

Die gematik geht neue Wege und möchte auf diesem Weg die Nutzung der Schnittstellen rund um das E-Rezept vorstellen. Die Beschreibung dieser API ergänzt die normativen Dokumente der gematik sowie die Festlegungen über die E-Rezept-Profile (inkl. Beispielen) des genutzten FHIR-Standards.

Auf den folgenden Seiten stellt die gematik die Nutzung der Schnittstellen durch die Primärsysteme der verordnenden Ärzte/Zahnärzte und der Apotheker sowie durch die E-Rezept-App vor. Die E-Rezept-App wird durch die gematik bereitgestellt und ist zum Start des E-Rezepts in den App Stores der beiden Plattformen iOS und Android verfügbar.

Die KBV definiert die FHIR-Profile des Verordnungsdatensatzes im simplifier-Projekt E-Rezept-Verordnung. Die Festlegungen zu Abgabe- und Abrechnungsdaten der Apotheken werden im DAV-Projekt Abgabedaten und im GKV-Projekt Abrechnungsdaten getroffen.

Für die QES-Erstellung durch den Konnektor liegen im Unterordner samples/qes SOAP-Request/Responses zu den Verordnungsbeispielen der KBV bereit. Spezialfälle (z.B. abgelaufene Zertifikate wegen Kartenwechsel o.ä.) stellen wir im Unterordner samples/qes-cases bereit. Da die signierten Dokumente nicht verändert werden dürfen sind die Beispiele noch in Profilversionen, die nicht mehr im Produktivbetrieb des Fachdienstes unterstützt werden.

Durchgängige Beispieldatensätze von der Verordnung und qualifizierter Signatur über Quittung bis zu den Abrechnungsdaten stellt der Deutsche Apothekerverband in seinem github-Projekt eRezept-Beispiele zur Verfügung.

In den nachfolgend verlinkten Abschnitten zeigen wir, wie sich verordnende Ärzte/Zahnärzte und Versicherte mit der der TI verbinden. Wir zeigen detailliert den Ablauf der Erstellung eines E-Rezepts in der verordnenden Praxis und wie Apotheker auf den Fachdienst zugreifen, um ein E-Rezept zu beliefern. Für Versicherte stellen wir dar, wie die Einsicht in die vorhandenen E-Rezepte und Abgabeinformationen eingelöster Rezepte erfolgt, wie die Kommunikation mit der Apotheke ablaufen kann und wie der Versicherte Einsicht in das Zugriffsprotokoll auf alle seine E-Rezepte nehmen kann. Schließlich zeigen wir, wie der Ablauf der Rezept-Einlösung für Versicherte mit dem E-Rezept funktioniert.

Versionsübergang 30.06.2023 -> 01.07.2023

Wichtige Informationen zum Verhalten des Fachdienstes während der Übergangszeit und danach finden sich auf dieser Seite

FHIR-Releases

Auf dieser Seite veröffentlichen die E-Rezept-Beteiligten {KBV, DAV, GKV, PKV und gematik} gemeinsam ihre FHIR-Release-Festlegungen.

Die Veröffentlichung an dieser Stelle erfolgt übergangsweise, bis ein gemeinsames Repository 'oberhalb' der API-Beschreibung gefunden ist.

Das Titus-Testportal wird in den Anwendungsfällen zum E-Rezept um einen Validator erweitert. Zukünftig werden alle Requests vor der Weiterverarbeitung online validiert. Details dazu finden sich auf der folgenden Seite.

Wie Vergleiche zwischen FHIR Profilen (z.B. nach Versionsübergängen) vorgenommen werden können und den Verweis auf die Artefakte zum aktuellen Versionsübergang finden sich auf dieser Seite.

Implementierungsunterstützung

FHIR-Beispiele

Für die Implementierung des E-Rezeptes stehen Beispiele im FHIR-Format zur Verfügung.

Im gemeinsamen Beispiel-Repository der Gesellschafter sind sowohl Einzelbeispiele von Profilen, wie auch Beispiele von Ende zu Ende Szenarien dokumentiert.

Wir wünschen uns an dieser Stelle auch ein reges Mitwirken der Industrie bei der Erstellung dieser Beispiele. Über Pull-Requests und andere Formen der Kollaboration freuen wir uns.

Konvertierung von FHIR XML und JSON

Der FHIR Standard unterstützt für den Datenaustausch mehrere Formate. Die beiden vom E-Rezept Fachdienst unterstützten Formate sind XML (Content-Type: application/fhir+xml) und JSON (Content-Type: application/fhir+json). Der Fachdienst unterstützt an jedem Endpunkt beide Formate. Mit den Gesellschaftern wurde abgestimmt, dass bei der Kommunikation und Beschreibung der Endpunkte, die Primärsysteme betreffen, das Format XML genutzt wird. Das heißt, dass die Beispiele in der API und im eRezept-Examples Repository, die die Primärsysteme betreffen in XML dargestellt werden. Der Datenaustausch zwischen dem Fachdienst und dem Frontend des Versicherten (FdV) dagegen geschieht im JSON-Format.

Folgende Tools können genutzt werden, um FHIR-Dokumente zwischen XML und JSON zu konvertieren:

Umfang der Anwendung E-Rezept

Hier geht es zur Übersicht der Produkte, die über das E-Rezept verordnet werden können

Anwendungsfälle im E-Rezept

Zugang zu Diensten der Telematikinfrastruktur

Hier geht es zur Beschreibung des Verbindungsaufbaus zur Telematikinfrastruktur

Hier geht es zur notwendigen Netzwerkkonfiguration für Primärsysteme

Hier geht es zur Übersicht der Endpunkte für die Zertifikatsvalidierung für E-Rezept-FdVs

Hier gibt es eine Übersicht der in der API verwendeten http-Status- und Fehlercodes

Hinweise und Festlegungen zu Health-Checks und Verfügbarkeits-Probes

Anwendungsfälle für alle Clients

Hier geht es zu den Endpunten, die alle Clients bedienen können

Anwendungsfälle E-Rezept in der Praxis

Hier geht es zu den Anwendungsfällen in der (Zahn-)Arztpraxis zur Verordnung von E-Rezepten

Hier geht es zu den Anwendungsfällen für die direkte Zuweisung eines E-Rezeptes an eine Apotheke

Hier geht es zu der vorabveröffentlichten und unvollständigen Liste der PKV-Institutionskennzeichen

Besonderheiten der Mehrfachverordnung (MVO)

Hier geht es zu den Besonderheiten der Mehrfachverordnung (MVO)

Anwendungsfälle E-Rezept in der Apotheke

Hier geht es zu den Anwendungsfällen in der Apotheke, wie ein E-Rezept bedient wird

+++NEU+++ Hier ist der Anwendungsfall zum Abruf der E-Rezepte mittels Gesundheitskarte (eGK) beschrieben

Hier ist der Anwendungsfall zur Alternativen Zuweisung an die Apotheke beschrieben

Hier folgt die Beschreibung der Benachrichtigungsschnittstelle für Apothekensysteme

Anwendungsfälle für Versicherte

Hier geht es zu den Anwendungsfällen für Versicherte, um ihre E-Rezepte zu verwalten und einzulösen

PKV Versicherte

Hier geht es zu den Anwendungsfällen für die elektronische Verwaltung der Abrechnungsinformationen

Hier geht es zu den Anwendungsfällen für das Verwalten der Einwilligung

Hier geht es zu den Anwedungsfällen für die Suche nach Apotheken im FHIR VZD

Anwendungsfälle für den Nachrichtenaustausch zwischen Versicherten und Apotheken

Hier geht es zu den Anwendungsfällen für den Nachrichtenaustausch zwischen Versicherten und Apotheken

Bekannte Fehler im Fachdienst

  • Referenzen in einigen responses des Fachdienstes sind noch nicht FHIR konform (bsp: Task.input oder erneutes Abrufen der Quittung). Da dies ein breaking change ist, wird dies in einer späteren Version behoben
  • Bis zum Release der Version 1.12, die für Dezember 2023 geplant ist, werden die Schlüsseltabellen 'NORMGROESSE' und 'DARREICHUNGSFORM' nicht validiert. Diese werden in den Medication Profilen der KBV verwendet. Der Issue kann in ERPFIND-533 verfolgt werden.

Lizenzbedingungen

Copyright (c) 2024 gematik GmbH

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

gematik provides a comprehensive overview of the e-prescription interfaces. This API documentation serves as a supplement to gematik's standard regulatory documents and details the e-prescription profiles based on the FHIR standard.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages