​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

HIIS – Anwendungsfälle

Auf externen Systemen dürfen die zurückgelieferten id-Werte der Ressourcen nicht gespeichert werden, da sich diese in neuen Versionen der API ändern können. Stattdessen sollen die in den Ressourcen hinterlegten identifier gespeichert werden.

Je nach verwendeter Software ist eine URL-Kodierung der Parameter notwendig, beispielsweise HiisId%7C00123 statt HiisId|00123.

Die von der API zurückgelieferten Ergebnisse sind FHIR®-üblich paginiert. Im Element meta.total ist die Gesamtzahl der Ergebnisse über alle Seiten sichtbar. Der FHIR®-Server benutzt standardmäßig eine Seitengröße von 20 Elementen. Die weiteren Seiten sind über das link-Element verlinkt. Durch Angabe des _count-Parameters lässt sich die Anzahl der Ergebnisse je Seite einstellen.

Abruf von Hilfsmittelschnittstellen

Suche einer Hilfsmittelschnittstelle auf Basis einer HIIS-ID

Beschreibung

Dieser Anwendungsfall beschreibt die Suche nach einer Hilfsmittelschnittstelle (Profil HiisDeviceDataRecorderDefinition) anhand der eindeutigen HIIS-ID.

Standardablauf

1. Suchanfrage mit der HIIS-ID als identifier-Parameter
2. HIIS-API liefert den gefundenen Hilfsmittelschnittstellen-Eintrag zurück

API-Abfrage

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?identifier=https://fhir.bfarm.de/Identifier/HiisId|{HIIS-ID}&_profile=https://fhir.bfarm.de/StructureDefinition/HiisDeviceDataRecorderDefinition

Beispiel (HIIS-ID "00123"):

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?identifier=https://fhir.bfarm.de/Identifier/HiisId|00123&_profile=https://fhir.bfarm.de/StructureDefinition/HiisDeviceDataRecorderDefinition

Suche von Hilfsmittelschnittstellen-Einträgen auf Basis einer MIV-Set-URL

Beschreibung

Dieser Anwendungsfall beschreibt die Suche nach Hilfsmittelschnittstellen-Einträgen (Profil HiisDeviceDataRecorderDefinition), die ein bestimmtes MIV-Set (Mandatory Interoperable Value Set) unterstützen. Das MIV-Set wird über die Extension HiisDeviceDefinitionMivSet referenziert.

Standardablauf

1. Suchanfrage mit dem MIV-Set als Filterkriterium
2. HIIS-API liefert die gefundenen Hilfsmittelschnittstellen-Verzeichnis-Einträge zurück

API-Abfrage

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisDeviceDataRecorderDefinition&miv-set={MIV-Set-Referenz}

Beispiel (MIV-Set-URL "https://gematik.de/fhir/hddt/ValueSet/hddt-miv-continuous-glucose-measurement"):

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisDeviceDataRecorderDefinition&miv-set=https://gematik.de/fhir/hddt/ValueSet/hddt-miv-continuous-glucose-measurement

Die Suche erfolgt über den Custom Search Parameter miv-set, der auf die verschachtelte Extension HiisDeviceDefinitionMivSet.extension[mivSet].valueReference zugreift.

Suche von Hilfsmittelschnittstellen-Einträgen auf Basis des Herstellernamens

Beschreibung

Dieser Anwendungsfall beschreibt die Suche nach Hilfsmittelschnittstellen-Einträgen (Profil HiisDeviceDataRecorderDefinition) basierend auf dem Namen des Herstellers. Der Hersteller wird über manufacturerReference referenziert.

Standardablauf

1. Suchanfrage mit dem Herstellernamen als Filterkriterium
2. HIIS-API liefert die gefundenen Hilfsmittelschnittstellen-Einträge zurück

API-Abfrage

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisDeviceDataRecorderDefinition&manufacturer-name={Herstellername}

Beispiel (Herstellername "TechMed Solutions"):

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisDeviceDataRecorderDefinition&manufacturer-name=TechMed%20Solutions

Für eine Teilstringsuche (LIKE-Suche) kann der Modifier :contains verwendet werden:

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisDeviceDataRecorderDefinition&manufacturer-name:contains=TechMed

Die Suche erfolgt über den Custom Search Parameter manufacturer-name, der auf manufacturerReference.display zugreift.

Suche von Hilfsmittelschnittstellen-Einträgen auf Basis des Hilfsmittelschnittstellennamens

Beschreibung

Dieser Anwendungsfall beschreibt die Suche nach Hilfsmittelschnittstellen-Einträgen (Profil HiisDeviceDataRecorderDefinition) basierend auf dem Namen der Hilfsmittelschnittstelle. Der Name befindet sich in deviceName mit Type model-name.

Standardablauf

1. Suchanfrage mit dem Hilfsmittelschnittstellennamen als Filterkriterium
2. HIIS-API liefert die gefundenen Hilfsmittelschnittstellen-Einträge zurück

