Siirry pääsisältöön
POST
Pyydä kotitestipakkauksen tilausta potilasprofiilille. Kotitestipakkauksen tilauksella lähetetään kotiin postitettava itsetestipakkaus — Aniva lähettää pakkauksen toimitusosoitteeseen, potilas ottaa näytteen itse kotona ja postittaa sen takaisin. Tämä eroaa ajanvarauksesta, joka on laskimoverinäytteenotto testauspaikassa. Tasan yksi paneeli vaaditaan. Kotitestipakkaus vastaa 1:1 fyysistä pakkaustuotetta — paneeli on pakkaus — ja tilaus siirtyy pakkausjonoon heti luonnin jälkeen, joten sisällön on oltava lopullinen jo alussa. Voit silti vaihtaa paneelin kutsulla Päivitä kotitestipakkauksen tilaus, kun tilaus on tilassa pending.

Korvaavat pakkaukset

Kun pakkauksesta ei saada tuloksia — potilas ei saanut putkea täyteen, näyte saapui liian pienellä näytemäärällä tai laboratorio ei pystynyt analysoimaan sitä — tilaa korvaava pakkaus lähettämällä replaces_home_kit_order_id. Korvaava pakkaus on uusi tilaus uudella laboratoriokoodilla, myös silloin kun ensimmäistä pakkausta ei koskaan aktivoitu: laboratorio tarvitsee uuden lähetteen, eikä kahta samalla koodilla olevaa näytettä voi erottaa toisistaan. Korvattavaan tilaukseen ei kosketa — se säilyttää oman tilansa, oman laboratoriokoodinsa ja kaikki sille jo kirjatut tulokset. Tästä seuraa kaksi asiaa:
  • Paneeli periytyy. Jätä panel_id pois, jolloin korvaava tilaus saa korvattavan tilauksen paneelin, joka vastaa potilaan ostamaa tuotetta ja pakkauksen brändäystä.
  • Sinä valitset, mitä analysoidaan uudelleen. Lähetä epäonnistuneet biomarkkerit kentässä biomarker_ids, niin laboratorio analysoi vain ne uudelleen ja pakkaus sisältää vain niihin tarvittavat putket. Jätä kenttä pois, jos haluat analysoida koko paneelin uudelleen.
Biomarkkerit analysoidaan uudelleen paneelin ryhminä, ei yksitellen. Yhdenkin ryhmään kuuluvan biomarkkerin nimeäminen johtaa koko ryhmän uudelleenanalysointiin, koska laboratoriolle ei voi tehdä tilausta, joka raportoi enemmän kuin pyydettiin. Yhden biomarkkerin korvaava tilaus voi siksi tuottaa useamman kuin yhden tuloksen, ja sen putkimäärä voi olla suurempi kuin biomarkkeriluettelo antaa ymmärtää. Kustakin pakkauksesta voi olla matkalla vain yksi korvaava pakkaus kerrallaan.
Jos teit integraation ennen näiden kenttien julkaisua, Aniva lukee tilausta luotaessa myös kentät metadata.original_kit_id ja metadata.replacement_reason ja käsittelee tilauksen korvaavana. Tämä on ainoa paikka, jossa metatietoja tulkitaan; se on olemassa vain aiemman integraation tukemiseksi, ja yllä olevat kentät menevät aina edelle. Lähetä nämä kentät.
Vastaus 201 tarkoittaa, että tilaus on vahvistettu ja siirtyy toimitukseen — sinun ei tarvitse tehdä mitään muuta, jotta pakkaus pakataan ja lähetetään. Vaatii home_kit_orders_manage-laajuuden. Lähetä valinnainen Idempotency-Key-otsikko, jotta luontipyynnön voi yrittää turvallisesti uudelleen — saman avaimen toistaminen palauttaa alkuperäisen vastauksen toisen luomisen sijaan. Katso Idempotenssi.

Pyyntö

Runkoparametrit

