Hoppa till huvudinnehåll
GET
Hämta en enskild bokning för blodprovstagning med dess UUID, inklusive den inbäddade patientprofilen. Använd den här endpointen för att kontrollera bokningens status, bekräfta bokningsdetaljer eller hämta tillhörande profildata. Kräver scopet appointments_view eller appointments_schedule.

Förfrågan

Sökvägsparametrar

string
obligatorisk
Unik identifierare (UUID) för bokningen som ska hämtas.

Svar

Vid framgång returnerar API:et 200 OK med 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
Aktuell bokningsstatus. Något av pending, confirmed, blood_drawn eller cancelled. Detaljerad status för färdigställda labbresultat får du från Hämta resultat; mer detaljerad försändelsestatus från varje post i shipments-arrayen nedan vidare till Hämta försändelse.
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 för närvarande är kopplade till den här bokningen. Exkluderar avbrutna kopplingar. Slå upp paneldetaljer (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 kopplade till den här bokningen, med den äldsta kopplingen först. Tom array när inga försändelser är kopplade. Jämför varje id mot Hämta försändelse för hela försändelsens payload (status, spårningsnummer, statusuppdateringar osv.).
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.

Upprepade anrop

Aniva lagrar svaret från den här endpointen i 15 minuter för varje API-nyckel. Ett upprepat anrop inom den här tiden får det lagrade svaret så länge bokningen är oförändrad. Efter en ändring får du ett nytt svar. Headerna Cache-Status och Age visar att svaret är lagrat och hur gammalt det är. För att få reda på en ändring direkt, prenumerera på webhook-händelserna appointment.created, appointment.rescheduled och händelsen för varje status, till exempel appointment.confirmed. Se Upprepade läsningar.

Felsvar