API-Abfrage

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisDeviceDataRecorderDefinition&device-name={Hilfsmittelschnittstellenname}

Beispiel (Hilfsmittelschnittstellenname "DataConnect Interface"):

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisDeviceDataRecorderDefinition&device-name=DataConnect%20Interface

Für eine Teilstringsuche (LIKE-Suche) kann der Modifier :contains verwendet werden:

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisDeviceDataRecorderDefinition&device-name:contains=DataConnect

Die Suche erfolgt über den Custom Search Parameter device-name, der auf DeviceDefinition.deviceName.where(type='model-name').name zugreift.

Abruf aller Hilfsmittelschnittstellen, die ein bestimmtes Hilfsmittel unterstützen

Beschreibung

Dieser Anwendungsfall beschreibt den Abruf aller Hilfsmittelschnittstellen-Einträge (Profil HiisDeviceDataRecorderDefinition), die ein bestimmtes Hilfsmittel (Profil HiisPersonalHealthDeviceDefinition) unterstützen. Es wird davon ausgegangen, dass das Hilfsmittel bereits durch eine vorangegangene Suchabfrage ermittelt wurde und die interne id bekannt ist. Die Beziehung wird über die Extension DeviceDefinitionLink mit der komplexen Extension relatedDevice hergestellt, wobei relation.valueCoding.code = "supports" sein muss.

Standardablauf

1. Aufruf der Operation $supporting-interfaces mit der internen id des bereits ermittelten Hilfsmittels

API-Abfrage

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition/{id}/$supporting-interfaces

Beispiel (interne id "1"):

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition/1/$supporting-interfaces

Diese Operation liefert ein Bundle vom Typ searchset mit allen Hilfsmittelschnittstellen-Ressourcen (HiisDeviceDataRecorderDefinition), die dieses Hilfsmittel unterstützen. Die Operation durchsucht alle Hilfsmittelschnittstellen und gibt nur die zurück, bei denen in der Extension DeviceDefinitionLink eine Referenz auf das angefragte Hilfsmittel existiert und relation.valueCoding.code = "supports" ist.

Die Operation benutzt keine Paginierung.

Abruf von Hilfsmittelschnittstellen-Endpunkten

Abruf aller mit einer Hilfsmittelschnittstelle verknüpften Endpunkte

Beschreibung

Dieser Anwendungsfall beschreibt den Abruf aller Endpunkt-Einträge (Profil HiisDeviceDataRecorderEndpoint), die mit einer bestimmten Hilfsmittelschnittstelle (Profil HiisDeviceDataRecorderDefinition) verknüpft sind. Es wird davon ausgegangen, dass die Hilfsmittelschnittstelle bereits durch eine vorangegangene Suchabfrage ermittelt wurde und die interne id bekannt ist. Die Verknüpfung wird über die Extension HiisDeviceDataRecorderEndpointLink hergestellt, die auf der Hilfsmittelschnittstelle definiert ist und die Endpunkte referenziert.

Standardablauf

1. Aufruf der Operation $endpoints mit der internen id der bereits ermittelten Hilfsmittelschnittstelle

API-Abfrage

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition/{id}/$endpoints

Beispiel (interne id "1"):

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition/1/$endpoints

Diese Operation liefert ein Bundle vom Typ searchset mit allen Endpunkt-Ressourcen (HiisDeviceDataRecorderEndpoint), die in der Extension HiisDeviceDataRecorderEndpointLink der Hilfsmittelschnittstelle referenziert sind.

Die Operation benutzt keine Paginierung.

Abruf von Hilfsmitteln

Suche von Hilfsmittel-Einträgen auf Basis einer MIV-Set-URL

Beschreibung

Dieser Anwendungsfall beschreibt die Suche nach Hilfsmittel-Einträgen (Profil HiisPersonalHealthDeviceDefinition), die ein bestimmtes MIV-Set (Mandatory Interoperable Value Set) unterstützen. Das MIV-Set wird über die Extension HiisDeviceDefinitionMivSet referenziert.

Standardablauf

1. Suchanfrage mit dem MIV-Set als Filterkriterium
2. HIIS-API liefert die gefundenen Hilfsmittel-Einträge zurück

API-Abfrage

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisPersonalHealthDeviceDefinition&miv-set={MIV-Set-Referenz}

Beispiel (MIV-Set-URL "https://gematik.de/fhir/hddt/ValueSet/hddt-miv-continuous-glucose-measurement"):

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisPersonalHealthDeviceDefinition&miv-set=https://gematik.de/fhir/hddt/ValueSet/hddt-miv-continuous-glucose-measurement

Die Suche erfolgt über den Custom Search Parameter miv-set, der auf die verschachtelte Extension HiisDeviceDefinitionMivSet.extension[mivSet].valueReference zugreift.

Suche von Hilfsmittel-Einträgen auf Basis des Herstellernamens

Beschreibung

