Siirry pääsisältöön
GET
Hae luettelo verinäytteenoton ajanvarauksista. Jokainen ajanvaraus sisältää upotetun potilasprofiilin. Suodattimet toimivat yhdessä:
  • date palauttaa yhden kalenteripäivän ajanvaraukset. Päivä on kunkin ajanvarauksen toimipisteen paikallinen päivä, joten Berliinissä klo 23.30 tehty verinäytteenotto lasketaan Berliinin päivämäärälle.
  • location_id palauttaa yhden testauspaikan ajanvaraukset.
  • profile_id ilman parametria date palauttaa kaikki kyseisen profiilin ajanvaraukset ilman aikarajoitusta.
  • Ilman parametreja profile_id ja date käytetään oletusaikaikkunaa: 2 kuukautta taaksepäin ja 1 kuukausi eteenpäin.
Vaatii appointments_view- tai appointments_schedule-käyttöoikeuden.

Pyyntö

Kyselyparametrit

string
Suodata profiilin UUID:n perusteella. Kun arvo on annettu, palautetaan kaikki tämän profiilin ajanvaraukset ajankohdasta riippumatta. Kun arvo jätetään pois, käytetään oletusaikaikkunaa.
string
Suodata testauspaikan UUID:n perusteella.
string
Kalenteripäivä muodossa YYYY-MM-DD kunkin ajanvarauksen toimipisteen aikavyöhykkeellä. Korvaa oletusaikaikkunan. Tulokset järjestetään kentän scheduled_at mukaan aikaisimmasta alkaen.

Vastaus

Onnistuessaan API palauttaa tilakoodin 200 OK ja taulukon ajanvarausobjekteja.
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.
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 liitetyt lähetykset vanhimmasta liitoksesta alkaen. Tyhjä taulukko, kun lähetyksiä ei ole liitetty. Hae kunkin id-arvon täydet lähetystiedot (tila, seurantanumero, tilapäivitykset jne.) 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.

Toistuvat kutsut

Aniva tallentaa tämän päätepisteen vastauksen 5 minuutiksi kullekin API-avaimelle. Tämän ajan sisällä tehty toistuva kutsu saa tallennetun vastauksen. Otsikot Cache-Status ja Age kertovat, että vastaus on tallennettu ja kuinka vanha se on. Jos haluat tiedon muutoksesta heti, tilaa webhook-tapahtumat appointment.created, appointment.rescheduled sekä kunkin tilan tapahtuma, esimerkiksi appointment.confirmed. Katso Toistuvat haut.

Virhevastaukset