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.