Dieser Anwendungsfall beschreibt die Suche nach Hilfsmittel-Einträgen (Profil HiisPersonalHealthDeviceDefinition) basierend auf dem Namen des Herstellers. Der Hersteller wird über manufacturerReference referenziert.

Standardablauf

1. Suchanfrage mit dem Herstellernamen als Filterkriterium
2. HIIS-API liefert die gefundenen Hilfsmittel-Einträge zurück

API-Abfrage

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisPersonalHealthDeviceDefinition&manufacturer-name={Herstellername}

Beispiel (Herstellername "HealthDevice Corp"):

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisPersonalHealthDeviceDefinition&manufacturer-name=HealthDevice%20Corp

Für eine Teilstringsuche (LIKE-Suche) kann der Modifier :contains verwendet werden:

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisPersonalHealthDeviceDefinition&manufacturer-name:contains=HealthDevice

Die Suche erfolgt über den Custom Search Parameter manufacturer-name, der auf manufacturerReference.display zugreift.

Suche von Hilfsmittel-Einträgen auf Basis des Gerätenamens

Beschreibung

Dieser Anwendungsfall beschreibt die Suche nach Hilfsmittel-Einträgen (Profil HiisPersonalHealthDeviceDefinition) basierend auf dem Gerätenamen. Der Name befindet sich in deviceName mit Type model-name.

Standardablauf

1. Suchanfrage mit dem Gerätenamen als Filterkriterium
2. HIIS-API liefert die gefundenen Hilfsmittel-Einträge zurück

API-Abfrage

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisPersonalHealthDeviceDefinition&device-name={Gerätename}

Beispiel (Gerätename "Health Monitor 2000"):

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisPersonalHealthDeviceDefinition&device-name=Health%20Monitor%202000

Für eine Teilstringsuche (LIKE-Suche) kann der Modifier :contains verwendet werden:

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisPersonalHealthDeviceDefinition&device-name:contains=Health

Die Suche erfolgt über den Custom Search Parameter device-name, der auf DeviceDefinition.deviceName.where(type='model-name').name zugreift.

Kombinierte Suche von Hilfsmittel-Einträgen auf Basis des Gerätenamens, der Modellnummer oder des Gerätetyp-Codes

Beschreibung

Dieser Anwendungsfall beschreibt die kombinierte Suche nach Hilfsmittel-Einträgen (Profil HiisPersonalHealthDeviceDefinition) basierend auf Gerätenamen (deviceName mit Type model-name), Modellnummer (modelNumber) oder Gerätetyp-Code (type). Die Suche durchsucht alle drei Felder gleichzeitig.

Standardablauf

1. Suchanfrage mit Suchbegriff für Gerätenamen, Modellnummer oder Typ-Code
2. HIIS-API liefert die gefundenen Hilfsmittel-Einträge zurück

API-Abfrage

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisPersonalHealthDeviceDefinition&device-search={Suchbegriff}

Beispiel (Suchbegriff "HMX-2000"):

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisPersonalHealthDeviceDefinition&device-search=HMX-2000

Für eine Teilstringsuche (LIKE-Suche) kann der Modifier :contains verwendet werden:

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition?_profile=https://fhir.bfarm.de/StructureDefinition/HiisPersonalHealthDeviceDefinition&device-search:contains=HMX

Die Suche erfolgt über den Custom Search Parameter device-search, der auf DeviceDefinition.deviceName.where(type='model-name').name | DeviceDefinition.modelNumber | DeviceDefinition.type.coding.code zugreift.

Abruf aller Hilfsmittel, die von einer bestimmten Hilfsmittelschnittstelle unterstützt werden

Beschreibung

Dieser Anwendungsfall beschreibt den Abruf aller Hilfsmittel-Einträge (Profil HiisPersonalHealthDeviceDefinition), die von einer bestimmten Hilfsmittelschnittstelle (Profil HiisDeviceDataRecorderDefinition) unterstützt werden. Es wird davon ausgegangen, dass die Hilfsmittelschnittstelle bereits durch eine vorangegangene Suchabfrage ermittelt wurde und die interne id bekannt ist. Die Beziehung wird über die Extension DeviceDefinitionLink mit der komplexen Extension relatedDevice hergestellt, wobei relation.valueCoding.code = "supports" sein muss.

Standardablauf

1. Aufruf der Operation $supported-devices mit der internen id der bereits ermittelten Hilfsmittelschnittstelle

API-Abfrage

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition/{id}/$supported-devices

Beispiel (interne id "1"):

GET https://hiis.bfarm.de/api/fhir/v3.0/DeviceDefinition/1/$supported-devices

Diese Operation liefert ein Bundle vom Typ searchset mit allen unterstützten Hilfsmittel-Ressourcen (HiisPersonalHealthDeviceDefinition). Die Operation durchsucht die Extension DeviceDefinitionLink der Hilfsmittelschnittstelle und gibt nur die Hilfsmittel zurück, bei denen relation.valueCoding.code = "supports" ist.

Die Operation benutzt keine Paginierung.