Terminbuchung absagen
Beschreibung und fachlicher Kontext
Mit dieser Operation kann im 116117 Terminservice eine bestehende Terminbuchung abgesagt werden. Eine Absage kann nur mit dem zur Terminbuchung gehörigen Vermittlungscode durchgeführt werden.
Voraussetzung ist ein gültiger Vermittlungscode mit dem Status active (gebucht), d.h., es muss eine nicht abgesagte Buchung zu diesem Vermittlungscode vorliegen. Außerdem muss die Terminbuchung, die abgesagt werden soll, in der Zukunft liegen. Andernfalls gibt die Operation einen Fehler (OperationOutcome) zurück.
War die Terminabsage erfolgreich, kann im Anschluss eine neue Terminsuche und Terminbuchung mit diesem Vermittlungscode ausgeführt werden.
Bitte beachten: Für die Absage einer Terminbuchung durch den Patienten gibt es ein Limit. Die Absage der ersten Terminbuchung, die mit einem Vermittlungscode durchgeführt wurde, hat keine Auswirkung; bucht der Patient jedoch ein zweites Mal einen freien Terminslot mit diesem Vermittlungscode und sagt auch diese Buchung ab, verfällt der Anspruch auf eine Vermittlung durch den 116117 Terminservice für den genutzten Vermittlungscode. In diesem Fall kann keine andere Operation mit diesem Vermittlungscode (außer das Abrufen des Status') ausgeführt werden.
FHIR-Operation
| Name | KBV_OD_KV_DIGITAL_TS_DRITTE_Appointment_Cancellation |
|---|---|
| Type | OperationDefinition |
| Kind | operation |
| Code | termin_absagen |
| Canonical URL | https://fhir.kbv.de/OperationDefinition/KBV_OD_KV_DIGITAL_TS_DRITTE_Appointment_Cancellation |
Invocations
URL: [base]/$termin_absagen
Parameters (In)
| Name | Cardinality | Type | Documentation |
| vermittlungscode | 1..1 | canonical(KBV_PR_KV_DIGITAL_TS_DRITTE_Identifier_Vermittlungscode) | Der Vermittlungscode (ohne Bindestriche!), der ursprünglich für die Buchung des abzusagenden Termins genutzt wurde. Bei der Buchung überweisungsfreier Termine wird im Hintergrund ein neuer Vermittlungscode für diese Buchung erzeugt; für die Absage solcher Termine muss daher ebenfalls ein Vermittlungscode angegeben werden. |
BITTE BEACHTEN: Diese Operation hat keinen Output-Parameter. Somit kommt bei erfolgreicher Terminabsage eine leere Response zurück (d.h., der Response Body enthält keinerlei Daten). Entscheidend ist daher der HTTP-Status-Code: wenn der Status 200 OK zurückkommt, wurde der Termin erfolgreich abgesagt.
Anmerkungen
Im Fehlerfall wird ein Fehler (OperationOutcome) mit Details zum aufgetretenen Fehler zurückgegeben.
In der folgenden Tabelle finden sich zudem weitere Anmerkungen zu einzelnen Parametern:
| Parameter | Art | Anmerkung |
|---|---|---|
vermittlungscode |
in |
Der Vermittlungscode ist ohne Bindestriche anzugeben, d.h., er muss aus exakt 12 alphanumerischen Zeichen. Erlaubt sind alle Großbuchstaben (A-Z) und Zahlen (0-9) mit folgenden Ausnahmen: Documentation dieses Parameters fehlerhaft. Bei der Buchung überweisungsfreier Termine wird im Hintergrund ein neuer Vermittlungscode für diese Buchung erzeugt [...]- dies ist im 116117 Terminservice zwar möglich, gilt aber nicht für die Terminschnittstelle für Dritte! Um eine Terminbuchung über selbige durchführen zu können, wird immer ein Vermittlungscode benötigt. D.h., es muss initial immer ein Vermittlungscode angefragt werden, um im Anschluss eine Terminsuche und -buchung vornehmen zu können. |
Beispiele
Alle Beispiele für den Request Body (Parameter) finden sich hier im vorliegenden Projekt.
Beispiele für den Fehlerfall sind auf der Seite Fehler (OperationOutcome) zu finden.
<Parameters xmlns="http://hl7.org/fhir"> <parameter> <name value="vermittlungscode" /> <valueIdentifier> <system value="https://fhir.kbv.de/NamingSystem/KBV_NS_KV_DIGITAL_TS_DRITTE_Vermittlungscode" /> <value value="XN6XF4UPZ5KP" /> </valueIdentifier> </parameter> </Parameters>