Saltar al contingut principal
GET
Obtén una única comanda de kit de prova a casa pel seu UUID, amb el perfil del pacient integrat. Fes servir aquest punt final per comprovar l’estat de la comanda, revisar l’adreça de lliurament o consultar els panells i biomarcadors associats. Requereix l’àmbit home_kit_orders_view o home_kit_orders_manage.

Sol·licitud

Paràmetres de ruta

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

Resposta

En cas d’èxit, l’API retorna 200 OK amb la comanda de kit de prova a casa i el seu perfil integrat.
string
requerit
Identificador únic de la comanda de kit de prova a casa (UUID).
string
requerit
UUID del perfil al qual pertany aquesta comanda de kit de prova a casa.
string
requerit
Estat actual de la comanda de kit de prova a casa. Pot ser pending, dispatched, activated o cancelled. El grau de compleció dels resultats de laboratori s’obté a Obtén els resultats.
object
requerit
L’adreça on enviar el kit per correu — pot tenir dues formes: o bé { location_id }, que fa referència a una ubicació de prova coneguda, o bé els camps d’adreça directes (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email opcionals — el mateix vocabulari que l’API d’ubicacions). Proporciona’n exactament una — una referència d’ubicació o una adreça directa, no pas totes dues.
string
Codi de mostra del laboratori amb què s’informen els resultats — imprès al kit físic, i el que el pacient llegeix de la caixa com a codi d’activació. null fins que el kit estigui empaquetat. Només de lectura.
string
requerit
Marca de temps de la recollida informada mitjançant Activa — quan el pacient va recollir la mostra. null fins que el kit estigui activat.
string
La comanda de kit de prova a casa que aquesta substitueix, quan és un kit de substitució. null en una comanda normal. Consulta Crea una comanda de kit de prova a casa.
string
Motiu pel qual s’ha enviat la substitució. null en una comanda normal.
string[]
requerit
Adreces que reben un correu electrònic cadascuna quan tots els resultats del laboratori són definitius, en minúscules. Buit quan està desactivat. Consulta Correus electrònics de resultats a punt.
object
requerit
Parells clau/valor definits pel col·laborador, retornats literalment. Sempre present — {} quan no s’ha definit.
string
requerit
Marca de temps ISO 8601 de quan es va crear la comanda de kit de prova a casa.
string
Marca de temps ISO 8601 de l’última actualització. Pot ser null.
object
requerit
El perfil del pacient associat a aquesta comanda de kit de prova a casa.
HomeKitOrderPanel[]
requerit
El panell associat a aquesta comanda de kit de prova a casa — sempre n’hi ha exactament un (un kit de prova a casa correspon 1:1 a un kit físic), i es pot canviar amb Actualitza mentre és pending. Consulta els detalls del panell (nom, biomarcadors) a Llista els panells.
HomeKitOrderIndividualBiomarker[]
requerit
Biomarcadors a la carta associats a aquesta comanda de kit de prova a casa fora de qualsevol panell. Creua cada biomarker_id amb Llista els biomarcadors amb home_kit=true per obtenir les dades de visualització.
HomeKitOrderShipmentLink[]
requerit
Paquets vinculats a aquesta comanda de kit de prova a casa, primer el més antic — normalment el kit cap al pacient i la mostra de tornada al laboratori. Buit fins que logística imprimeixi una etiqueta. Consulta els paquets complets amb Llista els enviaments i ?home_kit_order_id=.

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 no canviï. 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.created i a l’esdeveniment de cada estat, per exemple home_kit_order.activated. Consulta Lectures repetides.

Respostes d’error