Ugrás a fő tartalomhoz
PATCH
Frissítsd egy otthoni tesztkészlet-rendelés szállítási címét, paneljét, metaadatait vagy az eredmények elkészültéről szóló e-mail-címeket. Csak azokat a mezőket add meg, amelyeket módosítani szeretnél. A szállítási cím és a panel csak addig módosítható, amíg a rendelés pending állapotban van, mivel a fizikai készlet a feladáskor elindul. A metadata a saját nyilvántartásodra szolgál, és a rendelés teljes élettartama alatt írható marad. Nincsenek panel-hozzáadó vagy -eltávolító végpontok: egy otthoni tesztkészlet pontosan egy panelt tartalmaz (1:1 arányban felel meg egy fizikai készletterméknek), így az egyetlen értelmes panelművelet az itt elvégezhető csere. Szükséges hozzá a home_kit_orders_manage scope.

Kérés

Útvonalparaméterek

string
kötelező
A frissítendő otthoni tesztkészlet-rendelés egyedi azonosítója (UUID).

Törzsparaméterek

Minden törzsparaméter opcionális — csak azokat a mezőket add meg, amelyeket módosítani szeretnél.
object
A cím, ahová a készletet postázzuk – két formátum egyikében: vagy egy ismert vizsgálati helyszínre hivatkozó { location_id }, vagy a beágyazott címmezők (name, street, city, postal_code, country_code; a company_name / house_number / address_line_2 / state / phone / email opcionális – ugyanaz a mezőelnevezés, mint a helyszínek API-ban). Pontosan az egyiket add meg – helyszínhivatkozást vagy beágyazott címet, ne mindkettőt.
Packstation vagy Postfiliale (csak Németországban): állítsd a street értékét Packstation vagy Postfiliale értékre, a house_number legyen a háromjegyű állomásszám, az address_line_2 pedig a címzett DHL Postnummer azonosítója (6–10 számjegy, szóközök megengedettek). A Postnummer nélkül a csomag nem foglalható le. A Postfach nem támogatott.
string
A jelenlegi helyett csatolandó panel UUID-ja – mivel készletenként pontosan egy panel lehetséges, a csere az egyetlen értelmes művelet. Csak amíg a rendelés pending állapotban van, és csak olyan panelre, amelyhez az Aniva konfigurált kiszállítási készletterméket (egyébként 422); a már csatolt panelre történő csere nem végez módosítást.
object
A saját kulcs-érték párjaid. A rendszer összefésüli a meglévő metaadatokkal ahelyett, hogy felülírná azokat: a kihagyott kulcsok megmaradnak, a null értékkel küldött kulcs törlődik, egy üres {} objektum pedig mindent töröl. A korlátok megegyeznek az Otthoni tesztkészlet-rendelés létrehozása végpontéval, a validáció pedig mindent vagy semmit alapon működik – ha bármelyik kulcsot elutasítja a rendszer, semmi nem mentődik el. Soha ne tegyél személyes vagy klinikai adatot a metadata mezőbe – nem páciensadatként kezeljük.
string[]
Felülírja az akár 5 címből álló listát, amelynek minden tagja kap egy e-mailt, amint az összes laboreredmény végleges. Küldj [] értéket az e-mailek kikapcsolásához. A cancelled kivételével minden állapotban szerkeszthető. A kulcsodnak results_view hozzáféréssel kell rendelkeznie a pácienshez, különben 403 választ kapsz. Lásd: Eredmények elkészültéről szóló e-mailek.

Válasz

Sikeres kérés esetén az API 200 OK választ ad vissza a frissített otthoni tesztkészlet-rendeléssel és a beágyazott profillal.
string
kötelező
Az otthoni tesztkészlet-rendelés egyedi azonosítója (UUID).
string
kötelező
Annak a profilnak az UUID-ja, amelyhez ez az otthoni tesztkészlet-rendelés tartozik.
string
kötelező
Az otthoni tesztkészlet-rendelés aktuális állapota. A lehetséges értékek: pending, dispatched, activated vagy cancelled.
object
kötelező
A cím, ahová a tesztkészletet postázzuk — két formátum egyike: vagy egy { location_id }, amely egy ismert tesztelési helyszínre hivatkozik, vagy a beágyazott címmezők (name, street, city, postal_code, country_code; a company_name / house_number / address_line_2 / state / phone / email opcionális — ugyanaz a mezőkészlet, mint a helyszínek API-ban). Pontosan az egyiket add meg — vagy helyszínhivatkozást, vagy beágyazott címet, de ne mindkettőt.
string
A laboratóriumi mintakód, amely alatt az eredmények beérkeznek — a fizikai készletre van nyomtatva, és ezt olvassa le a páciens a dobozról aktiválási kódként. null, amíg a készletet nem csomagolták be. Csak olvasható.
string
kötelező
Az Aktiválás végponton keresztül jelentett mintavételi időbélyeg — amikor a páciens levette a mintát. null, amíg a készletet nem aktiválták.
string
Az az otthoni tesztkészlet-rendelés, amelyet ez helyettesít, ha cserekészletről van szó. Normál rendelés esetén null. Lásd: Otthoni tesztkészlet-rendelés létrehozása.
string
A cserekészlet küldésének oka. Normál rendelés esetén null.
string[]
kötelező
Címek, amelyek mindegyike egy-egy e-mailt kap, amint minden laboreredmény végleges, kisbetűvel. Kikapcsolva üres. Lásd: Eredmények elkészültéről szóló e-mailek.
object
kötelező
A partner által megadott kulcs-érték párok, változatlanul visszaadva. Mindig jelen van — {} értékkel, ha nincs megadva.
string
kötelező
Az otthoni tesztkészlet-rendelés létrehozásának ISO 8601 időbélyege.
string
Az utolsó frissítés ISO 8601 időbélyege. Lehet null.
object
kötelező
Az ehhez az otthoni tesztkészlet-rendeléshez tartozó páciensprofil.
HomeKitOrderPanel[]
kötelező
Az ehhez az otthoni tesztkészlet-rendeléshez csatolt panel – mindig pontosan egy (egy otthoni tesztkészlet 1:1 arányban felel meg egy fizikai készletterméknek), amelyet a panel_id megadásakor helyben lecserélünk. A panel részleteit (név, biomarkerek) a Panelek listázása végponton kérdezheted le.
HomeKitOrderIndividualBiomarker[]
kötelező
Ehhez az otthoni tesztkészlet-rendeléshez panelen kívül csatolt egyedi biomarkerek. A megjelenítési adatokhoz vesd össze az egyes biomarker_id értékeket a home_kit=true paraméterrel hívott Biomarkerek listázása végpont adataival.
HomeKitOrderShipmentLink[]
kötelező
Az ehhez az otthoni tesztkészlet-rendeléshez kapcsolt csomagok, a legrégebben kapcsolttal kezdve — jellemzően a páciensnek küldött tesztkészlet és a laboratóriumba visszaküldött minta. Üres, amíg a logisztika ki nem nyomtat egy címkét. A csomagok teljes adatait a Szállítmányok listázása végponttal és a ?home_kit_order_id= paraméterrel olvashatod le.

Hibaválaszok