Implementation Guide
ePA Medication Service
Version 1.0.5-ballot.1 - draft

Query API: Medication (Medikation)

Die Query API: Medication ermöglicht den Abruf von Medikationsdaten eines Versicherten im Medication Service.

Nachricht

Die Nachricht zum Abruf von Medikationsdaten wird als HTTP GET-Anfrage an den Medication Service gesendet, um eine Liste der hinterlegten Medication-Instanzen abzurufen.

Auslösung

Wenn das ePA-Client-System eine Suche nach Medikationsdaten durchführen und dazu die korrespondierenden Medication-Ressourcen ermitteln möchte, sendet es eine Query API: Medication-Nachricht an den Medication Service.

Resource API

Anfragen an die Medication-Ressource können über die RESTful API mittels HTTP GET-Anfragen durchgeführt werden. Dabei können spezifische Suchparameter genutzt werden, um die Anfragen zu verfeinern. Zum Beispiel:

  • Durch die Verwendung von ?code=[code] kann nach Medikationen gesucht werden, die einem bestimmten Code entsprechen.
  • Die Verwendung von ?status=active kann genutzt werden, um nur aktive Medikationen zu suchen.

Bei Anfragen an die QueryAPI für die Medication-Ressource wird die Antwort als ein FHIR Bundle des Typs searchset zurückgegeben. Dieses Bundle enthält eine Sammlung von Einträgen, die jeweils eine Instanz der Medication-Ressource oder weitere Ressourcen im Zusammenhang mit der Abfrage enthalten können.

Der Medication Service MUSS die Suchparameter der Ressource Medication verarbeiten können, wie sie im CapabilityStatement mit dem Namen EPAMedicationServiceServer festgelegt sind. Die Standardsortierung des Medication Service für die Ressource Medication MUSS anhand des Attributs _lastUpdated erfolgen.

Instance API

Um spezifische Details zu einer einzelnen Medication-Instanz mittels der RESTful API zu erhalten, wird die Medication Instance API verwendet, indem eine HTTP GET-Anfrage an den Endpunkt /Medication/[id] gestellt wird.

Verarbeitung

Der Medication Service verarbeitet die Anfrage, um die _Medication-Einträge zu ermitteln, die den angegebenen Suchparametern entsprechen. Darüber hinaus gibt er einen zur Verarbeitung passenden HTTP Status Code sowie ein FHIR Bundle der passenden Medication-Ressourcen zurück.

Sicherheitsanforderungen

Generelle Sicherheitsanforderungen werden hier festgehalten.