Siirry pääsisältöön
PATCH
Päivitä kotitestipakkaustilauksen toimitusosoite, paneeli, metatiedot tai tulosilmoitussähköpostit. Sisällytä vain kentät, joita haluat muuttaa. Toimitusosoitetta ja paneelia voi muuttaa vain tilauksen ollessa tilassa pending, koska fyysinen pakkaus lähetetään lähetysvaiheessa. metadata on omaa kirjanpitoasi ja pysyy muokattavana koko tilauksen elinkaaren ajan. Paneelin lisäämiseen tai poistamiseen ei ole päätepisteitä: kotitestipakkauksessa on aina tasan yksi paneeli (se vastaa 1:1 fyysistä pakkaustuotetta), joten ainoa mielekäs paneelitoiminto on tässä tehtävä vaihto. Vaatii home_kit_orders_manage-laajuuden.

Pyyntö

Polkuparametrit

string
vaadittu
Päivitettävän kotitestipakkaustilauksen yksilöllinen tunniste (UUID).

Runkoparametrit

Kaikki runkoparametrit ovat valinnaisia — sisällytä vain kentät, joita haluat muuttaa.
object
Osoite, johon pakkaus postitetaan — toinen kahdesta muodosta: joko { location_id }, joka viittaa tunnettuun testitoimipisteeseen, 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 — toimipisteviittaus tai suora osoite, ei 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.
string
Nykyisen tilalle liitettävän paneelin UUID — koska pakkauksessa on tasan yksi paneeli, vaihto on ainoa mielekäs toiminto. Sallittu vain tilauksen ollessa tilassa pending, ja vain paneeliin, jolle Aniva on määrittänyt toimitettavan pakkaustuotteen (muuten 422); vaihto jo liitettyyn paneeliin ei tee mitään.
object
Omat avain-arvoparisi. Yhdistetään olemassa oleviin metatietoihin korvaamisen sijaan: pois jättämäsi avaimet säilyvät, null-arvolla lähetetty avain poistetaan ja tyhjä objekti {} tyhjentää kaiken. Rajoitukset vastaavat kohtaa Luo kotitestipakkaustilaus, ja validointi on kaikki tai ei mitään — jos yksikin avain hylätään, mitään ei tallenneta. Älä koskaan laita henkilö- tai kliinisiä tietoja kenttään metadata — sitä ei käsitellä potilastietona.
string[]
Korvaa enintään 5 osoitteen luettelon, joihin kuhunkin lähetetään yksi sähköposti, kun kaikki laboratoriotulokset ovat valmiit. Lähetä [] poistaaksesi sähköpostit käytöstä. Muokattavissa kaikissa tiloissa paitsi cancelled. Avaimesi tarvitsee results_view-oikeuden potilaaseen, muuten palautetaan 403. Katso Tulosilmoitussähköpostit.

Vastaus

Onnistuessaan API palauttaa 200 OK sekä päivitetyn kotitestipakkaustilauksen ja siihen sisältyvän profiilin.
string
vaadittu
Kotitestipakkauksen tilauksen yksilöllinen tunniste (UUID).
string
vaadittu
Sen profiilin UUID, jolle tämä kotitestipakkauksen tilaus kuuluu.
string
vaadittu
Kotitestipakkaustilauksen nykyinen tila. Yksi arvoista pending, dispatched, activated tai cancelled.
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 tasan yksi (kotitestipakkaus vastaa 1:1 fyysistä pakkaustuotetta), joka korvataan paikallaan, kun välität parametrin panel_id. 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=.

Virhevastaukset