Häufige Fragen


Welchem Zweck dient die DiPA-API?

Gemäß § 17 Absatz 2 und Absatz 3 der Digitale Pflegeanwendungen-Verordnung (DiPAV) stellt das BfArM berechtigten Nutzerinnen und Nutzern die im DiPA-Verzeichnis veröffentlichten Daten auf Antrag in maschinenlesbarer Form zur Verfügung. Diese Daten werden über eine Programmierschnittstelle (DiPA-API), welche in diesem Implementierungsleitfaden dokumentiert ist, zur Verfügung gestellt. Der Implementierungsleitfaden liefert auch erste Beschreibungen von Anwendungsfällen für die berechtigen Nutzergruppen.


Wer ist zur Nutzung der DiPA-API berechtigt?

Gemäß § 17 Absatz 3 DiPAV können folgende Berechtigte einen Zugang zur DiPA-API beantragen:

  • der Spitzenverband Bund der Pflegekassen,
  • der Verband der privaten Krankenversicherung e. V.,
  • die Bundes- und Landesverbänden der Pflegekassen,
  • die Pflegekassen,
  • die maßgeblichen Spitzenorganisationen der Hersteller von digitalen Pflegeanwendungen,
  • die maßgeblichen Spitzenorganisationen der Hersteller von digitalen Gesundheitsanwendungen,
  • die Institutionen der Gesundheitsversorgungsforschung,
  • die Hochschulen, die öffentlich geförderten außeruniversitären Forschungseinrichtungen und sonstige Einrichtungen mit der Aufgabe unabhängiger wissenschaftlicher Forschung, sofern die Daten wissenschaftlichen Vorhaben dienen,
  • die oder der Bevollmächtigte der Bundesregierung für die Pflege,
  • die oder der Beauftragte der Bundesregierung für die Belange der Patientinnen und Patienten,
  • die maßgeblichen Organisationen für die Wahrnehmung der Interessen und der Selbsthilfe pflegebedürftiger und behinderter Menschen nach § 118 des Elften Buches Sozialgesetzbuch,
  • die Vereinigungen der Träger der Pflegeeinrichtungen auf Bundesebene,
  • die Verbände der Pflegeberufe auf Bundesebene,
  • die für die soziale Pflegeversicherung zuständigen obersten Bundes- und Landesbehörden und deren jeweiligen nachgeordneten Bereiche sowie die übrigen obersten Bundesbehörden,
  • sonstige öffentliche Stellen des Bundes, der Länder und Gemeinden sowie
  • gemeinnützige juristische Personen des Privatrechts.

Wie wird der Antrag auf Nutzung der DiPA-API gestellt?

Um die DiPA-API nutzen zu können, müssen Sie nach § 17 Absatz 3 DiPAV berechtigt sein und im ersten Schritt einen Antrag auf Nutzung stellen. Bis zur Bereitstellung der DiPA-API sind folgende Schritte notwendig:

1. Nutzerkonto anlegen

Um einen Antrag auf Nutzung der DiGP-API einzureichen, benötigen Sie im ersten Schritt ein Nutzerkonto für das elektronische API-Antragsportal. Sie können das Nutzerkonto unter antrag-api.bfarm.de/de/nutzerkonto-anlegen anlegen.

2. Nutzerkonto aktivieren

Nach Anlage des Nutzerkontos erhalten Sie eine E-Mail mit einem Link zur Aktivierung Ihres Nutzerkontos. Mit dem Öffnen der angegebenen URL und der Festlegung eines Passworts ist das Nutzerkonto aktiv.

3. Antrag auf API-Nutzung einreichen

Innerhalb des elektronischen API-Antragsportals können Sie unter dem Menüpunkt Anträge nun einen Antrag auf Nutzung der DiPA-API stellen. Ihr Antrag wird nach Einreichung durch das BfArM geprüft, Sie erhalten per E-Mail eine Benachrichtigung über Annahme oder Ablehnung Ihres Antrags.


Wo finde ich meine API-Zugangsdaten?

Mit Annahme Ihres Antrags auf Nutzung der DiGA-API erhalten Sie eine Benachrichtigung per E-Mail. Ab diesem Zeitpunkt haben Sie im Dashboard des elektronischen API-Antragsportals Zugriff auf Ihr individuelles API-Token (Bearer Token). Sie müssen Ihr Token vertraulich behandeln und dürfen es unter keinen Umständen weitergeben.


Fragen zur Profilierung: Questionnaire und QuestionnaireResponse


In den Instanzen des FHIR-Profils „QuestionnaireResponse“ wird im Element „questionnaire auf die dazugehörige Instanz des FHIR-Profils „Questionnaire“ mit der URL https://antrag.bfarm.de/de/intern/fragenkataloge/31 verwiesen, welche allerdings nicht zugänglich ist. Ist es möglich, stattdessen für alle DiPA die generische Instanz mit der URL https://dipa.bfarm.de/api/fhir/v2.0/Questionnaire zu verwenden?

Das Feld „QuestionnaireResponse.questionnaire“ muss dem dem Feld „Questionnaire.canonical“ entsprechen und serverübergreifend eindeutig sein. Auf dem FHIR-Server können mehrere „Questionnaires“ gespeichert sein (z.B. DiGA und DiPA). Eine generische URL ist damit nicht möglich.

Eine direkt erreichbare URL ist in diesem Feld nicht zwingend notwendig. Das Feld kann mit der folgenden Abfrage genutzt werden um den „Questionnaire“ zu einem „QuestionnareResponse“ zu erhalten:

https://dipa.bfarm.de/api/fhir/v2.0/Questionnaire?_url=https://antrag.bfarm.de/de/intern/fragenkataloge/31


Die Verlinkung zwischen den Fragen und Antworten der Profilinstanzen „Questionnaire“ und „QuestionnaireResponse“ erfolgt über das Element „linkId“. Ist die Zuordnung der Werte dieser ID zu einzelnen Fragen und Fragenbereichen fix, so dass dieses Element zu deren Selektierung verwendet werden kann?

Die „linkId“ entspricht der internen ID der Assessments, Fragenblöcke und Fragen im Antragsportal. Die „linkId“ im „Questionnaire“ entspricht immer der passenden „linkId“ innerhalb der gleichen item-Ebene im „QuestionnaireResponse. Die „linkId“ kann also zur Selektion innerhalb der gleichen item-Ebene verwendet werden. Ebenenübergreifend kann die „linkId“ nicht verwendet werden, da die „linkId“ nicht global eindeutig ist.

Die Ids verändern sich nicht bei neuen Versionen des Fragenkatalogs. Es können aber neue Fragen mit neuen „linkIds“ hinzukommen, Fragen entfallen oder die Reihenfolge der Fragen sowie Typ und Text und mögliche Antworten der Fragen können sich ändern.


Neben dem Element „linkId“ existiert das Element „text“, mit dem einzelne Einträge des Fragenkatalogs selektiert werden können. Sind die Werte dieses Elements für bestimmte Fragenbereiche fix?

Die Werte des Feldes „text“ sind nicht fix. Die Werte können sich ändern, wenn der Fragenkatalog aktualisiert und BfArM-seitig Änderungen an den Texten vorgenommen werden (Name und Erläuterungstext der Assessments, Fragenblöcke und Fragen). Das „text“-Feld sollte daher nicht zur Selektion verwendet werden.