Přejít na hlavní obsah
GET
Načti klinické a genetické laboratorní výsledky pro objednávku domácí testovací sady spolu s odkazy na PDF dokumenty laboratorních zpráv. V odpovědi se objeví každý biomarker objednaný pro sadu, takže můžeš sledovat celou objednávku, nejen to, co už přišlo. Výsledky se evidují pod lab_code objednávky — laboratorní objednávka se zadává při aktivaci a laboratoř hlásí jednotlivé markery postupně podle toho, jak je analyzuje, takže částečná odpověď je normální a hlavní status zůstává in_progress až do závěrečné zprávy. U každého výsledku nejdřív zkontroluj status, než použiješ jeho value:
  • Testy, na které se stále čeká, mají stav planned, dokud je objednávka ve stavu in_progress. Tento endpoint můžeš zavolat i před aktivací — každý objednaný marker má pak stav planned.
  • Výsledky, které laboratoř dodala, ale které se nesmí klinicky použít, mají stav fault nebo undeliverable a obsahují status_reason s vysvětlením proč. Výsledek se stavem fault má stále vyplněnou hodnotu value — tato hodnota je chybná. Nikdy ji neuváděj jako nález.
  • Výsledky, o kterých má Aniva nebo člen pochybnosti, mají stav likely_wrong a status_reason. Hodnota není potvrzená. Nezobrazuj ji jako nález bez kontroly.
Ke stažení PDF laboratorních zpráv uvedených v poli documents použij Stáhnout dokument. Tento endpoint nemusíš opakovaně dotazovat. Přihlas se k odběru webhooků home_kit_order.results.updated nebo home_kit_order.results.completed a zavolej ho, až dorazí událost. Opakované dotazování dál funguje jako záloha. Vyžaduje rozsah results_view — laboratorní výsledky a dokumenty jsou jím vždy chráněné, stejně jako výsledky z termínu a Stáhnout dokument — plus rozsah home_kit_orders_view nebo home_kit_orders_manage pro přístup k samotné objednávce sady.

Požadavek

Parametry cesty

string
povinné
Jedinečný identifikátor (UUID) objednávky domácí testovací sady, pro kterou chceš načíst výsledky.

Odpověď

Při úspěchu vrátí API 200 OK s objektem výsledků.
string
povinné
Celkový stav výsledků. Jedna z hodnot:
  • in_progress — některé žádanky jsou stále v laboratoři.
  • completed — všechny žádanky jsou uzavřené a alespoň jedna dodala výsledky.
  • fault — všechny žádanky skončily bez výsledků. Nic dalšího už nepřijde.
object[]
povinné
Jeden záznam na každou laboratorní žádanku — odběr krve rozdělený do více zkumavek nebo laboratoří jich má několik. Hlavní status je completed, jakmile jsou všechny záznamy uzavřené a alespoň jeden dodal výsledky.
object[]
povinné
Pole klinických výsledků biomarkerů.
object[]
povinné
Pole genetických výsledků biomarkerů.
object[]
povinné
Dokumenty laboratorních zpráv. Jednotlivé soubory stáhneš pomocí GET /api/v1/documents/{id}.

Opakovaná volání

Aniva ukládá odpověď tohoto endpointu pro každý API klíč na 60 minut. Opakované volání během této doby dostane uloženou odpověď, dokud se objednávka domácí testovací sady a její výsledky nezmění. Po změně dostaneš čerstvou odpověď. Hlavičky Cache-Status a Age ukazují, že je odpověď uložená a jak je stará. Pokud se chceš o změně dozvědět hned, přihlas se k odběru webhook událostí home_kit_order.results.updated, home_kit_order.results.completed a home_kit_order.results.fault. Viz Opakované čtení.

Chybové odpovědi