Naar hoofdinhoud gaan
GET
Haal één afspraak voor een bloedafname op via de UUID, inclusief het ingesloten patiëntprofiel. Gebruik dit endpoint om de status van de afspraak te controleren, planningsgegevens te bevestigen of de bijbehorende profielgegevens op te halen. Vereist de scope appointments_view of appointments_schedule.

Verzoek

Padparameters

string
vereist
Unieke identifier (UUID) van de afspraak die je wilt ophalen.

Respons

Bij succes retourneert de API 200 OK met de 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
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.
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 momenteel aan deze afspraak zijn gekoppeld. Geannuleerde koppelingen zijn uitgesloten. Zoek details van een panel (naam, biomarkers) op via Panels weergeven.
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 aan deze afspraak zijn gekoppeld, met de oudste koppeling eerst. Lege array als er geen zendingen zijn gekoppeld. Zoek elke id op via Zending ophalen voor de volledige payload van de zending (status, trackingnummer, statusupdates enz.).
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.

Herhaalde aanroepen

Aniva bewaart het antwoord van dit endpoint 15 minuten per API-sleutel. Een herhaalde aanroep binnen deze tijd krijgt het bewaarde antwoord zolang de afspraak ongewijzigd is. Na een wijziging krijg je een nieuw antwoord. De headers Cache-Status en Age laten zien dat het antwoord bewaard is en hoe oud het is. Om direct op de hoogte te zijn van een wijziging, abonneer je je op de webhook-events appointment.created, appointment.rescheduled en het event van elke status, bijvoorbeeld appointment.confirmed. Zie Herhaald ophalen.

Foutresponsen