Saltar al contingut principal
GET
Obtén els resultats de laboratori clínics i genètics d’una comanda de kit de prova a casa, juntament amb les referències dels documents PDF dels informes de laboratori. Tots els biomarcadors demanats per al kit apareixen a la resposta, de manera que pots fer el seguiment de tota la comanda i no només del que ja ha arribat. Els resultats s’arxiven sota el lab_code de la comanda — la petició de laboratori es fa en el moment de l’activació, i el laboratori informa dels marcadors individualment a mesura que s’analitzen, així que una resposta parcial és normal i el camp status de nivell superior es manté en in_progress fins a l’informe final. Llegeix status en cada resultat abans de fer servir el seu value:
  • Les proves encara pendents apareixen amb l’estat planned mentre la comanda és in_progress. Pots cridar aquest punt final abans de l’activació — llavors cada marcador demanat apareix com a planned.
  • Els resultats que el laboratori ha lliurat però que no s’han de fer servir clínicament apareixen amb l’estat fault o undeliverable i inclouen un status_reason que explica per què. Un resultat fault encara té value emplenat — aquest valor és erroni. No el presentis mai com una troballa.
  • Els resultats dels quals Aniva o el membre dubten apareixen amb l’estat likely_wrong i un status_reason. El valor no està confirmat. No el mostris com una troballa sense revisió.
Utilitza Descarrega el document per descarregar els PDF d’informes de laboratori referenciats a la matriu documents. No cal que consultis periòdicament aquest punt final. Subscriu-te als webhooks home_kit_order.results.updated o home_kit_order.results.completed, i crida’l quan arribi un esdeveniment. La consulta periòdica continua funcionant com a alternativa. Requereix l’àmbit results_view — els resultats de laboratori i els documents sempre estan protegits per aquest àmbit, igual que els resultats de cites i Descarrega el document — a més de l’àmbit home_kit_orders_view o home_kit_orders_manage per accedir a la comanda del kit.

Sol·licitud

Paràmetres de ruta

string
requerit
Identificador únic (UUID) de la comanda de kit de prova a casa de la qual vols obtenir els resultats.

Resposta

En cas d’èxit, l’API retorna 200 OK amb l’objecte dels resultats.
string
requerit
Estat general dels resultats. Un dels següents:
  • in_progress — algunes peticions encara són al laboratori.
  • completed — totes les peticions s’han tancat i almenys una ha emès informe.
  • fault — totes les peticions han fallat sense emetre informe. No queda res pendent.
object[]
requerit
Una entrada per cada petició de laboratori — una extracció de sang que abasta diversos tubs o laboratoris en té diverses. El camp status de nivell superior és completed quan totes les entrades s’han tancat i una ha emès informe.
object[]
requerit
Matriu de resultats de biomarcadors clínics.
object[]
requerit
Matriu de resultats de biomarcadors genètics.
object[]
requerit
Documents d’informes de laboratori. Fes servir GET /api/v1/documents/{id} per descarregar cada fitxer.

Crides repetides

Aniva desa la resposta d’aquest punt final durant 60 minuts per a cada clau API. Una crida repetida dins d’aquest temps rep la resposta desada mentre la comanda de kit de prova a casa i els seus resultats no canviïn. Després d’un canvi, reps una resposta nova. Les capçaleres Cache-Status i Age mostren que la resposta està desada i quina antiguitat té. Per assabentar-te d’un canvi de seguida, subscriu-te als esdeveniments webhook home_kit_order.results.updated, home_kit_order.results.completed i home_kit_order.results.fault. Consulta Lectures repetides.

Respostes d’error