Siirry pääsisältöön
DELETE
Peru ajanvaraus asettamalla sen tilaksi cancelled. Vain ajanvaraukset, joiden verinäytteenottoa ei ole vielä vahvistettu, voidaan perua. Jo cancelled-tilassa olevan ajanvarauksen peruminen palauttaa 200-vastauksen ja kyseisen ajanvarauksen eikä kirjoita mitään — toista perumista ei kirjata. Vastauksessa on Idempotent-Replayed: true, josta erotat toistopyynnön varsinaisen muutoksen tehneestä kutsusta. Toistopyyntö, jossa on eri cancellation_reason, palauttaa sen sijaan 409: kirjattua syytä ei koskaan korvata. Katso Idempotenssi.
Ajanvarausta ei voi perua sen jälkeen, kun verinäytteenotto on vahvistettu — se palauttaa 409 Conflict.
Vaatii appointments_schedule- tai appointments_manage-käyttöoikeuden.

Pyyntö

Polkuparametrit

string
vaadittu
Peruttavan ajanvarauksen yksilöllinen tunniste (UUID).

Runkoparametrit

Pyynnön runko on valinnainen — jätä runko kokonaan pois, jos perut ajanvarauksen kirjaamatta syytä.
string
Vapaamuotoinen syy perumiselle, enintään 500 merkkiä (esim. Patient no-show). Tallennetaan ajanvaraukseen ja palautetaan kentässä cancellation_reason tässä ja myöhemmissä lukupyynnöissä.

Vastaus

Onnistuessaan API palauttaa 200 OK sekä perutun 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 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 tila. On cancelled onnistuneen perumisen jälkeen.
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
Paneelit, jotka oli liitetty tähän ajanvaraukseen ennen perumista. Hae paneelin tiedot (nimi, biomarkkerit) kutsulla 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
Lähetykset, jotka oli linkitetty tähän ajanvaraukseen ennen perumista. Kunkin id-arvon tiedot löytyvät kutsulla 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