Siirry pääsisältöön
GET
Hae luettelo kotitestipakkaustilauksista. Kotitestipakkaustilauksessa lähetetään kotiin postitettava itsetestauspakkaus — Aniva lähettää pakkauksen, potilas ottaa näytteen itse kotona ja postittaa sen takaisin. Jokainen kotitestipakkaustilaus sisältää upotetun potilasprofiilin. Kun profile_id annetaan, palauttaa kaikki kyseisen profiilin kotitestipakkaustilaukset. Kun se jätetään pois, palauttaa kaikki käytettävissä olevat kotitestipakkaustilaukset. Vaatii home_kit_orders_view- tai home_kit_orders_manage-käyttöoikeuden.

Pyyntö

Kyselyparametrit

string
Suodata profiilin UUID-tunnisteen mukaan. Kun tämä annetaan, palautetaan kaikki tämän profiilin kotitestipakkaustilaukset.
string
Suodata laboratoriokoodin mukaan (tarkka vastaavuus) — yhdistä kädessä oleva fyysinen pakkaus tilaukseensa siihen painetun koodin perusteella, esim. ennen päätepisteen Aktivoi kutsumista.

Vastaus

Onnistuessaan API palauttaa vastauksen 200 OK ja taulukon kotitestipakkaustilausobjekteja.
string
vaadittu
Kotitestipakkauksen tilauksen yksilöllinen tunniste (UUID).
string
vaadittu
Sen profiilin UUID, jolle tämä kotitestipakkauksen tilaus kuuluu.
string
vaadittu
Kotitestipakkaustilauksen nykyinen tila. Jokin arvoista pending, dispatched, activated tai cancelled. Laboratoriotulosten valmistumisen tarkempi tila saadaan päätepisteestä Hae tulokset.
object
vaadittu
Osoite, johon pakkaus postitetaan — toinen kahdesta muodosta: joko { location_id }, joka viittaa tunnettuun testipaikkaan, tai suorat osoitekentät (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email valinnaisia — sama sanasto kuin locations-API:ssa). Anna täsmälleen toinen — sijaintiviittaus tai suora osoite, ei molempia.
string
Laboratorion näytekoodi, jonka alla tulokset raportoidaan — painettu fyysiseen pakkaukseen, ja sen potilas lukee rasiasta aktivointikoodina. null, kunnes pakkaus on pakattu. Vain luku.
string
vaadittu
Aktivoi-päätepisteen kautta ilmoitettu näytteenoton aikaleima — ajankohta, jolloin potilas otti näytteensä. null, kunnes pakkaus on aktivoitu.
string
Kotitestipakkauksen tilaus, jonka tämä tilaus korvaa, kun kyseessä on korvaava pakkaus. null normaalissa tilauksessa. Katso Luo kotitestipakkauksen tilaus.
string
Syy korvaavan pakkauksen lähettämiselle. null normaalissa tilauksessa.
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.
object
vaadittu
Kumppanin määrittämät avain-arvoparit, jotka palautetaan sellaisinaan. Aina mukana — {} kun arvoja ei ole asetettu.
string
vaadittu
ISO 8601 -aikaleima siitä, milloin kotitestipakkauksen tilaus luotiin.
string
ISO 8601 -aikaleima viimeisimmästä päivityksestä. Voi olla null.
object
vaadittu
Tähän kotitestipakkauksen tilaukseen liittyvä potilasprofiili.
HomeKitOrderPanel[]
vaadittu
Tähän kotitestipakkaustilaukseen liitetty paneeli — aina täsmälleen yksi (kotitestipakkaus vastaa 1:1 fyysistä pakkaustuotetta), ja sen voi vaihtaa päätepisteellä Päivitä, kun tila on pending. Hae paneelin tiedot (nimi, biomarkkerit) päätepisteestä Listaa paneelit.
HomeKitOrderIndividualBiomarker[]
vaadittu
Tähän kotitestipakkaustilaukseen paneelin ulkopuolelta liitetyt yksittäiset biomarkkerit. Tarkista kunkin biomarker_id-tunnisteen näyttötiedot päätepisteestä Listaa biomarkkerit parametrilla home_kit=true.
HomeKitOrderShipmentLink[]
vaadittu
Tähän kotitestipakkaustilaukseen linkitetyt paketit vanhin linkki ensin — yleensä pakkaus potilaalle ja näyte takaisin laboratorioon. Tyhjä, kunnes toimituskeskus tulostaa osoitekortin. Hae pakettien kaikki tiedot päätepisteestä Listaa lähetykset parametrilla ?home_kit_order_id=.

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 saada tiedon muutoksesta heti, tilaa webhook-tapahtuma home_kit_order.created sekä kunkin tilan tapahtuma, esimerkiksi home_kit_order.activated. Katso Toistuvat haut.

Virhevastaukset