BfArM Digitale Anwendungen
3.0.2-RC1 - draft

​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

DiPA – 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 DipaId%7C00123 statt DipaId|00123.

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 DiPA-Daten

Abruf aller Digitalen Pflegeanwendungen

Beschreibung

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

Standardablauf
  1. Suchanfrage mit dem Canonical des Profils als _profile-Parameter
  2. DiPA-API liefert die gefundenen DiPA-Einträge zurück
API-Abfrage
GET https://dipa.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HealthApp

Abruf aller Ressourcen

Abruf aller Daten einer bestimmten Digitalen Pflegeanwendung

Beschreibung

Dieser Anwendungsfall beschreibt den Abruf aller Daten einer bestimmten Digitalen Pflegeanwendung (DiPA) aus dem DiPA-Verzeichnis. Die Daten umfassen den Verzeichniseintrag (Profil HealthAppCatalogEntry), die Digitale Pflegeanwendung (Profil HealthApp), den DiPA-Hersteller (Profil HealthAppManufacturer), die DiPA-Module (Profil HealthAppModule), die Anwendungseinheiten (Profil HealthAppPrescriptionUnit) und den DiPA-Antwortdatensatz (Profil HealthAppQuestionnaireResponse). Es wird davon ausgegangen, dass die DiPA 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 DiPA
API-Abfrage
GET https://dipa.bfarm.de/api/fhir/v3.0/DeviceDefinition/{id}/$everything

Beispiel (interne id "1"):

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

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

Die Operation benutzt keine Paginierung.

Abruf sämtlicher DiPA-Daten

Beschreibung

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

Standardablauf
  1. Suchanfragen mit dem Canonical der entsprechenden Profile als _profile-Parameter und einem ausreichend hohen _count-Parameter
  2. DiPA-API liefert die gefundenen Einträge zurück
API-Abfrage
  • Alle Verzeichniseinträge (Profil HealthAppCatalogEntry):
GET https://dipa.bfarm.de/api/fhir/v3.0/CatalogEntry?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntry
  • Alle DiPA-Hersteller (Profil HealthAppManufacturer):
GET https://dipa.bfarm.de/api/fhir/v3.0/Organization?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppManufacturer
  • Alle DiPA (Profil HealthApp):
GET https://dipa.bfarm.de/api/fhir/v3.0/DeviceDefinition?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthApp
  • Alle DiPA-Module (Profil HealthAppModule):
GET https://dipa.bfarm.de/api/fhir/v3.0/DeviceDefinition?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppModule
  • Alle Anwendungseinheiten (Profil HealthAppPrescriptionUnit):
GET https://dipa.bfarm.de/api/fhir/v3.0/ChargeItemDefinition?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnit
  • Alle DiPA-Antwortdatensätze (Profil HealthAppQuestionnaireResponse):
GET https://dipa.bfarm.de/api/fhir/v3.0/QuestionnaireResponse?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppQuestionnaireResponse
  • Alle DiPA-Fragenkataloge (Profil HealthAppQuestionnaire):
GET https://dipa.bfarm.de/api/fhir/v3.0/Questionnaire?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppQuestionnaire