Hoppa till huvudinnehåll
POST
Boka en blodprovstagning för en patientprofil på en specifik provtagningsplats. När bokningen har skapats får den statusen confirmed som standard (vissa platser kan i stället ha pending som standard – det är en inställning per plats). Använd Lägg till paneler för att koppla blodprovspaneler innan du bekräftar blodprovstagningen.
En profil kan ha högst en bokning per plats och tidpunkt. Om du skapar en bokning för en tidslucka som profilen redan har returneras 409 med befintligt appointment_id i stället för en andra bokning – så ett nytt försök eller en oavsiktligt upprepad begäran kan aldrig skapa en dubblettbokning. Se Dubblettbokningar.
Skicka med en valfri Idempotency-Key-header så att anropet säkert kan upprepas – om samma nyckel skickas igen returneras det ursprungliga svaret i stället för att en andra bokning skapas. Se Idempotens. Kräver scopet appointments_schedule.

Förfrågan

Body-parametrar

string
obligatorisk
UUID för patientprofilen som bokningen ska skapas för.
string
obligatorisk
UUID för provtagningsplatsen där blodprovstagningen ska ske. Använd Lista platser för att hitta tillgängliga plats-ID:n.
string
obligatorisk
Datum och tid för bokningen i ISO 8601-format (t.ex. 2026-05-15T10:30:00Z eller 2026-05-15T12:30:00+02:00). Måste innehålla en tidszonsangivelse – antingen Z eller en uttrycklig förskjutning som +02:00; datum och tider utan tidszon avvisas. Måste ligga i framtiden.Måste vara en exakt starttid i platsens tidsschema, och tidsluckan måste fortfarande ha ledig kapacitet – läs Hämta tillgänglighet först. Tider utanför schemat returnerar 400; en fullbokad tidslucka returnerar 409. På platser som drivs av Aniva måste tiden också ligga minst 12 timmar framåt – se Minsta framförhållning.
string[]
Upp till 5 adresser som vardera får ett mejl när alla labbresultat är klara. Mejlet länkar till resultatsidan i Anivas adminpanel. Din nyckel behöver behörigheten results_view för patienten, annars returneras 403. Utelämna fältet för att använda standardadresserna för patientens grupp. En tom lista stänger av mejlen. Se Mejl när resultat är klara.
string
Hur blodprovstagningen görs: capillary eller venous. Utelämna fältet för att använda platsens default_draw_method. Platsen måste ange metoden i sina draw_methods, annars returneras 400.

Svar

Om begäran lyckas returnerar API:et 201 Created med den nya bokningen.
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.
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. Tom för nyskapade bokningar – koppla via Lägg till paneler. 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. Tom för nyskapade bokningar – koppla via Lägg till enskilda biomarkörer. Matcha varje biomarker_id mot Lista biomarkörer för visningsdata.
AppointmentShipmentLink[]
obligatorisk
Försändelser som är kopplade till den här bokningen, äldsta kopplingen först. Tom för nyskapade bokningar – koppla via Skapa försändelse (med appointment_id) eller Koppla bokningar till försändelse.
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.

Minsta framförhållning

Bokningar på platser som drivs av Aniva måste göras minst 12 timmar i förväg; bokar du inom det tidsfönstret returneras 400. Hämta tillgänglighet döljer redan de tidsluckorna, så allt du läser från det schemat går att boka. Platser som du driver själv har ingen minsta framförhållning – bokning samma dag och drop-in är oförändrat.

Dubblettbokningar

En profil kan ha högst en icke-avbokad bokning per plats och tidpunkt – en person kan inte ta blodprov två gånger på samma plats vid samma tidpunkt, oavsett hur många stolar platsen har. Om du skapar en bokning för en tidslucka som profilen redan har returneras 409 med ett appointment_id som anger den bokning som redan finns:
Hantera det genom att behandla begäran som redan genomförd: hämta bokningen med Hämta bokning, flytta den med Uppdatera bokning eller ta bort den med Avbryt bokning. Försök inte skapa bokningen igen – det kommer att fortsätta returnera 409. Det gör upprepade skapanden säkra: en begäran som du skickar igen efter en timeout, eller ett formulär som skickats två gånger, kan inte skapa två bokningar för samma patient vid samma tidpunkt.
appointment_id finns bara med vid dubblett-409. Kapacitets-409 – tidsluckan är full eftersom andra patienter har bokat den – returnerar bara error, och rätt åtgärd då är att välja en annan tidslucka från Hämta tillgänglighet.

Felsvar