Generische Anwendungsfälle
Inhalt
G01: Abruf einer Liste mit allen DiPA des DiPA-Verzeichnisses
Beschreibung
Dieser grundlegende Anwendungsfall beschreibt den Abruf einer Liste mit allen digitalen Pflegeanwendungen (DiPA), die im DiPA-Verzeichnis gelistet sind.
Beteiligte Akteure
- Alle Nutzerinnen / Nutzer der DiPA-API
Auslöser
- Nutzerin / Nutzer der DiPA-API möchte eine Liste mit allen verfügbaren DiPA abrufen und darstellen
Standardablauf
- Nutzerin / Nutzer der DiPA-API fragt eine Liste mit allen Einträgen des DiPA-Verzeichnisses an
- DiPA-API liefert die angefragte DiPA-Liste zurück
- Nutzerin / Nutzer stellt die DiPA-Liste im individuellen Nutzungskontext dar
API-Abfrage
GET https://dipa.bfarm.de/api/fhir/v2.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HealthApp
Das zurückgelieferte Searchset ist 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. Das bedeutet der Aufruf liefert nur die erste Seite der Ergebnisse (20 DiPA).
Die weiteren Seiten sind über das link
-Element verlinkt. Durch Angabe des _count
-Parameters lässt sich die Anzahl der Ergebnisse je Seite einstellen.
Auf externen System darf die zurückgelieferte id
der DeviceDefinition
-Ressource sowie aller weiterer Ressourcen nicht gespeichert werden. Stattdessen dürfen auf externen System nur die in den Ressourcen hinterlegten identifier
gespeichert werden.
G02: Abruf aller Daten zu einer spezifischen DiPA
Beschreibung
Dieser Anwendungsfall beschreibt den Abruf aller Daten zu einer spezifischen digitalen Pflegeanwendung (DiPA) aus dem DiPA-Verzeichnis. Diese Daten umfassen auch Daten zu einzelnen DiPA-Modulen und zugehörigen Anwendungseinheiten.
Beteiligte Akteure
- Alle Nutzerinnen / Nutzer der DiPA-API
Auslöser
- Nutzerin / Nutzer der DiPA-API möchte Daten zu einer spezifischen DiPA abrufen und darstellen
Standardablauf
- Nutzerin / Nutzer der DiPA-API fragt alle Daten zu einer spezifischen DiPA an
- DiPA-API liefert die angefragten Daten zur DiPA zurück
- Nutzerin / Nutzer verarbeitet die Daten zur DiPA im individuellen Nutzungskontext
API-Abfrage
Zunächst ist über den extern gespeicherten identifier
der DiPA die interne id
der Ressource in der FHIR-API zu ermitteln.
In diesem Beispiel ist der gespeicherte identifier
die DiPA-ID "00294":
https://dipa.bfarm.de/api/fhir/v2.0/DeviceDefinition?identifier=https://fhir.bfarm.de/Identifier/DipaId|00294
Aus der zurückgelieferten Ressource ist dann die interne id
für die folgende Operation zu verwenden. In diesem Beispiel die "1":
GET https://dipa.bfarm.de/api fhir/v2.0/DeviceDefinition/1/$everything
Diese Operation benutzt keine Paginierung.
Hinweis: Je nach verwendeter Software ist eine URL-Kodierung der Parameter notwendig: DipaId%7C00294
.