​BfArM Digitale Anwendungen - Local Development build (v3.0.2-RC1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

DiPA – Overview

This implementation guide documents the DiPA-API software interface for providing data from the DiPA directory, i.e. the directory of Digital Nursing Applications (DiPA) that have been assessed by the BfArM in accordance with § 78a of Book XI of the German Social Code (SGB XI).

Background information

What is the purpose of the DiPA-API?

Pursuant to § 17(2) and (3) of the Digital Nursing Applications Ordinance (Digitale-Pflegeanwendungen-Verordnung – DiPAV), the BfArM provides authorised users with the data published in the DiPA directory in machine-readable form upon request. These data are made available via a programming interface (DiPA-API) documented in this implementation guide. The guide also provides initial descriptions of use cases for the authorised user groups.

Who is authorised to use the DiPA-API?

Pursuant to § 17(3) DiPAV, the following may apply for access to the DiPA-API:

• the National Association of Long-Term Care Insurance Funds (Spitzenverband Bund der Pflegekassen),
• the Association of Private Health Insurers (Verband der privaten Krankenversicherung e. V.),
• the federal and regional associations of long-term care insurance funds,
• the long-term care insurance funds,
• the relevant umbrella organisations of manufacturers of Digital Nursing Applications,
• the relevant umbrella organisations of manufacturers of Digital Health Applications,
• institutions for health services research,
• universities, publicly funded non-university research institutions and other institutions with a mandate for independent scientific research, where the data serve scientific projects,
• the Federal Government Commissioner for Long-Term Care,
• the Federal Government Commissioner for the Interests of Patients,
• the relevant organisations for representing the interests and self-help of persons in need of care and persons with disabilities under § 118 of Book XI of the German Social Code,
• the federal-level associations of long-term care facility providers,
• the federal-level associations of care professions,
• the supreme federal and Land authorities responsible for long-term care insurance and their subordinate bodies, as well as the other supreme federal authorities,
• other public bodies of the Federation, the Länder and municipalities, and
• non-profit legal persons under private law.

Typical scenarios

The DiPA-API supports typical scenarios for working with Digital Nursing Applications. The following provides an overview of these.

Checking reimbursement eligibility by long-term care insurance funds

Long-term care insurance funds can use the DiPA-API to find out about the DiPA specified by the person in need of care in their application for cost reimbursement and to check reimbursement eligibility. This involves checking whether the DiPA has a demonstrable benefit for care for the applicant. Information is also provided on whether complementary support services (ergänzende Unterstützungsleistungen – eUL) are mandatory for using a DiPA or whether eUL are only intended for users with certain impairments. The actors involved include, in addition to the long-term care insurance fund and the person in need of care, family carers, other voluntary carers or approved outpatient care services, as well as DiPA manufacturers. Typical process: After consulting the DiPA directory, persons in need of care (possibly together with relatives or care services) select a suitable DiPA, submit an application for cost reimbursement to their long-term care insurance fund, and the fund checks the entitlement to benefits by accessing the DiPA directory via the DiPA-API.

Quality transparency

The DiPA directory enables transparency on the market and the quality of DiPA in line with a public reporting model. Data from the directory may be processed and published for end users by quality transparency initiatives, consumer protection organisations or other providers, possibly enriched with additional quality or rating data. This allows consumers to find out about the range and quality of Digital Nursing Applications.

Using the DiPA-API

How do I apply to use the DiPA-API?

To use the DiPA-API, you must be authorised under § 17(3) DiPAV and, as a first step, submit an application for use. The following steps are required until the DiPA-API is made available to you:

1. Create a user account

To submit an application to use the DiPA-API, you first need a user account for the electronic API application portal. You can create the account at antrag-api.bfarm.de.

2. Activate your user account

After creating your account, you will receive an email with a link to activate it. Opening the URL provided and setting a password activates your user account.

3. Submit your application for API use

Within the electronic API application portal, you can submit an application to use the DiPA-API under the “Anträge” (Applications) menu item. Your application will be reviewed by the BfArM after submission, and you will receive an email notification of its acceptance or rejection.

Where can I find my API access credentials?

When your application to use the DiPA-API is accepted, you will receive a notification by email. From that point on, you have access to your individual API token (Bearer token) in the dashboard of the electronic API application portal. You must treat your token as confidential and must not pass it on under any circumstances.