Ugrás a fő tartalomhoz
POST
Kérj otthoni tesztkészlet-rendelést egy páciensprofilhoz. Az otthoni tesztkészlet-rendelés keretében egy otthon elvégezhető, postai tesztkészletet küldünk – az Aniva kiszállítja a készletet a szállítási címre, a páciens otthon maga veszi le a mintát, és postán visszaküldi. Ez eltér az időponttól, amely egy vizsgálati helyszínen történő vénás vérvétel. Pontosan egy panel megadása kötelező. Egy otthoni tesztkészlet 1:1 arányban felel meg egy fizikai készletterméknek – a panel maga a készlet –, és a rendelés a létrehozásakor azonnal bekerül a csomagolási sorba, ezért az összetételnek már eleve véglegesnek kell lennie. A panelt még lecserélheted az Otthoni tesztkészlet-rendelés frissítése segítségével, amíg a rendelés pending állapotban van.

Cserekészletek

Ha egy készlet nem tud eredményeket adni – a páciens nem tudta megtölteni a csövet, a minta túl kevés anyaggal érkezett, a laboratórium nem tudta elemezni –, rendelj cserekészletet a replaces_home_kit_order_id elküldésével. A csere egy új rendelés új laborkóddal, akkor is, ha az első készletet soha nem aktiválták: a laboratóriumnak új vizsgálatkérésre van szüksége, és egy kód alatt két minta nem különböztethető meg. A lecserélt rendelés érintetlen marad – megtartja a saját állapotát, a saját laborkódját és a hozzá már rögzített eredményeket. Ebből két dolog következik:
  • A panel öröklődik. Hagyd el a panel_id mezőt, és a csere a lecserélt rendelés paneljét viszi tovább, amelyet a páciens megvásárolt, és amely a doboz arculatát is meghatározza.
  • Te választod ki, mit futtassanak újra. Küldd el a biomarker_ids mezőt a sikertelen markerekkel, és a laboratórium csak azokat futtatja újra, így a készlet csak a hozzájuk szükséges csövekkel érkezik. Hagyd el a teljes panel újrafuttatásához.
A markerek a panel csoportjai szerint futnak újra, nem egyenként. Egy csoport egyetlen markerének megadásával a teljes csoport újrafut, mert nem adható le olyan laboratóriumi rendelés, amely többet közöl a kértnél. Egy egymarkeres csere ezért egynél több eredménnyel is megérkezhet, a csövek száma pedig nagyobb lehet annál, mint amit a markerlista sugall. Egyszerre készletenként csak egy csere lehet úton.
Ha ezeknek a mezőknek a megjelenése előtt integráltál, az Aniva létrehozáskor a metadata.original_kit_id és a metadata.replacement_reason mezőket is beolvassa, és csereként kezeli a rendelést. Ez az egyetlen hely, ahol a metaadatokat értelmezzük, kizárólag a korábbi integráció működésének fenntartására szolgál, és a fenti mezők mindig elsőbbséget élveznek. Küldd a mezőket.
A 201 azt jelenti, hogy a rendelést rögzítettük és átadjuk teljesítésre – nincs más teendőd ahhoz, hogy a készletet becsomagolják és kiszállítsák. Szükséges hozzá a home_kit_orders_manage scope. Küldj opcionális Idempotency-Key fejlécet, hogy a létrehozás biztonságosan újrapróbálható legyen — ugyanazzal a kulccsal megismételve az eredeti válasz érkezik vissza egy újabb létrehozása helyett. Lásd: Idempotencia.

Kérés

Törzsparaméterek

