Terminbuchung absagen
Inhalt
Beschreibung und fachlicher Kontext
Beim Absagen einer Terminbuchung handelt es sich um eine custom operation in FHIR.
Mit dieser Operation kann eine bestehende Terminbuchung über den 116117 Terminservice abgesagt werden. Eine Absage kann nur mit dem zur Terminbuchung gehörenden Vermittlungscode durchgeführt werden.
Voraussetzung ist demnach ein gültiger Vermittlungscode mit dem Status active (gebucht). Das heißt, 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 zurück.
War die Terminabsage erfolgreich, kann im Anschluss eine neue Terminsuche und -buchung 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 Vermittlungscodestatus') ausgeführt werden.
FHIR-Operation
| Name | KBV_OD_KV_DIGITAL_TS_KVEN_Appointment_Cancellation |
|---|---|
| Type | OperationDefinition |
| Kind | operation |
| Code | termin_absagen |
| Canonical URL | https://fhir.kbv.de/OperationDefinition/KBV_OD_KV_DIGITAL_TS_KVEN_Appointment_Cancellation |
Invocations
URL: [base]/$termin_absagen
Parameters (In)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| vermittlungscode | 1..1 | canonical(KBV_PR_KV_DIGITAL_TS_KVEN_Identifier_Vermittlungscode) | Der Vermittlungscode, der ursprünglich für die Buchung des abzusagenden Termins genutzt wurde, ist eine 12-stellige alphanumerische Folge. |
BITTE BEACHTEN: Diese Operation hat keinen Output-Parameter. Im Erfolgsfall kommt also eine Antwort ohne Response Body zurück. Im Fehlerfall kann dennoch ein OperationOutcome im Response Body zurückkommen.
Request
Die FHIR-Operation zum Absagen einer Terminbuchung erfordert einen POST-Request.
Der Eingabeparameter für diese FHIR-Operation muss als Parameters-Ressource im Request Body übergeben werden (siehe hierzu Abschnitt Request Body
).
| HTTP Method | POST |
| URL | https://terminefuerkven.eterminservice.kv-safenet.de/terminefuerkven/api/v1/$termin_absagen |
| Request Body | [parameters] |
Request Header
Folgende Request Header werden von den Systemen des 116117 Terminservices unterstützt und verarbeitet:
| Header | Verpflichtend? | Beschreibung | Wert |
|---|---|---|---|
Authorization |
ja | Im Authentisierungsverfahren erhaltener ACCESS_TOKEN als Bearer Token | Bearer ey... |
Content-Type |
nein | Gibt den ursprünglichen Medien- bzw. Dateitypen der Ressource an.
|
application/fhir+xml |
Request Body
Der Request Body muss eine Parameters-Ressource mit dem Eingabeparameter vermittlungscode enthalten.
Der Vermittlungscode ist ohne Bindestriche anzugeben. Das heißt, er muss aus exakt 12 alphanumerischen Zeichen bestehen. Erlaubt sind alle Großbuchstaben (A-Z) und Zahlen (0-9) mit folgenden Ausnahmen: O 0 I 1 E 3
Eine ausführliche Beschreibung des Parameters-Profils ist hier in der offiziellen HL7-Dokumentation zu finden.
Beispiel
Alle Beispiele für den Request Body (Parameters-Ressource) sind hier im vorliegenden Projekt zu finden.
# Request
POST https://terminefuerkven.eterminservice.kv-safenet.de/terminefuerkven/api/v1/$termin_absagen
Content-Type: application/fhir+xml
Response
Die FHIR-Operation gibt bei Erfolg nur den HTTP-Statuscode 200 OK zurück.
Im Fehlerfall wird ein dem Fehler entsprechender HTTP-Statuscode (bspw. 400 Bad Request oder 500 Internal Server Error) und ggf. ein OperationOutcome im Response Body zurückgegeben. Das OperationOutcome enthält Details zum aufgetretenen Fehler.
Response Header
Es werden KEINE spezifischen Response Header von den Systemen des 116117 Terminservices gesetzt.
Response Body
Im Erfolgsfall wird KEIN Response Body zurückgegeben.
Im Fehlerfall kann im Response Body ein OperationOutcome enthalten sein. Details hierzu sind auf der Seite Fehler (OperationOutcome) zu finden.
Bitte beachten: Es gibt HTTP-Statuscodes, bei denen im Response Body kein OperationOutcome enthalten ist. Nähere Informationen dazu sind auf der Seite FAQ zu finden.
Beispiele
Alle Beispiele für den Response Body im Fehlerfall (OperationOutcome-Ressource) sind hier im vorliegenden Projekt zu finden.