​BfArM Digitale Anwendungen - Local Development build (v3.0.2-RC1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

DiGA – Anwendungsfälle

Auf externen Systemen dürfen die zurückgelieferten id-Werte der Ressourcen nicht gespeichert werden, da sich diese in neuen Versionen der API ändern können. Stattdessen sollen die in den Ressourcen hinterlegten identifier gespeichert werden.

Je nach verwendeter Software ist eine URL-Kodierung der Parameter notwendig, beispielsweise DigaId%7C00123 statt DigaId|00123 oder pzn%7C12345678 statt pzn|12345678.

Die von der API zurückgelieferten Ergebnisse sind FHIR®-üblich paginiert. Im Element meta.total ist die Gesamtzahl der Ergebnisse über alle Seiten sichtbar. Der FHIR®-Server benutzt standardmäßig eine Seitengröße von 20 Elementen. Die weiteren Seiten sind über das link-Element verlinkt. Durch Angabe des _count-Parameters lässt sich die Anzahl der Ergebnisse je Seite einstellen.

Abruf von DiGA-Daten

Abruf aller Digitalen Gesundheitsanwendungen

Beschreibung

Dieser Anwendungsfall beschreibt den Abruf aller DiGA-Einträge (Profil HealthApp).

Standardablauf

1. Suchanfrage mit dem Canonical des Profils als _profile-Parameter.
2. DiGA-API liefert die gefundenen DiGA-Einträge zurück

API-Abfrage

GET https://diga.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HealthApp

Abruf der Vertrauensattribute einer DiGA

Beschreibung

Dieser Anwendungsfall beschreibt den Abruf der Vertrauensattribute einer DiGA für die Kommunikation mit Hilfsmittelschnittstellen (HIIS). Die Vertrauensattribute werden über die Extension HealthAppHiisTrustAttributes in der HealthApp-Ressource bereitgestellt und enthalten Informationen wie Client-Zertifikate, Client-ID und Redirect-URI. Die Extension ist optional und muss nicht in jeder DiGA vorhanden sein.

Standardablauf

1. Suchanfrage mit der DiGA-ID als identifier-Parameter
2. DiGA-API liefert den gefundenen DiGA-Eintrag mit den Vertrauensattributen in der Extension HealthAppHiisTrustAttributes zurück

Die Extension kann folgende Elemente enthalten:

• extension[clientCertificates]: Client-Zertifikate als Base64-kodierte Binärdaten (0..*)
• extension[clientId]: Client-Identifikator für HIIS als URI (0..1)
• extension[redirectUri]: Redirect-URI für HIIS als URI (0..1)

API-Abfrage

GET https://diga.bfarm.de/api/fhir/v3.0/DeviceDefinition?identifier=https://fhir.bfarm.de/Identifier/DigaId|{DigaId}&_profile=https://fhir.bfarm.de/StructureDefinition/HealthApp

Beispiel (DiGA-ID "00123"):

GET https://diga.bfarm.de/api/fhir/v3.0/DeviceDefinition?identifier=https://fhir.bfarm.de/Identifier/DigaId|00123&_profile=https://fhir.bfarm.de/StructureDefinition/HealthApp

Abruf von Verordnungseinheiten

Suche einer Verordnungseinheit auf Basis einer PZN

Beschreibung

Dieser Anwendungsfall beschreibt die Suche nach Verordnungseinheiten (Profil HealthAppPrescriptionUnit) anhand einer gegebenen PZN (Pharmazentralnummer).

Standardablauf

1. Suchanfrage mit der PZN als code-Parameter
2. DiGA-API liefert die gefundenen Verordnungseinheiten zurück

API-Abfrage

GET https://diga.bfarm.de/api/fhir/v3.0/ChargeItemDefinition?code=http://fhir.de/CodeSystem/ifa/pzn|{PZN}&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnit

Beispiel (PZN "12345678"):

GET https://diga.bfarm.de/api/fhir/v3.0/ChargeItemDefinition?code=http://fhir.de/CodeSystem/ifa/pzn|12345678&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnit

Abruf aller Ressourcen

Abruf aller Daten einer bestimmten Digitalen Gesundheitsanwendung

Beschreibung

Dieser Anwendungsfall beschreibt den Abruf aller Daten einer bestimmten Digitalen Gesundheitsanwendung (DiGA) aus dem DiGA-Verzeichnis. Die Daten umfassen den Verzeichniseintrag (Profil HealthAppCatalogEntry), die Digitale Gesundheitsanwendung (Profil HealthApp), den DiGA-Hersteller (Profil HealthAppManufacturer), die DiGA-Module (Profil HealthAppModule), die Verordnungseinheiten (Profil HealthAppPrescriptionUnit) und den DiGA-Antwortdatensatz (Profil HealthAppQuestionnaireResponse). Es wird davon ausgegangen, dass die DiGA bereits durch eine vorangegangene Suchabfrage ermittelt wurde und die interne id bekannt ist.

Standardablauf

1. Aufruf der Operation $everything mit der internen id der bereits ermittelten DiGA

API-Abfrage

GET https://diga.bfarm.de/api/fhir/v3.0/DeviceDefinition/{id}/$everything

Beispiel (interne id "1"):

GET https://diga.bfarm.de/api/fhir/v3.0/DeviceDefinition/1/$everything

Diese Operation liefert ein Bundle vom Typ searchset mit allen zur DiGA zugehörigen Ressourcen. Beim Aufruf auf die interne id eines DiGA-Moduls werden ebenfalls alle Ressourcen der zugehörigen DiGA zurückgegeben und nicht nur die zum DiGA-Modul zugehörigen Ressourcen.

Die Operation benutzt keine Paginierung.

Abruf sämtlicher DiGA-Daten

Beschreibung

Dieser Anwendungsfall beschreibt den Abruf aller im DiGA-Verzeichnis gespeicherten Daten. Dies ist die effizienteste Methode, um sämtliche DiGA-Daten zentral abzurufen.

Standardablauf

1. Suchanfragen mit dem Canonical der entsprechenden Profile als _profile-Parameter und einem ausreichend hohen _count-Parameter.
2. DiGA-API liefert die gefundenen Einträge zurück

API-Abfrage

• Alle Verzeichniseinträge (Profil HealthAppCatalogEntry):

GET https://diga.bfarm.de/api/fhir/v3.0/CatalogEntry?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntry

• Alle DiGA-Hersteller (Profil HealthAppManufacturer):

GET https://diga.bfarm.de/api/fhir/v3.0/Organization?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppManufacturer

• Alle DiGA (Profil HealthApp):

GET https://diga.bfarm.de/api/fhir/v3.0/DeviceDefinition?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthApp

• Alle DiGA-Module (Profil HealthAppModule):

GET https://diga.bfarm.de/api/fhir/v3.0/DeviceDefinition?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppModule

• Alle Verordnungseinheiten (Profil HealthAppPrescriptionUnit):

GET https://diga.bfarm.de/api/fhir/v3.0/ChargeItemDefinition?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnit

• Alle DiGA-Antwortdatensätze (Profil HealthAppQuestionnaireResponse):

GET https://diga.bfarm.de/api/fhir/v3.0/QuestionnaireResponse?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppQuestionnaireResponse

• Alle DiGA-Fragenkataloge (Profil HealthAppQuestionnaire):

GET https://diga.bfarm.de/api/fhir/v3.0/Questionnaire?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppQuestionnaire