Przejdź do głównej treści
GET
Pobierz kliniczne i genetyczne wyniki laboratoryjne dla zamówienia domowego zestawu testowego wraz z odwołaniami do dokumentów PDF z raportami laboratoryjnymi. Każdy biomarker zamówiony w zestawie pojawia się w odpowiedzi, dzięki czemu możesz śledzić całe zamówienie, a nie tylko to, co już wróciło. Wyniki są przypisywane do lab_code zamówienia — zlecenie laboratoryjne składane jest przy aktywacji, a laboratorium raportuje markery pojedynczo w miarę ich analizy, więc częściowa odpowiedź jest normalna, a nadrzędny status pozostaje in_progress aż do raportu końcowego. Sprawdź status każdego wyniku, zanim użyjesz jego value:
  • Badania, które jeszcze nie zostały wykonane, mają status planned, gdy zamówienie ma status in_progress. Możesz wywołać ten endpoint przed aktywacją — każdy zamówiony marker ma wtedy status planned.
  • Wyniki dostarczone przez laboratorium, których nie wolno używać klinicznie, mają status fault lub undeliverable oraz pole status_reason wyjaśniające powód. Wynik ze statusem fault nadal ma wypełnione pole value — ta wartość jest błędna. Nigdy nie przedstawiaj jej jako wyniku badania.
  • Wyniki budzące wątpliwości Aniva lub użytkownika mają status likely_wrong i pole status_reason. Wartość nie jest potwierdzona. Nie pokazuj jej jako wyniku badania bez weryfikacji.
Użyj Pobierz dokument, aby pobrać pliki PDF raportów laboratoryjnych wskazane w tablicy documents. Nie musisz odpytywać tego endpointu. Zasubskrybuj webhooki home_kit_order.results.updated lub home_kit_order.results.completed i wywołuj go, gdy nadejdzie zdarzenie. Odpytywanie nadal działa jako rozwiązanie zapasowe. Wymaga zakresu results_view — wyniki laboratoryjne i dokumenty zawsze go wymagają, tak samo jak wyniki wizyty i Pobierz dokument — oraz zakresu home_kit_orders_view lub home_kit_orders_manage do dostępu do samego zamówienia zestawu.

Żądanie

Parametry ścieżki

string
wymagane
Unikalny identyfikator (UUID) zamówienia domowego zestawu testowego, dla którego chcesz pobrać wyniki.

Odpowiedź

W razie powodzenia API zwraca 200 OK wraz z obiektem wyników.
string
wymagane
Ogólny status wyników. Jedna z wartości:
  • in_progress — część zleceń jest jeszcze w laboratorium.
  • completed — wszystkie zlecenia zostały zamknięte i co najmniej jedno zwróciło wyniki.
  • fault — wszystkie zlecenia zakończyły się błędem bez raportu. Nie ma już nic zaległego.
object[]
wymagane
Jeden wpis na każde zlecenie laboratoryjne — pobranie krwi obejmujące kilka probówek lub laboratoriów ma ich kilka. Nadrzędny status ma wartość completed, gdy każdy wpis został zamknięty i jeden zwrócił raport.
object[]
wymagane
Tablica klinicznych wyników biomarkerów.
object[]
wymagane
Tablica genetycznych wyników biomarkerów.
object[]
wymagane
Dokumenty raportów laboratoryjnych. Użyj GET /api/v1/documents/{id}, aby pobrać każdy plik.

Powtarzane wywołania

Aniva przechowuje odpowiedź tego endpointu przez 60 minut dla każdego klucza API. Ponowne wywołanie w tym czasie zwraca zapisaną odpowiedź, dopóki zamówienie domowego zestawu testowego i jego wyniki się nie zmienią. Po zmianie otrzymasz świeżą odpowiedź. Nagłówki Cache-Status i Age pokazują, że odpowiedź jest zapisana i jaki jest jej wiek. Aby dowiedzieć się o zmianie od razu, zasubskrybuj zdarzenia webhooka home_kit_order.results.updated, home_kit_order.results.completed oraz home_kit_order.results.fault. Zobacz Powtarzane odczyty.

Odpowiedzi z błędami