Siirry pääsisältöön
POST
Varaa verinäytteenoton ajanvaraus potilasprofiilille tiettyyn testaustoimipisteeseen. Kun ajanvaraus on luotu, se saa oletuksena tilan confirmed (joissakin toimipisteissä oletustila voi sen sijaan olla pending — tämä on toimipistekohtainen asetus). Liitä verikoepaneelit kutsulla Lisää paneelit ennen verinäytteenoton vahvistamista.
Profiililla voi olla enintään yksi ajanvaraus toimipistettä ja ajankohtaa kohden. Ajanvarauksen luominen ajankohdalle, jonka profiili on jo varannut, palauttaa vastauksen 409 ja olemassa olevan appointment_id-tunnisteen toisen ajanvarauksen sijaan — joten uudelleen yritetty tai vahingossa toistettu pyyntö ei voi koskaan luoda kaksoisvarausta. Katso Päällekkäiset ajanvaraukset.
Lähetä valinnainen Idempotency-Key-otsikko, jotta luontipyynnön voi yrittää turvallisesti uudelleen — saman avaimen toistaminen palauttaa alkuperäisen vastauksen toisen luomisen sijaan. Katso Idempotenssi. Vaatii scope-oikeuden appointments_schedule.

Pyyntö

Runkoparametrit

string
vaadittu
Sen potilasprofiilin UUID, jolle ajanvaraus luodaan.
string
vaadittu
Sen testaustoimipisteen UUID, jossa verinäytteenotto tehdään. Hae saatavilla olevien toimipisteiden tunnisteet kutsulla Listaa toimipisteet.
string
vaadittu
Ajanvarauksen päivämäärä ja kellonaika ISO 8601 -muodossa (esim. 2026-05-15T10:30:00Z tai 2026-05-15T12:30:00+02:00). Aikavyöhykemerkintä on pakollinen — joko Z tai nimenomainen aikavyöhyke-ero kuten +02:00; aikavyöhykkeettömät ajankohdat hylätään. Ajankohdan on oltava tulevaisuudessa.Ajankohdan on oltava tarkka alkamisaika toimipisteen ajanvarausaikataulussa, ja ajassa on oltava vielä tilaa — tarkista ensin Hae saatavuus. Aikataulun ulkopuoliset ajat palauttavat 400; täyteen varattu aika palauttaa 409. Anivan ylläpitämissä toimipisteissä ajankohdan on oltava myös vähintään 12 tunnin päässä — katso Vähimmäisennakkoaika.
string[]
Enintään 5 osoitetta, joista kukin saa yhden sähköpostin, kun kaikki laboratoriotulokset ovat valmiit. Sähköpostissa on linkki tulossivulle Anivan hallintapaneelissa. Avaimesi tarvitsee results_view-oikeuden potilaaseen, muutoin palautetaan 403. Jätä kenttä pois, jos haluat käyttää potilaan ryhmälle asetettuja oletusosoitteita. Tyhjä lista poistaa sähköpostit käytöstä. Katso Sähköpostit valmiista tuloksista.
string
Verinäytteenottotapa: capillary tai venous. Jätä kenttä pois, jos haluat käyttää toimipisteen default_draw_method-arvoa. Menetelmän on oltava toimipisteen draw_methods-listassa, muutoin palautetaan 400.

Vastaus

