Naar hoofdinhoud gaan
DELETE
Annuleer een afspraak door de status op cancelled te zetten. Alleen afspraken waarvan de bloedafname nog niet is bevestigd, kunnen worden geannuleerd. Het annuleren van een afspraak die al cancelled is, geeft 200 terug met die afspraak en schrijft niets weg — er wordt geen tweede annulering vastgelegd. De response bevat Idempotent-Replayed: true, zodat je een herhaling kunt onderscheiden van de aanroep die het werk deed. Een herhaling met een andere cancellation_reason geeft in plaats daarvan 409 terug: de vastgelegde reden wordt nooit overschreven. Zie Idempotentie.
Afspraken kunnen niet meer worden geannuleerd nadat de bloedafname is bevestigd — dat geeft 409 Conflict terug.
Vereist de scope appointments_schedule of appointments_manage.

Verzoek

Padparameters

string
vereist
Unieke identifier (UUID) van de te annuleren afspraak.

Bodyparameters

De body is optioneel — stuur helemaal geen body mee om te annuleren zonder een reden vast te leggen.
string
Vrije tekst als reden voor de annulering, maximaal 500 tekens (bijv. Patient no-show). Wordt opgeslagen bij de afspraak en teruggegeven als cancellation_reason bij deze en latere opvragingen.

Respons

Bij succes geeft de API 200 OK terug met de geannuleerde afspraak en het ingesloten profiel.
string
vereist
Unieke afspraak-identifier (UUID).
string
vereist
UUID van het profiel waarbij deze afspraak hoort.
string
UUID van de testlocatie waar de bloedafname plaatsvindt.
string
Geplande datum en tijd van de afspraak als UTC-tijdstip (ISO 8601 met Z-achtervoegsel, bijv. 2026-05-15T10:30:00Z). Kan null zijn.
string
vereist
Afspraakstatus. Is cancelled na een geslaagde annulering.
string
Vrije tekst als reden die is vastgelegd bij het annuleren van de afspraak (bijv. no-show, late annulering, ‘Mislukt. Herhaling vereist’). null tenzij status gelijk is aan cancelled.
string[]
vereist
E-mailadressen die elk één e-mail krijgen zodra alle labresultaten definitief zijn, in kleine letters. Leeg wanneer uitgeschakeld. Zie E-mails bij beschikbare resultaten.
string
vereist
Hoe het bloed wordt afgenomen: capillary (vingertop of bovenarm, in microtainers) of venous (uit de ader, in buisjes). Dit is de methode die de afspraak instelt, anders de default_draw_method van de locatie. Na de bloedafname is dit de methode die is gebruikt.
string
vereist
ISO 8601-tijdstempel van wanneer de afspraak is aangemaakt.
string
ISO 8601-tijdstempel van de laatste update. Kan null zijn.
object
vereist
Het patiëntprofiel dat bij deze afspraak hoort.
AppointmentPanel[]
vereist
Panels die vóór de annulering aan deze afspraak waren gekoppeld. Zoek paneldetails (naam, biomarkers) op via Panels opvragen.
AppointmentIndividualBiomarker[]
vereist
À-la-carte biomarkers die los van een panel aan deze afspraak zijn gekoppeld (zie Aangepaste biomarkers toevoegen). Zoek elke biomarker_id op via Biomarkers opvragen voor weergavegegevens.
AppointmentShipmentLink[]
vereist
Zendingen die vóór de annulering aan deze afspraak waren gekoppeld. Elke id verwijst naar Zending ophalen.
string[]
vereist
Labcodes (barcodes op de buisjes) die voor deze afspraak zijn vastgelegd, in scanvolgorde. Leeg totdat de bloedafname is bevestigd. Een veneuze bloedafname heeft één code die op elk buisje staat gedrukt; een capillaire bloedafname heeft één code per microtainer. Resultaten en documenten op Resultaten ophalen verwijzen naar deze codes via lab_code.

Foutresponsen