Naar hoofdinhoud gaan
POST
Plan een afspraak voor een bloedafname voor een patiëntprofiel op een specifieke testlocatie. Zodra de afspraak is aangemaakt, krijgt deze standaard de status confirmed (bij sommige locaties kan dit standaard pending zijn — dit is een instelling per locatie). Gebruik Panels toevoegen om bloedtestpanels te koppelen voordat je de bloedafname bevestigt.
Een profiel kan maximaal één afspraak per locatie en tijdstip hebben. Als je een afspraak aanmaakt voor een tijdslot dat het profiel al bezet houdt, krijg je een 409 met het bestaande appointment_id in plaats van een tweede afspraak — zo kan een opnieuw verzonden of per ongeluk herhaald verzoek nooit een dubbele boeking maken. Zie Dubbele afspraken.
Stuur een optionele Idempotency-Key-header mee om het aanmaken veilig opnieuw te kunnen proberen — bij herhaling van dezelfde sleutel krijg je de oorspronkelijke respons terug in plaats van een tweede aan te maken. Zie Idempotentie. Vereist de scope appointments_schedule.

Verzoek

Bodyparameters

string
vereist
UUID van het patiëntprofiel waarvoor je de afspraak aanmaakt.
string
vereist
UUID van de testlocatie waar de bloedafname plaatsvindt. Gebruik Locaties weergeven om beschikbare locatie-ID’s te vinden.
string
vereist
Datum en tijd van de afspraak in ISO 8601-formaat (bijv. 2026-05-15T10:30:00Z of 2026-05-15T12:30:00+02:00). Moet een tijdzoneaanduiding bevatten — Z of een expliciete offset zoals +02:00; datum-tijdwaarden zonder tijdzone worden afgewezen. Moet in de toekomst liggen.Moet exact samenvallen met de starttijd van een tijdslot in het rooster van de locatie, en het tijdslot moet nog ruimte hebben — bekijk eerst Beschikbaarheid ophalen. Tijden buiten het rooster geven 400 terug; een vol tijdslot geeft 409 terug. Op locaties die door Aniva worden beheerd, moet dit bovendien minimaal 12 uur van tevoren zijn — zie Minimale boekingstermijn.
string[]
Maximaal 5 adressen die elk één e-mail krijgen zodra alle labresultaten definitief zijn. De e-mail linkt naar de resultatenpagina in het Aniva-adminpanel. Je sleutel heeft results_view-toegang tot de patiënt nodig, anders volgt 403. Laat dit veld weg om de standaardadressen van de groep van de patiënt te gebruiken. Een lege lijst zet de e-mails uit. Zie E-mails wanneer resultaten klaarstaan.
string
Hoe het bloed wordt afgenomen: capillary of venous. Laat dit veld weg om de default_draw_method van de locatie te gebruiken. De methode moet in draw_methods van de locatie staan, anders volgt 400.

Respons

Bij succes geeft de API 201 Created terug met de nieuwe afspraak.
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
Huidige status van de afspraak. Een van pending, confirmed, blood_drawn of cancelled. De gedetailleerde voortgang van labresultaten leid je af uit Resultaten ophalen; de verdere voortgang van zendingen uit elk item in de inline shipments-array (zie hieronder) door deze op te vragen via Zending ophalen.
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.
object
vereist
Het patiëntprofiel dat bij deze afspraak hoort.
AppointmentPanel[]
vereist
Panels die momenteel aan deze afspraak zijn gekoppeld. Leeg voor nieuw aangemaakte afspraken — koppel ze via Panels toevoegen. Zoek paneldetails (naam, biomarkers) op via Panels weergeven.
AppointmentIndividualBiomarker[]
vereist
Losse biomarkers die buiten een panel om aan deze afspraak zijn gekoppeld. Leeg voor nieuw aangemaakte afspraken — koppel ze via Individuele biomarkers toevoegen. Vergelijk elk biomarker_id met Biomarkers weergeven voor weergavegegevens.
AppointmentShipmentLink[]
vereist
Zendingen die aan deze afspraak zijn gekoppeld, oudste koppeling eerst. Leeg voor nieuw aangemaakte afspraken — koppel ze via Zending aanmaken (met appointment_id) of Afspraken aan zending koppelen.
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.

Minimale boekingstermijn

Afspraken op locaties die door Aniva worden beheerd, moeten minimaal 12 uur van tevoren worden geboekt; boeken binnen die termijn geeft 400 terug. Beschikbaarheid ophalen laat die tijdslots al weg, dus alles wat je in dat rooster ziet is boekbaar. Locaties die je zelf beheert hebben geen minimale boekingstermijn — boeken op dezelfde dag en bij inloop blijft ongewijzigd.

Dubbele afspraken

Een profiel kan maximaal één niet-geannuleerde afspraak per locatie en tijdstip hebben — bij één persoon kan niet twee keer tegelijk op dezelfde plek bloed worden afgenomen, hoeveel stoelen de locatie ook heeft. Als je een afspraak aanmaakt voor een tijdslot dat het profiel al bezet houdt, krijg je een 409 terug met een appointment_id dat de al bestaande afspraak aangeeft:
Verwerk dit door het verzoek als al uitgevoerd te beschouwen: haal de afspraak op met Afspraak ophalen, verplaats deze met Afspraak bijwerken of annuleer deze met Afspraak annuleren. Probeer het aanmaken niet opnieuw — dit blijft 409 teruggeven. Dit maakt herhaald aanmaken veilig: een verzoek dat je na een time-out opnieuw verstuurt, of een dubbel ingediend formulier, kan geen twee afspraken voor dezelfde patiënt op hetzelfde tijdstip opleveren.
appointment_id is alleen aanwezig bij de 409 voor een dubbele afspraak. De 409 voor capaciteit — het tijdslot is vol omdat andere patiënten het bezet houden — geeft alleen error terug, en de juiste oplossing is dan om een ander tijdslot te kiezen uit Beschikbaarheid ophalen.

Foutresponsen