Siirry pääsisältöön
GET
Hae kotitestipakkaustilauksen kliiniset ja geneettiset laboratoriotulokset sekä asiakirjaviittaukset laboratorioraporttien PDF-tiedostoihin. Jokainen pakkaukseen tilattu biomarkkeri näkyy vastauksessa, jotta voit seurata koko tilausta etkä vain jo saapuneita tuloksia. Tulokset kirjautuvat tilauksen lab_code-koodin alle — laboratoriotilaus tehdään aktivoinnin yhteydessä, ja laboratorio raportoi markkerit yksitellen sitä mukaa kun ne analysoidaan, joten osittainen vastaus on normaalia ja ylätason status pysyy arvossa in_progress lopulliseen raporttiin saakka. Lue kunkin tuloksen status ennen sen value-arvon käyttöä:
  • Vielä puuttuvat testit näkyvät tilassa planned, kun tilaus on tilassa in_progress. Voit kutsua tätä päätepistettä ennen aktivointia — silloin jokainen tilattu markkeri on tilassa planned.
  • Tulokset, jotka laboratorio toimitti mutta joita ei saa käyttää kliinisesti, näkyvät tilassa fault tai undeliverable, ja niissä on syyn selittävä status_reason. fault-tuloksessa value on silti täytetty — tämä arvo on virheellinen. Älä koskaan esitä sitä löydöksenä.
  • Tulokset, joita Aniva tai jäsen epäilee, näkyvät tilassa likely_wrong, ja niissä on status_reason. Arvoa ei ole vahvistettu. Älä näytä sitä löydöksenä ilman tarkistusta.
Lataa documents-taulukossa viitatut laboratorioraporttien PDF-tiedostot päätepisteellä Lataa asiakirja. Sinun ei tarvitse kysellä tätä päätepistettä toistuvasti. Tilaa webhookit home_kit_order.results.updated tai home_kit_order.results.completed ja kutsu päätepistettä, kun tapahtuma saapuu. Toistuva kysely toimii silti varavaihtoehtona. Vaatii results_view-käyttöoikeuden — laboratoriotulokset ja asiakirjat edellyttävät aina sitä samoin kuin ajanvarauksen tulokset ja Lataa asiakirja — sekä home_kit_orders_view- tai home_kit_orders_manage-käyttöoikeuden itse pakkaustilauksen käyttämiseen.

Pyyntö

Polkuparametrit

string
vaadittu
Sen kotitestipakkaustilauksen yksilöllinen tunniste (UUID), jonka tulokset haetaan.

Vastaus

Onnistuessaan API palauttaa 200 OK ja tulokset sisältävän objektin.
string
vaadittu
Tulosten kokonaistila. Yksi seuraavista:
  • in_progress – osa lähetteistä on yhä laboratoriossa.
  • completed – kaikki lähetteet ovat sulkeutuneet ja ainakin yksi raportoi tulokset.
  • fault – kaikki lähetteet päättyivät ilman tuloksia. Mitään ei ole enää tulossa.
object[]
vaadittu
Yksi merkintä kutakin laboratoriolähetettä kohti – useaa putkea tai laboratoriota koskevalla verinäytteenotolla on useita. Ylätason status on completed, kun jokainen merkintä on sulkeutunut ja vähintään yksi on raportoinut.
object[]
vaadittu
Taulukko kliinisistä biomarkkerituloksista.
object[]
vaadittu
Taulukko geneettisistä biomarkkerituloksista.
object[]
vaadittu
Laboratorioraporttien asiakirjat. Lataa kukin tiedosto kutsulla GET /api/v1/documents/{id}.

Toistuvat kutsut

Aniva tallentaa tämän päätepisteen vastauksen 60 minuutiksi kullekin API-avaimelle. Tänä aikana toistettu kutsu saa tallennetun vastauksen, jos kotitestipakkaustilaus ja sen tulokset eivät ole muuttuneet. Muutoksen jälkeen saat tuoreen vastauksen. Otsakkeet Cache-Status ja Age näyttävät, että vastaus on tallennettu ja kuinka vanha se on. Jos haluat saada tiedon muutoksesta heti, tilaa webhook-tapahtumat home_kit_order.results.updated, home_kit_order.results.completed ja home_kit_order.results.fault. Katso Toistuvat haut.

Virhevastaukset