Saltar al contingut principal
POST
Sol·licita una comanda de kit de prova a casa per a un perfil de pacient. Una comanda de kit de prova a casa envia un kit d’autoprova per correu — Aniva envia el kit a l’adreça de lliurament, el pacient recull una mostra ell mateix a casa i la retorna per correu. Això es diferencia d’una cita, que és una extracció de sang venosa en un centre de proves. Cal exactament un panell. Un kit de prova a casa correspon 1:1 a un producte de kit físic — el panell és el kit — i la comanda entra a la cua d’embalatge tan bon punt es crea, de manera que la composició ha de ser definitiva des del principi. Tot i així, pots canviar el panell mitjançant Actualitza la comanda de kit de prova a casa mentre la comanda estigui en estat pending.

Kits de substitució

Quan un kit no pot donar els seus resultats — el pacient no ha pogut omplir el tub, la mostra ha arribat amb massa poc material, el laboratori no l’ha pogut analitzar — demana una substitució enviant replaces_home_kit_order_id. Una substitució és una comanda nova amb un nou codi de laboratori, també quan el primer kit no s’ha activat mai: el laboratori necessita una petició nova i no es poden distingir dues mostres amb el mateix codi. La comanda que substitueixes no es modifica — conserva el seu propi estat, el seu propi codi de laboratori i qualsevol resultat que ja hi estigui registrat. Això implica dues coses:
  • El panell s’hereta. Omet panel_id i la substitució porta el panell de la comanda que substitueix, que és el que va comprar el pacient i la marca que porta la caixa.
  • Tu tries què es torna a analitzar. Envia biomarker_ids amb els marcadors que han fallat i el laboratori només torna a analitzar aquests, així el kit s’envia només amb els tubs que calen. Omet-lo per tornar a analitzar tot el panell.
Els marcadors es tornen a analitzar per grups del panell, no un per un. Si indiques un marcador d’un grup, es torna a analitzar tot el grup, perquè no es pot fer una petició de laboratori que informi de més del que s’ha demanat. Per tant, una substitució d’un sol marcador pot arribar amb més d’un resultat, i el nombre de tubs pot ser superior al que suggereix la llista de marcadors. Només pot haver-hi una substitució en camí per kit alhora.
Si vas fer la integració abans que existissin aquests camps, Aniva també llegeix metadata.original_kit_id i metadata.replacement_reason en crear una comanda i la tracta com a substitució. Aquest és l’únic lloc on s’interpreten les metadades, existeix només per mantenir aquella integració anterior i els camps de dalt sempre tenen prioritat. Envia els camps.
Un 201 vol dir que la comanda queda confirmada i passarà a preparació — no cal que facis res més perquè el kit s’embali i s’enviï. Requereix l’àmbit home_kit_orders_manage. Envia una capçalera opcional Idempotency-Key perquè aquesta creació es pugui reintentar amb seguretat — repetir la mateixa clau retorna la resposta original en lloc de crear-ne una segona. Consulta Idempotència.

Sol·licitud

Paràmetres del cos

string
requerit
UUID del perfil de pacient per al qual es crea la comanda de kit de prova a casa.
string
requerit
UUID del panell del catàleg que vols demanar. Exactament un — un kit de prova a casa correspon 1:1 a un producte de kit físic, de manera que el panell és el kit. Aniva proporciona els ID de panell per al teu compte de col·laborador; consulta Llista els panells. Opcional en una substitució, on pren per defecte el panell de la comanda que substitueixes.
string
UUID de la comanda de kit de prova a casa que aquesta substitueix. Si l’envies, la comanda passa a ser un kit de substitució — consulta Kits de substitució més amunt. La comanda ha de pertànyer al mateix perfil i no pot tenir ja una substitució en camí.
string
Per què cal la substitució, en una frase (per exemple, Zu wenig Material, HbA1c nicht auswertbar). Obligatori quan envies replaces_home_kit_order_id i ignorat en cas contrari. Com a màxim 500 caràcters.
integer[]
En una substitució, els marcadors que el laboratori torna a analitzar — normalment els que el primer kit no ha pogut obtenir. Cada marcador ha de formar part del que demanava la comanda que substitueixes; comprova’ls a Llista els biomarcadors amb home_kit=true. Omet-lo per tornar a analitzar tot el panell. Només s’accepta juntament amb replaces_home_kit_order_id i no juntament amb un panel_id diferent. No requereix cap scope addicional: tornar a analitzar marcadors que el pacient ja ha pagat no és una selecció a la carta.
object
Els teus propis parells clau/valor, retornats literalment en cada lectura i mai interpretats per Aniva. Fes-lo servir per incloure la teva referència de comanda i poder-la correlacionar sense desar els nostres ID. Com a màxim 20 claus; les claus han de coincidir amb [A-Za-z0-9_-] i tenir com a màxim 40 caràcters; els valors són cadenes, nombres o booleans, amb cadenes de com a màxim 500 caràcters; 16.384 bytes serialitzats en total. Les claus que comencen per aniva_ estan reservades. No posis mai dades personals ni clíniques a metadata — no es tracten com a dades de pacient.
string[]
Fins a 5 adreces que reben cadascuna un correu un cop tots els resultats del laboratori són definitius. El correu enllaça a la pàgina de resultats del panell d’administració d’Aniva. La teva clau necessita accés results_view per al pacient; si no, retorna 403. Omet-lo per fer servir les adreces per defecte configurades per al grup del pacient. Una llista buida desactiva els correus. Consulta Correus de resultats disponibles.
object
requerit
L’adreça on s’ha d’enviar el kit per correu — una de dues formes: o bé { location_id } fent referència a un centre de proves conegut, o bé els camps d’adreça directa (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 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.

Resposta

En cas d’èxit, l’API retorna 201 Created amb la nova comanda de kit de prova a casa.
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. Una comanda acabada de crear comença en pending.
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.
object
requerit
Els parells clau/valor que has proporcionat. Sempre present — {} quan no n’has definit cap.
string
La comanda de kit de prova a casa que aquesta substitueix. null en una comanda normal.
string
El motiu que has proporcionat. 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.
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 notificada mitjançant Activa. null fins que s’activi el kit.
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 — el que has proporcionat com a panel_id, registrat amb l’hora de creació de la comanda. Sempre exactament un. Consulta els detalls del panell (nom, biomarcadors) a Llista els panells.
HomeKitOrderIndividualBiomarker[]
requerit
Biomarcadors associats fora del panell. Buit en una creació normal — les comandes de kit de prova a casa es demanen per panell, i modificar aquesta llista després requereix el scope de capacitat home_kit_orders_individual_biomarker_selection. En una substitució conté els biomarker_ids que has enviat, que són els que el laboratori torna a analitzar.
HomeKitOrderShipmentLink[]
requerit
Paquets vinculats a aquesta comanda de kit de prova a casa, començant pel vincle més antic. Sempre buit en crear-la — llegeix els paquets complets amb Llista els enviaments i ?home_kit_order_id=.

Respostes d’error