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.