Saltar al contingut principal
PATCH
Actualitza l’adreça de lliurament, el panell, les metadades o els correus de resultats disponibles d’una comanda de kit de prova a casa. Inclou només els camps que vulguis canviar. L’adreça de lliurament i el panell només es poden canviar mentre la comanda té l’estat pending, perquè el kit físic s’envia en el moment de l’expedició. metadata serveix per al teu propi registre i es pot modificar durant tota la vida de la comanda. No hi ha punts finals per afegir o eliminar panells: un kit de prova a casa porta exactament un panell (correspon 1:1 a un producte de kit físic), així que l’única operació de panell amb sentit és el canvi que fas aquí. Requereix l’àmbit 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 actualitzar.

Paràmetres del cos

Tots els paràmetres del cos són opcionals — inclou només els camps que vulguis canviar.
object
L’adreça on s’ha d’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 integrats (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email són opcionals — el mateix vocabulari que l’API d’ubicacions). Proporciona’n exactament una — una referència d’ubicació o una adreça integrada, no totes dues.
Packstation o Postfiliale (només a Alemanya): posa Packstation o Postfiliale a street, el número d’estació de tres dígits a house_number i el DHL Postnummer del destinatari (6–10 dígits, s’admeten espais) a address_line_2. Sense el Postnummer, no es pot tramitar l’enviament del paquet. No s’admet un Postfach.
string
UUID del panell que s’ha d’associar en lloc de l’actual — com que cada kit té exactament un panell, un canvi és l’única operació amb sentit. Només mentre la comanda té l’estat pending i només per un panell que Aniva hagi configurat amb un producte de kit d’expedició (422 en cas contrari); canviar pel panell que ja està associat no té cap efecte.
object
Els teus propis parells clau/valor. Es fusionen amb les metadades existents en lloc de substituir-les: les claus que ometis es conserven, una clau enviada amb valor null s’elimina i un objecte buit {} ho esborra tot. Els límits coincideixen amb Crea una comanda de kit de prova a casa, i la validació és de tot o res — si es rebutja qualsevol clau, no s’escriu res. No posis mai dades personals ni clíniques a metadata — no es tracten com a dades de pacient.
string[]
Substitueix la llista de fins a 5 adreces que reben cadascuna un correu quan tots els resultats del laboratori són definitius. Envia [] per desactivar els correus. Es pot editar en tots els estats excepte cancelled. La teva clau necessita accés results_view al pacient; si no, retorna 403. Consulta Correus de resultats disponibles.

Resposta

En cas d’èxit, l’API retorna 200 OK amb la comanda de kit de prova a casa actualitzada i el seu perfil incrustat.
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.
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 producte de kit físic) i se substitueix directament quan passes panel_id. Consulta els detalls del panell (nom, biomarcadors) mitjançant 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=.

Respostes d’error