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/v2.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/v2.0/CatalogEntry/10
gibt die Daten zum Verzeichniseintrag mit der internen ID 10 aus.
JSON
XML
ChargeItemDefinition
Über die FHIR®-Ressource ChargeItemDefinition werden Informationen zu einzelnen Anwendungseinheiten der DiPA-Module ausgegeben.
GET https://dipa.bfarm.de/api/fhir/v2.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/v2.0/ChargeItemDefinition/6
gibt die Daten zur Anwendungseinheit mit der internen ID 6 aus.
JSON
XML
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/v2.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/v2.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/v2.0/DeviceDefinition?identifier=https://fhir.bfarm.de/Identifier/DipaId|01964
gibt die Daten zur DiPA mit der DiPA-ID 01964 aus.
JSON
XML
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/v2.0/DeviceDefinition/3
gibt die Daten zum der DiPA zugehörigen DiPA-Modul mit der internen ID 3 aus.
JSON
XML
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/v2.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/v2.0/Organization/2
gibt die Daten zum DiPA-Hersteller mit der internen ID 2 aus.
JSON
XML
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/v2.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/v2.0/Questionnaire/11
gibt die Daten zum Fragenkatalog mit der internen ID 11 aus.
JSON
XML
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/v2.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/v2.0/QuestionnaireResponse/12
gibt die Daten zum Antwortdatensatz mit der internen ID 12 aus.
JSON
XML