G04: Abruf sämtlicher DiGA-Daten

Beschreibung

Dieser Anwendungsfall beschreibt den Abruf aller im DiGA-Verzeichnis gespeicherten Daten zu Digitalen Gesundheitsanwendungen (DiGA). Dies ist die effizienteste Methode, um sämtliche DiGA-Daten zentral abzurufen.

Beteiligte Akteure

  • Alle Nutzerinnen und Nutzer der DiGA-API

Auslöser

  • Eine Nutzerin oder ein Nutzer der DiGA-API möchte sämtliche DiGA-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 DiGA-API ab.
  2. Die DiGA-API liefert die Daten entsprechend gruppiert zurück.
  3. Die empfangenen Daten werden im jeweils vorgesehenen Nutzungskontext weiterverarbeitet.

API-Abfrage

Fü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://diga.bfarm.de/api/fhir/v2.0/CatalogEntry?_count=1000&_profile=https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntry

  • Alle DiGA-Hersteller:

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

  • Alle DiGA:

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

  • Alle DiGA-Module:

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

  • Alle Verordnungseinheiten:

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

  • Alle DiGA-Antwortdatensätze:

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

  • Alle DiGA-Fragenkataloge:

    https://diga.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.