Zum Hauptinhalt springen
DELETE
Storniere einen Termin, indem du seinen Status auf cancelled setzt. Nur Termine, deren Blutabnahme noch nicht bestätigt wurde, können storniert werden. Das Stornieren eines Termins, der bereits cancelled ist, gibt 200 mit diesem Termin zurück und schreibt nichts – es wird keine zweite Stornierung erfasst. Die Antwort enthält Idempotent-Replayed: true, damit du eine Wiederholung von dem Aufruf unterscheiden kannst, der die Aktion ausgeführt hat. Eine Wiederholung mit einem anderen cancellation_reason gibt stattdessen 409 zurück: Der erfasste Grund wird nie überschrieben. Siehe Idempotenz.
Termine können nach Bestätigung der Blutabnahme nicht mehr storniert werden – das gibt 409 Conflict zurück.
Erfordert den Scope appointments_schedule oder appointments_manage.

Anfrage

Pfadparameter

string
erforderlich
Eindeutige Kennung (UUID) des zu stornierenden Termins.

Body-Parameter

Der Body ist optional – sende gar keinen Body, um ohne Angabe eines Grundes zu stornieren.
string
Freitextgrund für die Stornierung, bis zu 500 Zeichen (z. B. Patient no-show). Wird am Termin gespeichert und bei diesem sowie späteren Lesevorgängen als cancellation_reason zurückgegeben.

Antwort

Bei Erfolg gibt die API 200 OK mit dem stornierten Termin und dem eingebetteten Profil zurück.
string
erforderlich
Eindeutige Terminkennung (UUID).
string
erforderlich
UUID des Profils, zu dem dieser Termin gehört.
string
UUID des Teststandorts, an dem die Blutabnahme stattfindet.
string
Geplanter Terminzeitpunkt in UTC (ISO 8601 mit Z-Suffix, z. B. 2026-05-15T10:30:00Z). Kann null sein.
string
erforderlich
Terminstatus. Ist nach einer erfolgreichen Stornierung cancelled.
string
Freitextgrund, der bei der Stornierung des Termins erfasst wurde (z. B. Nichterscheinen, späte Stornierung, ‘Fehlgeschlagen. Wiederholung erforderlich’). null, sofern status nicht cancelled ist.
string[]
erforderlich
Adressen in Kleinbuchstaben, die jeweils eine E-Mail erhalten, sobald alle Laborergebnisse final sind. Leer, wenn deaktiviert. Siehe E-Mails bei fertigen Ergebnissen.
string
erforderlich
Art der Blutabnahme: capillary (aus der Fingerkuppe oder dem Oberarm, in Microtainer) oder venous (aus der Vene, in Röhrchen). Entspricht der im Termin festgelegten Methode, sonst der default_draw_method des Standorts. Nach der Blutabnahme ist es die verwendete Methode.
string
erforderlich
ISO-8601-Zeitstempel der Erstellung des Termins.
string
ISO-8601-Zeitstempel der letzten Aktualisierung. Kann null sein.
object
erforderlich
Das mit diesem Termin verknüpfte Patientenprofil.
AppointmentPanel[]
erforderlich
Panels, die vor der Stornierung mit diesem Termin verknüpft waren. Rufe Panel-Details (Name, Biomarker) über Panels auflisten ab.
AppointmentIndividualBiomarker[]
erforderlich
Einzel-Biomarker, die außerhalb eines Panels mit diesem Termin verknüpft sind (siehe Eigene Biomarker hinzufügen). Gleiche jede biomarker_id für Anzeigedaten mit Biomarker auflisten ab.
AppointmentShipmentLink[]
erforderlich
Sendungen, die vor der Stornierung mit diesem Termin verknüpft waren. Jede id verweist auf Sendung abrufen.
string[]
erforderlich
Laborcodes (Röhrchen-Barcodes), die für diesen Termin erfasst wurden, in Scan-Reihenfolge. Leer, bis die Blutabnahme bestätigt wird. Eine venöse Blutabnahme hat einen Code, der auf jedem Röhrchen steht; eine kapillare Blutabnahme hat einen Code pro Microtainer. Ergebnisse und Dokumente unter Ergebnisse abrufen verweisen über lab_code auf diese Codes.

Fehlerantworten