Saltar al contenido principal
POST
Solicita un pedido de kit de prueba en casa para un perfil de paciente. Un pedido de kit de prueba en casa envía un kit de prueba por correo para hacer en casa: Aniva envía el kit a la dirección de entrega, el paciente se toma la muestra en casa y la devuelve por correo. Esto es distinto de una cita, que es una extracción de sangre venosa en un centro de pruebas. Se requiere exactamente un panel. Un kit de prueba en casa se corresponde 1:1 con un producto de kit físico —el panel es el kit— y el pedido entra en la cola de empaquetado en cuanto se crea, por lo que la composición debe ser definitiva desde el principio. Aun así, puedes cambiar el panel mediante Actualizar pedido de kit de prueba en casa mientras el pedido esté en pending.

Kits de reemplazo

Cuando un kit no pueda dar sus resultados —el paciente no pudo llenar el tubo, la muestra llegó con muy poco material, el laboratorio no pudo analizarla—, pide un reemplazo enviando replaces_home_kit_order_id. Un reemplazo es un pedido nuevo con un nuevo código de laboratorio, incluso cuando el primer kit nunca se activó: el laboratorio necesita una nueva solicitud y no se pueden distinguir dos muestras bajo un mismo código. El pedido que reemplazas no se modifica: mantiene su propio estado, su propio código de laboratorio y cualquier resultado que ya esté registrado en él. Esto implica dos cosas:
  • El panel se hereda. Omite panel_id y el reemplazo llevará el panel del pedido al que reemplaza, que es lo que compró el paciente y la marca que lleva la caja.
  • Tú eliges qué se vuelve a analizar. Envía biomarker_ids con los marcadores que fallaron y el laboratorio volverá a analizar solo esos, para que el kit se envíe solo con los tubos necesarios. Omítelo para volver a analizar el panel completo.
Los marcadores se vuelven a analizar según los grupos del panel, no uno por uno. Indicar un marcador de un grupo hace que se vuelva a analizar todo ese grupo, porque no se puede hacer un pedido de laboratorio que informe más de lo solicitado. Por tanto, un reemplazo de un solo marcador puede llegar con más de un resultado, y el número de tubos puede ser mayor de lo que sugiere la lista de marcadores. Solo puede haber un reemplazo en camino por kit a la vez.
Si hiciste la integración antes de que existieran estos campos, Aniva también lee metadata.original_kit_id y metadata.replacement_reason al crear un pedido y lo trata como un reemplazo. Este es el único lugar donde se interpretan los metadatos, existe solo para mantener esa integración anterior y los campos de arriba siempre prevalecen. Envía los campos.
Un 201 significa que el pedido está confirmado y se pasará a logística: no tienes que hacer nada más para que el kit se empaquete y se envíe. Requiere el scope home_kit_orders_manage. Envía una cabecera opcional Idempotency-Key para que esta creación se pueda reintentar con seguridad: repetir la misma clave devuelve la respuesta original en lugar de crear otra. Consulta Idempotencia.

Solicitud

Parámetros del cuerpo

string
requerido
UUID del perfil de paciente para el que se crea el pedido de kit de prueba en casa.
string
requerido
UUID del panel del catálogo que se va a pedir. Exactamente uno: un kit de prueba en casa se corresponde 1:1 con un producto de kit físico, así que el panel es el kit. Aniva proporciona los ID de panel para tu cuenta de partner; consulta Listar paneles. Opcional en un reemplazo, donde toma por defecto el panel del pedido que reemplazas.
string
UUID del pedido de kit de prueba en casa al que este reemplaza. Enviarlo convierte este pedido en un kit de reemplazo; consulta Kits de reemplazo más arriba. El pedido debe pertenecer al mismo perfil y no debe tener ya un reemplazo en camino.
string
Motivo por el que se necesita el reemplazo, en una frase (por ejemplo, Zu wenig Material, HbA1c nicht auswertbar). Obligatorio cuando envías replaces_home_kit_order_id, e ignorado en caso contrario. Máximo 500 caracteres.
integer[]
En un reemplazo, los marcadores que el laboratorio vuelve a analizar, normalmente los que el primer kit no pudo dar. Cada uno debe formar parte de lo que pidió el pedido que reemplazas; contrasta con Listar biomarcadores con home_kit=true. Omítelo para volver a analizar el panel completo. Solo se acepta junto con replaces_home_kit_order_id, y no junto con un panel_id distinto. Esto no necesita ningún scope adicional: volver a analizar marcadores que el paciente ya pagó no es una selección a la carta.
object
Tus propios pares clave/valor, que se devuelven literalmente en cada lectura y Aniva nunca interpreta. Úsalo para incluir tu referencia de pedido y así poder relacionarlos sin guardar nuestros ID. Máximo 20 claves; las claves deben coincidir con [A-Za-z0-9_-] y tener como máximo 40 caracteres; los valores pueden ser una cadena, un número o un booleano, con cadenas de 500 caracteres como máximo; 16.384 bytes serializados en total. Las claves que empiezan por aniva_ están reservadas. Nunca incluyas datos personales ni clínicos en metadata: no se trata como datos de paciente.
string[]
Hasta 5 direcciones que reciben un correo cada una cuando todos los resultados de laboratorio son definitivos. El correo enlaza a la página de resultados en el panel de administración de Aniva. Tu clave necesita acceso results_view al paciente; si no, devuelve 403. Omítelo para usar las direcciones predeterminadas del grupo del paciente. Una lista vacía desactiva los correos. Consulta Correos de resultados listos.
object
requerido
La dirección a la que se envía el kit por correo, con uno de estos dos formatos: o bien { location_id } haciendo referencia a un centro de pruebas conocido, o bien 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, el mismo vocabulario que la API de ubicaciones). Indica exactamente uno: una referencia a una ubicación o una dirección en línea, no ambos.
Packstation o Postfiliale (solo Alemania): establece street como Packstation o Postfiliale, house_number como el número de estación de tres dígitos y address_line_2 como el Postnummer de DHL del destinatario (6–10 dígitos, se permiten espacios). Sin el Postnummer, no se puede reservar el envío del paquete. No se admite un Postfach.

Respuesta

Si tiene éxito, la API devuelve 201 Created con el nuevo pedido de kit de prueba en casa.
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. Un pedido recién creado empieza en pending.
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.
object
requerido
Los pares clave/valor que proporcionaste. Siempre presente: {} si no indicaste ninguno.
string
El pedido de kit de prueba en casa al que este reemplaza. null en un pedido normal.
string
El motivo que proporcionaste. 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.
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 temporal de la recogida comunicada mediante Activar. null hasta que se active el kit.
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: el que proporcionaste en panel_id, con la marca temporal de creación del pedido. Siempre es exactamente uno. Consulta los detalles del panel (nombre, biomarcadores) mediante Listar paneles.
HomeKitOrderIndividualBiomarker[]
requerido
Biomarcadores asociados fuera del panel. Vacío en una creación normal: los pedidos de kit de prueba en casa se piden por panel, y modificar esta lista después requiere el scope de capacidad home_kit_orders_individual_biomarker_selection. En un reemplazo contiene los biomarker_ids que enviaste, que son los que el laboratorio vuelve a analizar.
HomeKitOrderShipmentLink[]
requerido
Paquetes vinculados a este pedido de kit de prueba en casa, empezando por el vínculo más antiguo. Siempre vacío al crear el pedido: consulta los paquetes completos con Listar envíos y ?home_kit_order_id=.

Respuestas de error