string
kötelező
Annak a páciensprofilnak az UUID-je, amelyhez az otthoni tesztkészlet-rendelést létrehozod.
string
kötelező
A megrendelni kívánt katalóguspanel UUID-je. Pontosan egy – egy otthoni tesztkészlet 1:1 arányban felel meg egy fizikai készletterméknek, tehát a panel maga a készlet. A panelazonosítókat az Aniva biztosítja a partnerfiókodhoz; lásd: Panelek listázása. Csere esetén opcionális, ilyenkor alapértelmezés szerint a lecserélt rendelés panelje lesz érvényes.
string
Annak az otthoni tesztkészlet-rendelésnek az UUID-je, amelyet ez a rendelés lecserél. Megadásával ez cserekészletnek minősül – lásd fentebb a Cserekészletek részt. A rendelésnek ugyanahhoz a profilhoz kell tartoznia, és nem lehet már úton egy másik cseréje.
string
Miért van szükség a cserére, egy mondatban (például Zu wenig Material, HbA1c nicht auswertbar). Kötelező, ha elküldöd a replaces_home_kit_order_id mezőt, egyébként figyelmen kívül hagyjuk. Legfeljebb 500 karakter.
integer[]
Csere esetén azok a markerek, amelyeket a laboratórium újrafuttat – jellemzően azok, amelyeket az első készlet nem tudott szolgáltatni. Mindegyiknek szerepelnie kell a lecserélt rendelésben kértek között; vesd össze a Biomarkerek listázása adataival home_kit=true paraméterrel. Hagyd el a teljes panel újrafuttatásához. Csak a replaces_home_kit_order_id mezővel együtt fogadjuk el, eltérő panel_id mellett viszont nem. Ehhez nincs szükség külön scope-ra: a páciens által már kifizetett markerek újrafuttatása nem egyedi válogatás.
object
Saját kulcs-érték párok, amelyeket minden lekérdezéskor változtatás nélkül visszaadunk, és az Aniva soha nem értelmezi őket. Használd a saját rendeléshivatkozásod átadására, így a mi azonosítóink tárolása nélkül is összerendelheted az adatokat. Legfeljebb 20 kulcs; a kulcsok a [A-Za-z0-9_-] mintának felelnek meg és legfeljebb 40 karakteresek; az értékek szövegek, számok vagy logikai értékek, a szövegek legfeljebb 500 karakteresek; szerializálva összesen 16 384 bájt. Az aniva_ előtaggal kezdődő kulcsok fenntartottak. Soha ne tegyél személyes vagy klinikai adatot a metadata mezőbe – nem páciensadatként kezeljük.
string[]
Legfeljebb 5 cím, amelyek mindegyike egy e-mailt kap, amint minden laboreredmény végleges. Az e-mail az Aniva adminfelületének eredményoldalára mutat. A kulcsodnak results_view hozzáférésre van szüksége a pácienshez, különben 403-at kapsz. Hagyd el, ha a páciens csoportjához beállított alapértelmezett címeket szeretnéd használni. Üres listával kikapcsolhatod az e-maileket. Lásd: Elkészült eredményekről szóló e-mailek.
object
kötelező
A cím, ahová a készletet postázzuk – kétféle formában adható meg: vagy { location_id } egy ismert vizsgálati helyszínre hivatkozva, vagy a közvetlenül megadott címmezők (name, street, city, postal_code, country_code; opcionálisan company_name / house_number / address_line_2 / state / phone / email – ugyanaz a mezőkészlet, mint a helyszínek API-ban). Pontosan az egyiket add meg – helyszínhivatkozást vagy közvetlen címet, mindkettőt ne.
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.

Válasz

Sikeres kérés esetén az API 201 Created választ ad vissza az új otthoni tesztkészlet-rendeléssel.
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 következő értékek egyike: pending, dispatched, activated vagy cancelled. Egy újonnan létrehozott rendelés pending állapotban indul.
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.
object
kötelező
Az általad megadott kulcs-érték párok. Mindig szerepel – {} értékű, ha nem állítottál be egyet sem.
string
Az az otthoni tesztkészlet-rendelés, amelyet ez lecserél. Normál rendelés esetén null.
string
Az általad megadott indoklás. 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.
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 során jelentett mintavételi időbélyeg. null, amíg a készletet nem aktiválják.
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ő
Ehhez az otthoni tesztkészlet-rendeléshez csatolt panel – az, amelyet panel_id értékként adtál meg, a rendelés létrehozási idejével megjelölve. Mindig pontosan egy. A panel részleteit (név, biomarkerek) a Panelek listázása segítségével keresheted meg.
HomeKitOrderIndividualBiomarker[]
kötelező
A panelen kívül csatolt biomarkerek. Normál létrehozáskor üres – az otthoni tesztkészlet-rendeléseket panel alapján adjuk le, és ennek a listának az utólagos módosításához a home_kit_orders_individual_biomarker_selection capability scope szükséges. Csere esetén az általad küldött biomarker_ids értékeket tartalmazza, amelyeket a laboratórium újrafuttat.
HomeKitOrderShipmentLink[]
kötelező
Ehhez az otthoni tesztkészlet-rendeléshez kapcsolt csomagok, a legrégebben kapcsolttól kezdve. Létrehozáskor mindig üres – a teljes csomagadatokat a Szállítmányok listázása segítségével és a ?home_kit_order_id= paraméterrel kérheted le.

Hibaválaszok