Siirry pääsisältöön
PATCH
Päivitä ajanvarauksen tietoja, kuten varattua aikaa tai näytteenottopaikkaa. Vain sellaisia ajanvarauksia voi muokata, joiden verinäytteenottoa ei ole vielä vahvistettu.
Ajanvarauksia ei voi muokata verinäytteenoton vahvistamisen jälkeen tai jos ne on jo peruttu. Yritys päivittää tällaista ajanvarausta palauttaa virheen 409 Conflict. Ainoa poikkeus on results_ready_emails, jota voit muuttaa vielä verinäytteenoton jälkeen.
Vaatii appointments_schedule- tai appointments_manage-käyttöoikeuden.

Pyyntö

Polkuparametrit

string
vaadittu
Päivitettävän ajanvarauksen yksilöllinen tunniste (UUID).

Runkoparametrit

Kaikki runkoparametrit ovat valinnaisia — sisällytä vain kentät, joita haluat muuttaa.
string
Uusi ajanvarauksen päivämäärä ja kellonaika ISO 8601 -muodossa (esim. 2026-05-20T14:00:00Z tai 2026-05-20T16:00:00+02:00). Täytyy sisältää aikavyöhykemerkintä — joko Z tai nimenomainen siirtymä, kuten +02:00; aikavyöhykkeettömät ajankohdat hylätään. Täytyy olla tulevaisuudessa.Täytyy olla vapaata kapasiteettia sisältävän aikavälin tarkka alkamisaika — katso Hae saatavuus. Siirrettävä ajanvaraus ei koskaan kuluta oman kohdeaikavälinsä kapasiteettia, mutta siirtäminen aikavälille, jolla samalla profiililla on jo toinen ajanvaraus, palauttaa koodin 409 ja kyseisen ajanvarauksen appointment_id-tunnisteen.Jos kohdetoimipiste on Anivan ylläpitämä, uuden ajan on myös oltava vähintään 12 tunnin päässä — katso Vähimmäisennakkoaika.
string
Uuden näytteenottopaikan UUID. Toimipisteen on oltava olemassa ja aktiivinen. Löydät saatavilla olevien toimipisteiden tunnisteet sivulta Listaa toimipisteet.
string[]
Korvaa enintään 5 osoitteen luettelon, joihin kuhunkin lähetetään yksi sähköposti, kun kaikki laboratoriotulokset ovat lopullisia. Lähetä [] poistaaksesi sähköpostit käytöstä. Tämä kenttä pysyy muokattavana verinäytteenoton jälkeen; vain peruttu ajanvaraus hylkää sen. Lähetä se verinäytteenoton jälkeen yksinään: jos samassa rungossa on scheduled_at tai location_id, pyyntö palauttaa koodin 409. Avaimesi tarvitsee results_view-käyttöoikeuden potilaaseen, muuten palautetaan 403. Katso Sähköpostit tulosten valmistumisesta.
string | null
Uusi näytteenottotapa: capillary tai venous, tai null, jos haluat käyttää jälleen toimipisteen arvoa default_draw_method. Toimipisteen täytyy listata tapa kentässään draw_methods, ja varattujen testien täytyy olla mahdollisia sillä, muuten palautetaan 400. Kun siirrät ajanvarauksen toiseen toimipisteeseen, sama tarkistus ajetaan siellä: ajanvarauksen omalle arvolle draw_method, tai muuten uuden toimipisteen arvolle default_draw_method.

Vastaus

Onnistuessaan API palauttaa vastauksen 200 OK sekä päivitetyn ajanvarauksen ja siihen upotetun profiilin.
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 ajankohta UTC-aikana (ISO 8601 Z-päätteellä, esim. 2026-05-20T14:00: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.
string
vaadittu
ISO 8601 -aikaleima ajanvarauksen luontihetkestä.
string
ISO 8601 -aikaleima viimeisimmästä päivityksestä. Voi olla null.
object
vaadittu
Tähän ajanvaraukseen liitetty potilasprofiili.
AppointmentPanel[]
vaadittu
Tähän ajanvaraukseen tällä hetkellä liitetyt paneelit. Ei sisällä peruttuja liitoksia. Katso paneelin tiedot (nimi, biomarkkerit) päätepisteestä Listaa paneelit.
AppointmentIndividualBiomarker[]
vaadittu
Yksittäiset biomarkkerit, jotka on liitetty tähän ajanvaraukseen paneelien ulkopuolelta (katso Lisää yksittäisiä biomarkkereita). Hae kunkin biomarker_id-arvon näyttötiedot kutsulla Listaa biomarkkerit.
AppointmentShipmentLink[]
vaadittu
Tähän ajanvaraukseen linkitetyt lähetykset vanhimmasta linkistä alkaen. Tyhjä taulukko, kun lähetyksiä ei ole linkitetty. Tarkista kunkin id-tunnisteen avulla lähetyksen koko sisältö päätepisteestä Hae lähetys.
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.

Virhevastaukset