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

  1. Nutzerin / Nutzer der DiPA-API fragt eine Liste mit allen Einträgen des DiPA-Verzeichnisses an
  2. DiPA-API liefert die angefragte DiPA-Liste zurück
  3. 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

  1. Nutzerin / Nutzer der DiPA-API fragt alle Daten zu einer spezifischen DiPA an
  2. DiPA-API liefert die angefragten Daten zur DiPA zurück
  3. 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.

G03: Abruf sämtlicher DiPA-Daten

BeschreibungDieser Anwendungsfall beschreibt den Abruf aller im DiPA-Verzeichnis gespeicherten Daten zu Digitalen Pflegeanwendungen (DiPA). Dies ist die effizienteste Methode, um sämtliche DiPA-Daten zentral abzurufen.Beteiligte Akteure
  • Alle Nutzerinnen und Nutzer der DiPA-API
Auslöser
  • Eine Nutzerin oder ein Nutzer der DiPA-API möchte sämtliche DiPA-Daten abrufen, z. B. zur Weiterverarbeitung oder Darstellung in einem eigenen System.
Standardablauf
  1. Die Nutzerin oder der Nutzer fragt alle Daten, gruppiert nach Profil, über die DiPA-API ab.
  2. Die DiPA-API liefert die Daten entsprechend gruppiert zurück.
  3. Die empfangenen Daten werden im jeweils vorgesehenen Nutzungskontext weiterverarbeitet.
API-AbfrageFür den vollständigen Datenabruf sind insgesamt sieben API-Requests erforderlich. Die Daten werden dabei nach den jeweiligen FHIR-Profilen gruppiert abgerufen (siehe auch Logisches Datenmodell).

  • Alle Verzeichniseinträge:

    https://dipa.bfarm.de/api/fhir/v2.0/CatalogEntry?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntry

  • Alle DiPA-Hersteller:

    https://dipa.bfarm.de/api/fhir/v2.0/Organization?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppManufacturer

  • Alle DiPA:

    https://dipa.bfarm.de/api/fhir/v2.0/DeviceDefinition?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthApp

  • Alle DiPA-Module:

    https://dipa.bfarm.de/api/fhir/v2.0/DeviceDefinition?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppModule

  • Alle Anwendungseinheiten:

    https://dipa.bfarm.de/api/fhir/v2.0/ChargeItemDefinition?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnit

  • Alle DiPA-Antwortdatensätze:

    https://dipa.bfarm.de/api/fhir/v2.0/QuestionnaireResponse?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppQuestionnaireResponse

  • Alle DiPA-Fragenkataloge:

    https://dipa.bfarm.de/api/fhir/v2.0/Questionnaire?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppQuestionnaire

Hinweise

  • Je nach eingesetzter Software müssen die URL-Parameter gegebenenfalls kodiert werden. Beispiel kodiert: ?_count=1000&_profile=https%3A%2F%2Ffhir.bfarm.de%2FStructureDefinition%2FHealthAppCatalogEntry.

  • In externen Systemen dürfen die von der API gelieferten id-Werte der Ressourcen nicht gespeichert werden. Stattdessen dürfen nur die in den Ressourcen enthaltenen identifier verwendet und gespeichert werden.