Tasks (Stand abfragen)
Die Antworten der Kliniken kommen normalerweise als Webhook, siehe Webhooks. Wer den Stand zusätzlich abfragen möchte, etwa zum Abgleich oder nach einem Ausfall des eigenen Empfängers, nutzt diesen Endpunkt.
GET /api/v2/fhir/Task?based-on=<ServiceRequest-Identifier>Authorization: Bearer <Access-Token>Parameter
Abschnitt betitelt „Parameter“| Parameter | Pflicht | Bedeutung |
|---|---|---|
based-on |
ja | Der Identifier des ServiceRequest, zu dem der Stand gesucht wird. Derselbe Wert wie in ServiceRequest.identifier der Anfrage. |
owner |
nein | Schränkt auf eine Klinik ein, angegeben als IK-Nummer. |
Fehlt based-on, antwortet der Endpunkt mit 400 Bad Request und einem OperationOutcome.
Antwort
Abschnitt betitelt „Antwort“Die Antwort ist ein Bundle vom Typ searchset, dessen Einträge die Task-Ressourcen zum aktuellen Stand enthalten.
Gibt es zu dem Identifier keine Anfrage oder keine passenden Zustände, ist die Antwort ein leeres Searchset:
{ "resourceType": "Bundle", "type": "searchset", "total": 0, "entry": []}Ein leeres Ergebnis bedeutet, dass zu diesem Identifier kein Stand vorliegt.
Dieselbe Task-Ressource liefert auch die Webhook-Zustellung, dort eingebettet in eine Nachricht statt in ein Searchset, siehe Webhooks.
| Feld | Bedeutung |
|---|---|
intent |
Immer order. |
status |
Zustand des Task selbst. |
businessStatus |
Die fachliche Aussage, siehe unten. |
basedOn |
Identifier-Referenz auf den ServiceRequest der Anfrage. |
owner |
Identifier-Referenz auf die antwortende Klinik, über ihre IK-Nummer. |
status sagt, wo der Vorgang steht, businessStatus die inhaltliche Antwort der Klinik. Beide Felder braucht es, weil ein abgeschlossener Vorgang (completed) je nach businessStatus eine Zusage oder eine Absage sein kann.
status |
businessStatus |
Bedeutung | Zusätzlich |
|---|---|---|---|
completed |
accepted |
Aufnahme zugesagt | output mit dem angebotenen Aufnahmedatum. Dieses Datum legt die Klinik frei fest und kann vom angefragten Aufnahmedatum abweichen. |
completed |
declined |
Aufnahme abgelehnt | statusReason mit dem Ablehnungsgrund |
completed |
declined-with-alternative |
Aufnahme abgelehnt, Alternative vorgeschlagen | note mit dem Alternativvorschlag |
on-hold |
question |
Rückfrage der Klinik | input mit der Frage |
on-hold |
information-requested |
Weitere Daten erforderlich | statusReason mit dem Grund |
Bei on-hold bleibt der Vorgang offen, weil der Zuweiser am Zug ist.