Pāriet uz galveno saturu
GET
Iegūsti klīniskos un ģenētiskos laboratorijas rezultātus mājas testa komplekta pasūtījumam, kā arī dokumentu atsauces uz laboratorijas pārskatu PDF failiem. Atbildē parādās katrs komplektam pasūtītais biomarķieris, tāpēc vari izsekot visam pasūtījumam, nevis tikai jau saņemtajam. Rezultāti tiek reģistrēti ar pasūtījuma lab_code — laboratorijas pasūtījums tiek izveidots aktivizēšanas brīdī, un laboratorija ziņo par marķieriem atsevišķi, tiklīdz tie ir izanalizēti, tāpēc daļēja atbilde ir normāla un augstākā līmeņa status paliek in_progress līdz galīgajam pārskatam. Pirms izmanto rezultāta value, izlasi katra rezultāta status:
  • Vēl neizpildītie testi parādās ar statusu planned, kamēr pasūtījums ir in_progress. Šo galapunktu vari izsaukt arī pirms aktivizēšanas — tad katrs pasūtītais marķieris ir planned.
  • Rezultāti, kurus laboratorija piegādāja, bet kurus nedrīkst izmantot klīniski, parādās ar statusu fault vai undeliverable un ietver status_reason, kas paskaidro iemeslu. fault rezultātam joprojām ir aizpildīta value — šī vērtība ir nepareiza. Nekad nerādi to kā atradumu.
  • Rezultāti, par kuriem šaubās Aniva vai dalībnieks, parādās ar statusu likely_wrong un status_reason. Vērtība nav apstiprināta. Nerādi to kā atradumu bez pārskatīšanas.
Izmanto Lejupielādēt dokumentu, lai lejupielādētu laboratorijas pārskatu PDF failus, uz kuriem ir atsauces masīvā documents. Tev nav regulāri jāvaicā šis galapunkts. Abonē home_kit_order.results.updated vai home_kit_order.results.completed tīmekļa āķus un izsauc galapunktu, kad pienāk notikums. Regulāra vaicāšana joprojām darbojas kā rezerves variants. Nepieciešams results_view tvērums — laboratorijas rezultāti un dokumenti vienmēr ir pieejami tikai ar to, tāpat kā pieraksta rezultāti un Lejupielādēt dokumentu —, kā arī home_kit_orders_view vai home_kit_orders_manage tvērums, lai piekļūtu pašam komplekta pasūtījumam.

Pieprasījums

Ceļa parametri

string
obligāts
Unikāls identifikators (UUID) mājas testa komplekta pasūtījumam, kuram iegūt rezultātus.

Atbilde

Veiksmes gadījumā API atgriež 200 OK ar rezultātu objektu.
string
obligāts
Kopējais rezultātu statuss. Viens no šiem:
  • in_progress — daži nosūtījumi vēl ir laboratorijā.
  • completed — katrs nosūtījums ir noslēgts, un vismaz viens ir sniedzis pārskatu.
  • fault — visi nosūtījumi beidzās bez pārskata. Nekas nav jāmaksā.
object[]
obligāts
Viens ieraksts katram laboratorijas nosūtījumam — asins paņemšanai vairākos stobriņos vai laboratorijās to ir vairāki. Augstākā līmeņa status ir completed, kad katrs ieraksts ir noslēgts un viens ir sniedzis pārskatu.
object[]
obligāts
Klīnisko biomarķieru rezultātu masīvs.
object[]
obligāts
Ģenētisko biomarķieru rezultātu masīvs.
object[]
obligāts
Laboratorijas pārskatu dokumenti. Lai lejupielādētu katru failu, izmanto GET /api/v1/documents/{id}.

Atkārtoti izsaukumi

Aniva saglabā šī galapunkta atbildi 60 minūtes katrai API atslēgai. Atkārtots pieprasījums šajā laikā saņem saglabāto atbildi, kamēr mājas testa komplekta pasūtījums un tā rezultāti nav mainījušies. Pēc izmaiņām tu saņem svaigu atbildi. Galvenes Cache-Status un Age rāda, ka atbilde ir saglabāta un cik veca tā ir. Lai par izmaiņām uzzinātu uzreiz, abonē tīmekļa āķa notikumus home_kit_order.results.updated, home_kit_order.results.completed un home_kit_order.results.fault. Skati Atkārtota lasīšana.

Kļūdu atbildes