Hoppa till huvudinnehåll
GET
Hämta en lista över bokningar för blodprovstagning. Varje bokning innehåller den inbäddade patientprofilen. Filtren kombineras:
  • date returnerar bokningarna för en kalenderdag. Dagen är den lokala dagen för respektive boknings plats, så en blodprovstagning kl. 23:30 i Berlin räknas på sitt Berlin-datum.
  • location_id returnerar bokningarna på en provtagningsplats.
  • profile_id utan date returnerar alla bokningar för den profilen, utan tidsbegränsning.
  • Utan profile_id och utan date gäller standardtidsfönstret: de senaste 2 månaderna till 1 månad framåt.
Kräver scopet appointments_view eller appointments_schedule.

Förfrågan

Frågeparametrar

string
Filtrera efter profilens UUID. När det anges returneras alla bokningar för profilen oavsett bokat datum. När det utelämnas gäller standardtidsfönstret.
string
Filtrera efter provtagningsplatsens UUID.
string
Kalenderdag i formatet YYYY-MM-DD, i tidszonen för respektive boknings plats. Ersätter standardtidsfönstret. Resultaten sorteras efter scheduled_at, tidigast först.

Svar

Vid lyckat anrop returnerar API:et 200 OK med en array med bokningsobjekt.
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 slutpunkten i 5 minuter per API-nyckel. Ett upprepat anrop inom den tiden får det lagrade svaret. 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