Onnistuessaan API palauttaa 201 Created ja uuden ajanvarauksen.
string
vaadittu
Ajanvarauksen yksilöllinen tunniste (UUID).
string
vaadittu
Sen profiilin UUID, johon tämä ajanvaraus kuuluu.
string
Sen testipaikan UUID, jossa verinäytteenotto tehdään.
string
Ajanvarauksen sovittu päivämäärä ja aika UTC-hetkenä (ISO 8601 ja Z-pääte, esim. 2026-05-15T10:30:00Z). Voi olla null.
string
vaadittu
Ajanvarauksen nykyinen tila. Jokin arvoista pending, confirmed, blood_drawn tai cancelled. Laboratoriotulosten tarkempi valmistumistila saadaan kutsusta Hae tulokset; lähetyksen tarkempi eteneminen kunkin shipments-taulukon alkion (katso alla) kautta kutsusta Hae lähetys.
string
Vapaamuotoinen syy, joka kirjattiin ajanvarauksen perumisen yhteydessä (esim. saapumatta jääminen, myöhäinen peruminen, “Epäonnistui. Uusinta tarvitaan”). null, ellei status ole cancelled.
string[]
vaadittu
Osoitteet pienillä kirjaimilla, joista jokainen saa yhden sähköpostin kaikkien laboratoriotulosten valmistuttua. Tyhjä, kun toiminto on pois päältä. Katso Tulokset valmiit -sähköpostit.
string
vaadittu
Verinäytteenottotapa: capillary (sormenpäästä tai olkavarresta mikroputkiin) tai venous (laskimosta putkiin). Se on ajanvaraukselle asetettu tapa tai muutoin sen toimipisteen default_draw_method. Verinäytteenoton jälkeen se on käytetty tapa.
object
vaadittu
Tähän ajanvaraukseen liitetty potilasprofiili.
AppointmentPanel[]
vaadittu
Tähän ajanvaraukseen tällä hetkellä liitetyt paneelit. Tyhjä vasta luoduille ajanvarauksille — liitä kutsulla Lisää paneelit. Hae paneelien tiedot (nimi, biomarkkerit) kutsulla Listaa paneelit.
AppointmentIndividualBiomarker[]
vaadittu
Yksittäiset biomarkkerit, jotka on liitetty tähän ajanvaraukseen paneelien ulkopuolelta. Tyhjä vasta luoduille ajanvarauksille — liitä kutsulla Lisää yksittäisiä biomarkkereita. Hae kunkin biomarker_id-tunnisteen näyttötiedot kutsun Listaa biomarkkerit avulla.
AppointmentShipmentLink[]
vaadittu
Tähän ajanvaraukseen linkitetyt lähetykset, vanhin linkitys ensin. Tyhjä vasta luoduille ajanvarauksille — linkitä kutsulla Luo lähetys (parametrilla appointment_id) tai Liitä ajanvaraukset lähetykseen.
string[]
vaadittu
Tälle ajanvaraukselle kirjatut laboratoriokoodit (putkien viivakoodit) skannausjärjestyksessä. Tyhjä, kunnes verinäytteenotto on vahvistettu. Laskimonäytteenotossa on yksi koodi painettuna jokaiseen putkeen, kapillaarinäytteenotossa taas yksi koodi mikroputkea kohti. Kutsun Hae tulokset tulokset ja asiakirjat viittaavat näihin koodeihin kentällä lab_code.

Vähimmäisennakkoaika

Ajanvaraukset Anivan ylläpitämiin toimipisteisiin on tehtävä vähintään 12 tuntia etukäteen; tämän aikarajan sisällä varaaminen palauttaa 400. Hae saatavuus jättää nämä ajat jo valmiiksi pois, joten kaikki sieltä saadut ajat ovat varattavissa. Itse ylläpitämissäsi toimipisteissä ei ole vähimmäisennakkoaikaa — saman päivän ja paikan päällä tehtävät varaukset toimivat kuten ennenkin.

Päällekkäiset ajanvaraukset

Profiililla voi olla enintään yksi muu kuin peruutettu ajanvaraus toimipistettä ja ajankohtaa kohden — yhdeltä henkilöltä ei voi ottaa verinäytettä kahdesti samassa paikassa samaan aikaan, olipa toimipisteessä kuinka monta tuolia tahansa. Ajanvarauksen luominen ajankohdalle, jonka profiili on jo varannut, palauttaa vastauksen 409 ja appointment_id-tunnisteen, joka viittaa jo olemassa olevaan ajanvaraukseen:
Käsittele tilanne pitämällä pyyntöä jo toteutettuna: hae ajanvaraus kutsulla Hae ajanvaraus, siirrä sitä kutsulla Päivitä ajanvaraus tai peruuta se kutsulla Peruuta ajanvaraus. Älä yritä luontipyyntöä uudelleen — se palauttaa jatkuvasti 409. Tämä tekee toistetuista luontipyynnöistä turvallisia: aikakatkaisun jälkeen uudelleen lähetetty pyyntö tai kahdesti lähetetty lomake ei voi luoda kahta ajanvarausta samalle potilaalle samaan aikaan.
appointment_id on mukana vain päällekkäisyydestä johtuvassa 409-vastauksessa. Kapasiteetista johtuva 409 — aika on täynnä, koska muut potilaat ovat varanneet sen — palauttaa pelkän error-kentän, jolloin oikea tapa edetä on valita toinen aika kutsusta Hae saatavuus.

Virhevastaukset