Saltar al contenido principal
PATCH
Actualiza la dirección de entrega, el panel, los metadatos o los correos de resultados listos de un pedido de kit de prueba en casa. Incluye solo los campos que quieras cambiar. La dirección de entrega y el panel solo se pueden cambiar mientras el pedido esté en pending, porque el kit físico sale en el momento del envío. metadata es para tu propio registro y se puede modificar durante toda la vida del pedido. No hay endpoints para añadir o eliminar paneles: un kit de prueba en casa incluye exactamente un panel (se corresponde 1:1 con un producto de kit físico), así que la única operación con sentido para el panel es el cambio que haces aquí. Requiere el scope home_kit_orders_manage.

Solicitud

Parámetros de ruta

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

Parámetros del cuerpo

Todos los parámetros del cuerpo son opcionales — incluye solo los campos que quieras cambiar.
object
La dirección a la que enviar el kit — con uno de estos dos formatos: o bien { location_id } haciendo referencia a una ubicación de pruebas conocida, 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 de 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.
string
UUID del panel que sustituirá al actual — al haber exactamente un panel por kit, un cambio es la única operación con sentido. Solo mientras el pedido esté en pending, y solo por un panel que Aniva haya configurado con un producto de kit de envío (422 en caso contrario); cambiarlo por el panel que ya tiene asignado no tiene efecto.
object
Tus propios pares clave/valor. Se fusionan con los metadatos existentes en lugar de sustituirlos: las claves que omitas se conservan, una clave enviada con valor null se elimina y un objeto vacío {} borra todo. Los límites coinciden con Crear pedido de kit de prueba en casa, y la validación es todo o nada — si se rechaza alguna clave, no se guarda nada. Nunca pongas datos personales ni clínicos en metadata — no se tratan como datos de paciente.
string[]
Sustituye la lista de hasta 5 direcciones que reciben un correo cada una cuando todos los resultados de laboratorio son definitivos. Envía [] para desactivar los correos. Editable en cualquier estado excepto cancelled. Tu clave necesita acceso results_view al paciente; si no, devuelve 403. Consulta Correos de resultados listos.

Respuesta

Si tiene éxito, la API devuelve 200 OK con el pedido de kit de prueba en casa actualizado 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.
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 exactamente uno (un kit de prueba en casa se corresponde 1:1 con un producto de kit físico), que se sustituye directamente cuando pasas panel_id. 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=.

Respuestas de error