Hoppa till huvudinnehåll
DELETE
Avboka en bokning genom att sätta dess status till cancelled. Endast bokningar där blodprovstagningen ännu inte har bekräftats kan avbokas. Att avboka en bokning som redan är cancelled returnerar 200 med den bokningen och skriver ingenting — ingen andra avbokning registreras. Svaret innehåller Idempotent-Replayed: true så att du kan skilja en upprepning från anropet som gjorde jobbet. En upprepning som har en annan cancellation_reason returnerar 409 i stället: den registrerade orsaken skrivs aldrig över. Se Idempotens.
Bokningar kan inte avbokas efter att blodprovstagningen har bekräftats — då returneras 409 Conflict.
Kräver scopet appointments_schedule eller appointments_manage.

Förfrågan

Sökvägsparametrar

string
obligatorisk
Unik identifierare (UUID) för bokningen som ska avbokas.

Body-parametrar

Bodyn är valfri — skicka ingen body alls för att avboka utan att registrera en orsak.
string
Orsak till avbokningen i fritext, upp till 500 tecken (t.ex. Patient no-show). Sparas på bokningen och returneras som cancellation_reason vid denna och senare läsningar.

Svar

Om anropet lyckas returnerar API:et 200 OK med den avbokade bokningen och dess inbäddade profil.
string
obligatorisk
Unik identifierare för bokningen (UUID).
string
obligatorisk
UUID för den profil som bokningen tillhör.
string
UUID för provtagningsstället där blodprovstagningen sker.
string
Planerat datum och tid för bokningen i UTC (ISO 8601 med Z-suffix, t.ex. 2026-05-15T10:30:00Z). Kan vara null.
string
obligatorisk
Bokningens status. Blir cancelled efter en lyckad avbokning.
string
Orsak i fritext som registrerades när bokningen avbokades (t.ex. uteblivet besök, sen avbokning, ‘Misslyckades. Behöver göras om’). null om inte status är cancelled.
string[]
obligatorisk
Adresser som var och en får ett mejl när alla labbresultat är slutgiltiga, i gemener. Tom när funktionen är avstängd. Se Mejl när resultat är klara.
string
obligatorisk
Hur blodet tas: capillary (fingertopp eller överarm, i mikrorör) eller venous (från ven, i provrör). Det är metoden som bokningen anger, annars default_draw_method för dess provtagningsställe. Efter blodprovstagningen är det den metod som användes.
string
obligatorisk
ISO 8601-tidsstämpel för när bokningen skapades.
string
ISO 8601-tidsstämpel för den senaste uppdateringen. Kan vara null.
object
obligatorisk
Patientprofilen som är kopplad till den här bokningen.
AppointmentPanel[]
obligatorisk
Paneler som var kopplade till den här bokningen före avbokningen. Slå upp panelinformation (namn, biomarkörer) via Lista paneler.
AppointmentIndividualBiomarker[]
obligatorisk
Enskilda biomarkörer som är kopplade till den här bokningen utanför någon panel (se Lägg till anpassade biomarkörer). Korsreferera varje biomarker_id mot Lista biomarkörer för visningsdata.
AppointmentShipmentLink[]
obligatorisk
Försändelser som var länkade till den här bokningen före avbokningen. Varje id korsrefererar till Hämta försändelse.
string[]
obligatorisk
Labbkoder (rörens streckkoder) som registrerats för den här bokningen, i skanningsordning. Tom tills blodprovstagningen är bekräftad. En venös blodprovstagning har en kod tryckt på varje provrör; en kapillär blodprovstagning har en kod per mikrorör. Resultat och dokument i Hämta resultat refererar till dessa koder via lab_code.

Felsvar