string
vaadittu
Potilasprofiilin UUID, jolle kotitestipakkauksen tilaus luodaan.
string
vaadittu
Valikoimasta tilattavan paneelin UUID. Tasan yksi — kotitestipakkaus vastaa 1:1 fyysistä pakkaustuotetta, joten paneeli on pakkaus. Aniva toimittaa paneelitunnukset kumppanitilillesi; katso Listaa paneelit. Valinnainen korvaavassa tilauksessa, jolloin oletuksena käytetään korvattavan tilauksen paneelia.
string
Korvattavan kotitestipakkauksen tilauksen UUID. Tämän lähettäminen tekee tilauksesta korvaavan pakkauksen — katso Korvaavat pakkaukset yllä. Tilauksen on kuuluttava samalle profiilille, eikä sille saa jo olla korvaavaa pakkausta matkalla.
string
Syy korvaavan pakkauksen tarpeelle yhdellä lauseella (esimerkiksi Zu wenig Material, HbA1c nicht auswertbar). Pakollinen, kun lähetät kentän replaces_home_kit_order_id, ja muuten ohitetaan. Enintään 500 merkkiä.
integer[]
Korvaavassa tilauksessa biomarkkerit, jotka laboratorio analysoi uudelleen — tavallisesti ne, joita ensimmäisellä pakkauksella ei saatu. Jokaisen on kuuluttava korvattavan tilauksen pyytämiin biomarkkereihin; tarkista ne kutsulla Listaa biomarkkerit parametrilla home_kit=true. Jätä pois, jos haluat analysoida koko paneelin uudelleen. Hyväksytään vain yhdessä kentän replaces_home_kit_order_id kanssa, eikä yhdessä eri panel_id-arvon kanssa. Tämä ei vaadi lisäkäyttöoikeutta: potilaan jo maksamien biomarkkerien uudelleenanalysointi ei ole erillinen yksittäisvalinta.
object
Omat avain–arvo-parisi, jotka palautetaan sellaisinaan jokaisella lukukerralla ja joita Aniva ei koskaan tulkitse. Käytä kenttää oman tilausviitteesi välittämiseen, jotta voit yhdistää tiedot tallentamatta tunnuksiamme. Enintään 20 avainta; avaimet noudattavat mallia [A-Za-z0-9_-] ja ovat enintään 40 merkkiä pitkiä; arvot ovat merkkijonoja, lukuja tai totuusarvoja, joista merkkijonot ovat enintään 500 merkkiä; yhteensä enintään 16 384 tavua sarjoitettuna. Etuliitteellä aniva_ alkavat avaimet on varattu. Älä koskaan tallenna henkilö- tai kliinisiä tietoja kenttään metadata — sitä ei käsitellä potilastietona.
string[]
Enintään 5 osoitetta, joista kukin saa yhden sähköpostin, kun kaikki laboratoriotulokset ovat valmiit. Sähköpostissa on linkki tulossivulle Anivan hallintapaneelissa. Avaimesi tarvitsee results_view-oikeuden potilaaseen, muutoin palautetaan 403. Jätä kenttä pois, jos haluat käyttää potilaan ryhmälle asetettuja oletusosoitteita. Tyhjä lista poistaa sähköpostit käytöstä. Katso Sähköpostit valmiista tuloksista.
object
vaadittu
Osoite, johon pakkaus postitetaan — jompikumpi kahdesta muodosta: joko { location_id }, joka viittaa tunnettuun testauspaikkaan, 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-rajapinnassa). Anna tasan yksi — sijaintiviite tai suora osoite, älä molempia.
Packstation tai Postfiliale (vain Saksa): aseta street-kenttään Packstation tai Postfiliale, house_number-kenttään kolminumeroinen aseman numero ja address_line_2-kenttään vastaanottajan DHL Postnummer (6–10 numeroa, välilyönnit sallittu). Ilman Postnummer-tunnusta pakettia ei voi varata. Postfach ei ole tuettu.

Vastaus

Onnistuessaan rajapinta palauttaa 201 Created sekä uuden kotitestipakkauksen tilauksen.
string
vaadittu
Kotitestipakkauksen tilauksen yksilöllinen tunniste (UUID).
string
vaadittu
Sen profiilin UUID, jolle tämä kotitestipakkauksen tilaus kuuluu.
string
vaadittu
Kotitestipakkauksen tilauksen nykyinen tila. Yksi arvoista pending, dispatched, activated tai cancelled. Juuri luotu tilaus alkaa tilasta pending.
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.
object
vaadittu
Antamasi avain–arvo-parit. Aina mukana — {}, jos et asettanut yhtään.
string
Kotitestipakkauksen tilaus, jonka tämä tilaus korvaa. null tavallisessa tilauksessa.
string
Antamasi syy. null tavallisessa 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.
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
Näytteenoton aikaleima, joka on ilmoitettu kutsulla Aktivoi. null, kunnes pakkaus on aktivoitu.
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 kotitestipakkauksen tilaukseen liitetty paneeli — kentässä panel_id antamasi paneeli tilauksen luontiaikaleimalla. Aina tasan yksi. Hae paneelin tiedot (nimi, biomarkkerit) kutsulla Listaa paneelit.
HomeKitOrderIndividualBiomarker[]
vaadittu
Paneelin ulkopuolelta liitetyt biomarkkerit. Tyhjä tavallisessa luonnissa — kotitestipakkaukset tilataan paneeleittain, ja tämän luettelon muokkaaminen jälkikäteen vaatii home_kit_orders_individual_biomarker_selection-käyttöoikeuden. Korvaavassa tilauksessa kenttä sisältää lähettämäsi biomarker_ids-tunnukset, jotka laboratorio analysoi uudelleen.
HomeKitOrderShipmentLink[]
vaadittu
Tähän kotitestipakkauksen tilaukseen linkitetyt paketit vanhimmasta linkistä alkaen. Aina tyhjä luotaessa — lue pakettien tarkat tiedot kutsulla Listaa lähetykset ja parametrilla ?home_kit_order_id=.

Virhevastaukset