Query API: Practitioner

Die Query API: Practitioner ermöglicht den Abruf von Daten zu Leistungserbringer (wie Ärzt:innen oder Apotheker:innen) im Medication Service.

Nachricht

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

Auslösung

Wenn das ePA-Client-System eine Suche nach Leistungserbringenden durchführen und dazu die korrespondierenden Practitioner-Ressourcen ermitteln möchte, sendet es eine Query API: Practitioner-Nachricht an den Medication Service. Das ePA-Client-System verarbeitet die Antwort und bringt sie zur Anzeige.

Resource API

Anfragen an die Practitioner-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.

Bei Anfragen an die QueryAPI für die Practitioner-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 Practitioner-Ressource oder weitere Ressourcen im Zusammenhang mit der Abfrage enthalten können.

headerParams: - name: "x-insurantid" expectation: "MUSS" type: "string" description: "Health Record Identifier" - name: "x-useragent" expectation: "MUSS" type: "string" description: "User Agent Information" - name: "X-Request-ID" expectation: "MUSS" type: "string" description: "UUID der Nachricht" contentTypes: - "application/fhir+json" - "application/fhir+xml" responses: - statusCode: '200' description: "Successful operation" errorCode: "-" note: "-" - statusCode: '400' description: "Unknown search parameter" errorCode: "-" note: "EPAOperationOutcome" - statusCode: '400' description: "Invalid query parameter(s)" errorCode: "-" note: "EPAOperationOutcome" - statusCode: '400' description: "Invalid request" errorCode: "-" note: "EPAOperationOutcome" - statusCode: '404' description: "Unknown resource type" errorCode: "-" note: "EPAOperationOutcome" responses: - statusCode: '200' description: "Successful operation" errorCode: "-" note: "-" - statusCode: '400' description: "Invalid request" errorCode: "-" note: "EPAOperationOutcome" - statusCode: '404' description: "Unknown resource type" errorCode: "-" note: "EPAOperationOutcome" responses: - statusCode: '200' description: "Successful operation" errorCode: "-" note: "-" - statusCode: '400' description: "Invalid request" errorCode: "malformedRequest" note: "-" - statusCode: '400' description: "Invalid request" errorCode: "-" note: "EPAOperationOutcome" - statusCode: '404' description: "Unknown resource type" errorCode: "-" note: "EPAOperationOutcome" - statusCode: '404' description: "Resource is not known" errorCode: "-" note: "EPAOperationOutcome" - statusCode: '404' description: "Not found" errorCode: "-" note: "EPAOperationOutcome" - statusCode: '410' description: "Resource was deleted" errorCode: "-" note: "EPAOperationOutcome" base: "[base]" paths: /epa/medication/api/v1/fhir/Practitioner: get: include: - "#default-api" - "#default-formats" - "#query-responses" operationId: "listPractitioners_MedicationSvc" fhir: capabilityStatement: url: "CapabilityStatement-epa-medication-service-server.json" forResourceType: "Practitioner"

Verarbeitung

Der Medication Service verarbeitet die Anfrage, um die Practitioner-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 Practitioner-Ressourcen zurück.

Der Medication Service MUSS die Suchparameter der Ressource Practitioner verarbeiten können, wie sie im CapabilityStatement mit dem Namen EPAMedicationServiceServer festgelegt sind. Die Standardsortierung des Medication Service für die Ressource Practitioner MUSS anhand des Attributs _lastUpdated erfolgen. Die Reihenfolge MUSS in absteigender Sortierung (desc) sein, sodass die neuesten Daten zuerst angezeigt werden.

Resource API (Versionshistorie)

base: "[base]" paths: /epa/medication/api/v1/fhir/Practitioner/_history: get: include: - "#default-api" - "#default-formats" - "#history-response" operationId: "listPractitioners_MedicationSvc"

Instance API

Um spezifische Details zu einem einzelnen Practitioner über die RESTful API zu erhalten, kann die Practitioner Instance API verwendet werden, indem eine HTTP GET-Anfrage an den Endpunkt /Practitioner/[id] gesendet wird.

base: "[base]" paths: /epa/medication/api/v1/fhir/Practitioner/[id]: get: include: - "#default-api" - "#default-formats" - "#instance-responses" operationId: "getPractitionerById_MedicationSvc" /epa/medication/api/v1/fhir/Practitioner/[id]/_history: get: include: - "#default-api" - "#default-formats" - "#instance-responses" operationId: "getPractitionerById_MedicationSvc" /epa/medication/api/v1/fhir/Practitioner/[id]/_history/[versionId]: get: include: - "#default-api" - "#default-formats" - "#instance-responses" operationId: "getPractitionerById_MedicationSvc"

Sicherheitsanforderungen

Generelle Sicherheitsanforderungen werden hier festgehalten.