Saltar al contenido principal
GET
Obtén un único pedido de kit de prueba en casa por su UUID, incluido el perfil integrado del paciente. Usa este endpoint para comprobar el estado del pedido, revisar la dirección de entrega o consultar los paneles y biomarcadores asociados. Requiere el ámbito home_kit_orders_view o home_kit_orders_manage.

Solicitud

Parámetros de ruta

string
requerido
Identificador único (UUID) del pedido de kit de prueba en casa que quieres obtener.

Respuesta

Si la solicitud tiene éxito, la API devuelve 200 OK con el pedido de kit de prueba en casa y su perfil integrado.
string
requerido
Identificador único del pedido de kit de prueba en casa (UUID).
string
requerido
UUID del perfil al que pertenece este pedido de kit de prueba en casa.
string
requerido
Estado actual del pedido de kit de prueba en casa. Puede ser pending, dispatched, activated o cancelled. El grado de finalización de los resultados de laboratorio se obtiene de Obtener resultados.
object
requerido
La dirección a la que se envía el kit, con uno de estos dos formatos: { location_id } para referenciar una ubicación de pruebas conocida, o los campos de dirección en línea (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email opcionales, con el mismo vocabulario que la API de ubicaciones). Indica exactamente uno: una referencia de ubicación o una dirección en línea, no ambos.
string
Código de muestra de laboratorio bajo el que se notifican los resultados: viene impreso en el kit físico y es lo que el paciente lee en la caja como código de activación. null hasta que se empaqueta el kit. Solo lectura.
string
requerido
Marca de tiempo de la recogida notificada mediante Activar: cuándo recogió la muestra el paciente. null hasta que se activa el kit.
string
El pedido de kit de prueba en casa al que sustituye este, cuando se trata de un kit de sustitución. null en un pedido normal. Consulta Crear pedido de kit de prueba en casa.
string
Motivo por el que se envió la sustitución. null en un pedido normal.
string[]
requerido
Direcciones que reciben un correo cada una cuando todos los resultados de laboratorio son definitivos, en minúsculas. Vacío cuando está desactivado. Consulta Correos de resultados listos.
object
requerido
Pares clave/valor definidos por el socio, devueltos tal cual. Siempre presente: {} si no se ha definido.
string
requerido
Marca de tiempo ISO 8601 de cuándo se creó el pedido de kit de prueba en casa.
string
Marca de tiempo ISO 8601 de la última actualización. Puede ser null.
object
requerido
El perfil de paciente asociado a este pedido de kit de prueba en casa.
HomeKitOrderPanel[]
requerido
El panel asociado a este pedido de kit de prueba en casa — siempre es exactamente uno (un kit de prueba en casa corresponde 1:1 a un kit físico) y puede cambiarse con Actualizar mientras esté en pending. Consulta los detalles del panel (nombre, biomarcadores) en Listar paneles.
HomeKitOrderIndividualBiomarker[]
requerido
Biomarcadores a la carta asociados a este pedido de kit de prueba en casa fuera de cualquier panel. Cruza cada biomarker_id con Listar biomarcadores usando home_kit=true para obtener los datos de visualización.
HomeKitOrderShipmentLink[]
requerido
Paquetes vinculados a este pedido de kit de prueba en casa, del vínculo más antiguo al más reciente — normalmente el kit enviado al paciente y la muestra de vuelta al laboratorio. Queda vacío hasta que logística imprime una etiqueta. Consulta los paquetes completos con Listar envíos y ?home_kit_order_id=.

Llamadas repetidas

Aniva guarda la respuesta de este endpoint durante 60 minutos para cada clave de API. Una llamada repetida dentro de este plazo recibe la respuesta guardada mientras el pedido de kit de prueba en casa no cambie. Tras un cambio, recibes una respuesta nueva. Las cabeceras Cache-Status y Age muestran que la respuesta está guardada y su antigüedad. Para enterarte de un cambio al instante, suscríbete a los eventos de webhook home_kit_order.created y al evento de cada estado, por ejemplo home_kit_order.activated. Consulta Lecturas repetidas.

Respuestas de error