Ugrás a fő tartalomhoz
GET
Kérd le egy otthoni tesztkészlet-rendelés klinikai és genetikai laboratóriumi eredményeit, valamint a laboratóriumi leletek PDF-jeihez tartozó dokumentumhivatkozásokat. A válaszban a tesztkészlethez megrendelt minden biomarker megjelenik, így a teljes rendelést nyomon követheted, nem csak a már megérkezett eredményeket. Az eredmények a rendelés lab_code kódja alá kerülnek — a laboratóriumi megrendelés az aktiváláskor történik meg, és a laboratórium a markereket egyenként, az elemzésük ütemében jelenti le, ezért a részleges válasz normális, és a legfelső szintű status a végső leletig in_progress marad. Olvasd ki minden eredmény status mezőjét, mielőtt felhasználnád a value értékét:
  • A még függőben lévő vizsgálatok planned állapottal jelennek meg, amíg a rendelés in_progress állapotú. Ezt a végpontot aktiválás előtt is meghívhatod — ilyenkor minden megrendelt marker planned állapotú.
  • Azok az eredmények, amelyeket a laboratórium megküldött, de klinikailag nem szabad felhasználni, fault vagy undeliverable állapottal jelennek meg, és tartalmaznak egy status_reason mezőt, amely megmagyarázza az okot. A fault állapotú eredménynél a value továbbra is ki van töltve — ez az érték hibás. Soha ne jelenítsd meg leletként.
  • Azok az eredmények, amelyeket az Aniva vagy a tag megkérdőjelez, likely_wrong állapottal és egy status_reason mezővel jelennek meg. Az érték nincs megerősítve. Ellenőrzés nélkül ne jelenítsd meg leletként.
Használd a Dokumentum letöltése végpontot a documents tömbben hivatkozott PDF laborleletek letöltéséhez. Nem szükséges folyamatosan lekérdezned ezt a végpontot. Iratkozz fel a home_kit_order.results.updated vagy a home_kit_order.results.completed webhookokra, és akkor hívd meg, amikor esemény érkezik. A rendszeres lekérdezés tartalék megoldásként továbbra is működik. Szükséges hozzá a results_view jogosultsági kör — a laboratóriumi eredmények és dokumentumok mindig ehhez vannak kötve, akárcsak az időpontok eredményei és a Dokumentum letöltése —, valamint a home_kit_orders_view vagy a home_kit_orders_manage jogosultsági kör magához a tesztkészlet-rendeléshez való hozzáféréshez.

Kérés

Útvonalparaméterek

string
kötelező
Annak az otthoni tesztkészlet-rendelésnek az egyedi azonosítója (UUID), amelynek az eredményeit lekéred.

Válasz

Siker esetén az API 200 OK választ ad vissza az eredmények objektumával.
string
kötelező
Az eredmények összesített állapota. Az alábbiak egyike:
  • in_progress — néhány vizsgálatkérés még a laboratóriumban van.
  • completed — minden vizsgálatkérés lezárult, és legalább egyhez érkezett lelet.
  • fault — minden vizsgálatkérés lelet nélkül meghiúsult. Semmi nem marad függőben.
object[]
kötelező
Egy bejegyzés laboratóriumi vizsgálatkérésenként — egy több csövet vagy laboratóriumot érintő vérvételhez több is tartozik. A legfelső szintű status értéke completed, amint minden bejegyzés lezárult, és legalább egyhez érkezett lelet.
object[]
kötelező
Klinikai biomarker-eredmények tömbje.
object[]
kötelező
Genetikai biomarker-eredmények tömbje.
object[]
kötelező
Laborlelet-dokumentumok. Az egyes fájlok letöltéséhez használd a GET /api/v1/documents/{id} végpontot.

Ismételt hívások

Az Aniva API-kulcsonként 60 percig tárolja ennek a végpontnak a válaszát. Az ezen időn belüli ismételt hívás a tárolt választ kapja vissza, amíg az otthoni tesztkészlet-rendelés és az eredményei változatlanok. Változás után friss választ kapsz. A Cache-Status és az Age fejlécek mutatják, hogy a válasz tárolt, és mennyi idős. Ha azonnal értesülni szeretnél egy változásról, iratkozz fel a home_kit_order.results.updated, a home_kit_order.results.completed és a home_kit_order.results.fault webhook-eseményekre. Lásd: Ismételt lekérések.

Hibaválaszok