Endpunkte

Inhalt

CatalogEntry

Über die FHIR®-Ressource CatalogEntry werden die einzelnen Einträge aus dem DiPA-Verzeichnis mit Referenzierung auf die jeweiligen DiPA ausgegeben.

GET https://dipa.bfarm.de/api/fhir/v3.0/CatalogEntry

Informationen zu einem bestimmten Eintrag des DiPA-Verzeichnisses

Hinweis: Die intern verwendeten IDs dürfen nicht extern gespeichert werden, da diese sich bei neuen Releases der API ändern.

GET https://dipa.bfarm.de/api/fhir/v3.0/CatalogEntry/10

gibt die Daten zum Verzeichniseintrag mit der internen ID 10 aus.

JSON

Command 'json' could not render: File not found for 'subject=bfarm/Example-DiPA-HealthAppCatalogEntry'

XML

Command 'xml' could not render: File not found for 'subject=bfarm/Example-DiPA-HealthAppCatalogEntry'

ChargeItemDefinition

Über die FHIR®-Ressource ChargeItemDefinition werden Informationen zu einzelnen Anwendungseinheiten der DiPA-Module ausgegeben.

GET https://dipa.bfarm.de/api/fhir/v3.0/ChargeItemDefinition

Informationen zu einer bestimmten DiPA-Anwendungseinheit

Hinweis: Die intern verwendeten IDs dürfen nicht extern gespeichert werden, da diese sich bei neuen Releases der API ändern.

GET https://dipa.bfarm.de/api/fhir/v3.0/ChargeItemDefinition/6

gibt die Daten zur Anwendungseinheit mit der internen ID 6 aus.

JSON

Command 'json' could not render: File not found for 'subject=bfarm/Example-DiPA-HealthAppPrescriptionUnit-1'

XML

Command 'xml' could not render: File not found for 'subject=bfarm/Example-DiPA-HealthAppPrescriptionUnit-1'

DeviceDefinition

Über die FHIR®-Ressource DeviceDefinition werden Informationen sowohl zu einzelnen DiPA also auch zu deren zugehörigen DiPA-Modulen ausgegeben.

GET https://dipa.bfarm.de/api/fhir/v3.0/DeviceDefinition

Informationen zu einer bestimmten DiPA

Hinweis: Die intern verwendeten IDs dürfen nicht extern gespeichert werden, da diese sich bei neuen Releases der API ändern. Als eindeutiger Identifier einer DiPA gilt allein die DiPA-ID welche in der identifier-Eigenschaft ausgelesen werden kann.

GET https://dipa.bfarm.de/api/fhir/v3.0/DeviceDefinition/1

gibt die Daten zur DiPA mit der internen ID 1 aus (DiPA-ID ist 01964).

GET https://dipa.bfarm.de/api/fhir/v3.0/DeviceDefinition?identifier=https://fhir.bfarm.de/Identifier/DipaId|01964

gibt die Daten zur DiPA mit der DiPA-ID 01964 aus.

JSON

Command 'json' could not render: File not found for 'subject=bfarm/Example-DiPA-HealthApp'

XML

Command 'xml' could not render: File not found for 'subject=bfarm/Example-DiPA-HealthApp'

Hinweis: Je nach verwendeter Software ist eine URL-Kodierung der Parameter notwendig: DipaId%7C01964.

Informationen zu einem der DiPA zugehörigen DiPA-Modul

GET https://dipa.bfarm.de/api/fhir/v3.0/DeviceDefinition/3

gibt die Daten zum der DiPA zugehörigen DiPA-Modul mit der internen ID 3 aus.

JSON

Command 'json' could not render: File not found for 'subject=bfarm/Example-DiPA-HealthAppModule-1'

XML

Command 'xml' could not render: File not found for 'subject=bfarm/Example-DiPA-HealthAppModule-1'

Die Beispieldaten entsprechen denen eines DiPA-Moduls, welches auf die zugehörige DiPA referenziert (parentDevice, im Beispiel lautet die Referenz DeviceDefinition/1).

Organization

Über die FHIR®-Ressource Organization werden Informationen zu einzelnen DiPA-Herstellern ausgegeben.

GET https://dipa.bfarm.de/api/fhir/v3.0/Organization

Informationen zu einem bestimmten DiPA-Hersteller

Hinweis: Die intern verwendeten IDs dürfen nicht extern gespeichert werden, da diese sich bei neuen Releases der API ändern.

GET https://dipa.bfarm.de/api/fhir/v3.0/Organization/2

gibt die Daten zum DiPA-Hersteller mit der internen ID 2 aus.

JSON

Command 'json' could not render: File not found for 'subject=bfarm/Example-DiPA-HealthAppManufacturer'

XML

Command 'xml' could not render: File not found for 'subject=bfarm/Example-DiPA-HealthAppManufacturer'

Questionnaire

Über die FHIR®-Ressource Questionnaire werden Fragenkataloge repräsentiert welche im Zuge eines Antrags auf Aufnahme ins DiPA-Verzeichnis vom Hersteller der DiPA beantwortet werden.

GET https://dipa.bfarm.de/api/fhir/v3.0/Questionnaire

Informationen zu einem bestimmten Fragenkatalog

Hinweis: Die intern verwendeten IDs dürfen nicht extern gespeichert werden, da diese sich bei neuen Releases der API ändern.

GET https://dipa.bfarm.de/api/fhir/v3.0/Questionnaire/11

gibt die Daten zum Fragenkatalog mit der internen ID 11 aus.

JSON

Command 'json' could not render: File not found for 'subject=bfarm/Example-DiPA-HealthAppQuestionnaire'

XML

Command 'xml' could not render: File not found for 'subject=bfarm/Example-DiPA-HealthAppQuestionnaire'

QuestionnaireResponse

Über die FHIR®-Ressource QuestionnaireResponse werden die vom Hersteller gegebenen Antworten für einen bestimmten Fragenkatalog repräsentiert.

GET https://dipa.bfarm.de/api/fhir/v3.0/QuestionnaireResponse

Informationen zu einem bestimmten Antwortdatensatz

Hinweis: Die intern verwendeten IDs dürfen nicht extern gespeichert werden, da diese sich bei neuen Releases der API ändern.

GET https://dipa.bfarm.de/api/fhir/v3.0/QuestionnaireResponse/12

gibt die Daten zum Antwortdatensatz mit der internen ID 12 aus.

JSON

Command 'json' could not render: File not found for 'subject=bfarm/Example-DiPA-HealthAppQuestionnaireResponse'

XML

Command 'xml' could not render: File not found for 'subject=bfarm/Example-DiPA-HealthAppQuestionnaireResponse'