Salt la conținutul principal
POST
Solicită o comandă de kit de testare la domiciliu pentru un profil de pacient. O comandă de kit de testare la domiciliu trimite un kit de autotestare prin poștă — Aniva expediază kitul la adresa de livrare, pacientul își recoltează singur proba acasă și o trimite înapoi prin poștă. Aceasta diferă de o programare, care este o recoltare venoasă de sânge într-o locație de testare. Este necesar exact un panel. Un kit de testare la domiciliu corespunde 1:1 unui produs fizic — panelul este kitul — iar comanda intră în coada de ambalare imediat ce este creată, așa că compoziția trebuie să fie finală de la început. Poți totuși să schimbi panelul prin Actualizează comanda de kit de testare la domiciliu cât timp comanda este pending.

Kituri de înlocuire

Când un kit nu poate oferi rezultatele — pacientul nu a putut umple tubul, proba a ajuns cu prea puțin material, laboratorul nu a putut să o analizeze — comandă un kit de înlocuire trimițând replaces_home_kit_order_id. Un kit de înlocuire este o comandă nouă cu un cod de laborator nou, chiar și atunci când primul kit nu a fost activat niciodată: laboratorul are nevoie de o cerere nouă, iar două probe cu același cod nu pot fi diferențiate. Comanda pe care o înlocuiești rămâne neatinsă — își păstrează propriul status, propriul cod de laborator și toate rezultatele deja înregistrate pentru ea. De aici decurg două lucruri:
  • Panelul este moștenit. Omite panel_id și kitul de înlocuire preia panelul comenzii pe care o înlocuiește, adică ceea ce a cumpărat pacientul și modul în care este personalizată cutia.
  • Tu alegi ce se reanalizează. Trimite biomarker_ids cu markerii care au eșuat, iar laboratorul îi reanalizează doar pe aceia, astfel încât kitul este expediat doar cu tuburile necesare. Omite-l pentru a reanaliza întregul panel.
Markerii sunt reanalizați pe grupurile panelului, nu unul câte unul. Indicarea unui singur marker dintr-un grup duce la reanalizarea întregului grup, deoarece nu poate fi plasată o comandă de laborator care raportează mai mult decât s-a cerut. Prin urmare, un kit de înlocuire pentru un singur marker poate sosi cu mai mult de un rezultat, iar numărul de tuburi poate fi mai mare decât sugerează lista de markeri. Pentru fiecare kit poate fi pe drum un singur kit de înlocuire la un moment dat.
Dacă ai făcut integrarea înainte să existe aceste câmpuri, Aniva citește și metadata.original_kit_id și metadata.replacement_reason la creare și tratează comanda ca pe un kit de înlocuire. Acesta este singurul loc în care metadatele sunt interpretate, există doar pentru a susține acea integrare anterioară, iar câmpurile de mai sus au întotdeauna prioritate. Trimite câmpurile.
Un 201 înseamnă că s-a confirmat comanda și că va fi predată către logistică — nu trebuie să mai faci nimic altceva pentru ca kitul să fie ambalat și expediat. Necesită scope-ul home_kit_orders_manage. Trimite un antet opțional Idempotency-Key pentru ca această creare să poată fi reîncercată în siguranță — repetarea aceleiași chei returnează răspunsul inițial în loc să creeze încă una. Vezi Idempotență.

Cerere

Parametri de corp

string
obligatoriu
UUID-ul profilului de pacient pentru care creezi comanda de kit de testare la domiciliu.
string
obligatoriu
UUID-ul panelului din catalog pe care îl comanzi. Exact unul — un kit de testare la domiciliu corespunde 1:1 unui produs fizic, așa că panelul este kitul. ID-urile panelurilor sunt oferite de Aniva pentru contul tău de partener; vezi Listează panelurile. Opțional pentru un kit de înlocuire, unde folosește implicit panelul comenzii pe care o înlocuiești.
string
UUID-ul comenzii de kit de testare la domiciliu pe care o înlocuiește aceasta. Trimiterea lui transformă comanda într-un kit de înlocuire — vezi Kituri de înlocuire mai sus. Comanda trebuie să aparțină aceluiași profil și să nu aibă deja un kit de înlocuire pe drum.
string
Motivul pentru care este necesară înlocuirea, într-o singură propoziție (de exemplu Zu wenig Material, HbA1c nicht auswertbar). Obligatoriu când trimiți replaces_home_kit_order_id și ignorat în rest. Cel mult 500 de caractere.
integer[]
La un kit de înlocuire, markerii pe care laboratorul îi reanalizează — de obicei cei pe care primul kit nu i-a putut oferi. Fiecare trebuie să facă parte din ce a solicitat comanda pe care o înlocuiești; verifică în Listează biomarkerii cu home_kit=true. Omite-l pentru a reanaliza întregul panel. Este acceptat doar împreună cu replaces_home_kit_order_id și nu împreună cu un alt panel_id. Nu necesită un scope suplimentar: reanalizarea markerilor pe care pacientul i-a plătit deja nu este o selecție à-la-carte.
object
Propriile tale perechi cheie/valoare, returnate identic la fiecare citire și niciodată interpretate de Aniva. Folosește acest câmp pentru a transmite referința comenzii tale, astfel încât să poți face corelarea fără să stochezi ID-urile noastre. Cel mult 20 de chei; cheile respectă [A-Za-z0-9_-] și au cel mult 40 de caractere; valorile sunt șir de caractere, număr sau valoare booleană, cu șiruri de cel mult 500 de caractere; 16.384 de bytes serializați în total. Cheile care încep cu aniva_ sunt rezervate. Nu pune niciodată date personale sau clinice în metadata — nu este tratat ca date ale pacientului.
string[]
Până la 5 adrese care primesc fiecare câte un email odată ce toate rezultatele de laborator sunt finale. Emailul conține un link către pagina de rezultate din panoul de administrare Aniva. Cheia ta are nevoie de acces results_view pentru pacient, altfel returnează 403. Omite câmpul pentru a folosi adresele implicite setate pentru grupul pacientului. O listă goală dezactivează emailurile. Vezi Emailuri când rezultatele sunt gata.
object
obligatoriu
Adresa la care se trimite kitul prin poștă — una dintre două forme: fie { location_id } care face referire la o locație de testare cunoscută, fie câmpurile de adresă inline (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email opționale — același vocabular ca în API-ul de locații). Trimite exact una dintre ele — o referință la o locație sau o adresă inline, nu ambele.
Packstation sau Postfiliale (doar în Germania): setează street la Packstation sau Postfiliale, house_number la numărul de trei cifre al stației și address_line_2 la DHL Postnummer al destinatarului (6–10 cifre, spațiile sunt permise). Fără Postnummer, expedierea coletului nu poate fi înregistrată. Postfach nu este acceptat.

Răspuns

În caz de succes, API-ul returnează 201 Created cu noua comandă de kit de testare la domiciliu.
string
obligatoriu
Identificatorul unic (UUID) al comenzii de kit de testare la domiciliu.
string
obligatoriu
UUID-ul profilului căruia îi aparține această comandă de kit de testare la domiciliu.
string
obligatoriu
Statusul actual al comenzii de kit de testare la domiciliu. Una dintre valorile pending, dispatched, activated sau cancelled. O comandă nou creată pornește cu statusul pending.
object
obligatoriu
Adresa la care se trimite kitul — în una dintre două forme: fie { location_id } cu referire la o locație de testare cunoscută, fie câmpurile de adresă inline (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email opționale — același vocabular ca în API-ul de locații). Furnizează exact una dintre ele — o referință de locație sau o adresă inline, nu ambele.
object
obligatoriu
Perechile cheie/valoare pe care le-ai trimis. Întotdeauna prezent — {} când nu setezi niciuna.
string
Comanda de kit de testare la domiciliu pe care o înlocuiește aceasta. null pentru o comandă obișnuită.
string
Motivul pe care l-ai furnizat. null pentru o comandă obișnuită.
string[]
obligatoriu
Adresele care primesc fiecare câte un e-mail când toate rezultatele de laborator sunt finale, cu litere mici. Gol când este dezactivat. Vezi E-mailuri pentru rezultate gata.
string
Codul de probă de laborator sub care sunt raportate rezultatele — tipărit pe kitul fizic, pe care pacientul îl citește de pe cutie ca cod de activare. null până când kitul este ambalat. Doar citire.
string
obligatoriu
Marca temporală a recoltării raportată prin Activează. null până când kitul este activat.
string
obligatoriu
Marcajul temporal ISO 8601 al momentului în care a fost creată comanda de kit de testare la domiciliu.
string
Timestamp ISO 8601 al ultimei actualizări. Poate fi null.
object
obligatoriu
Profilul pacientului asociat acestei comenzi de kit de testare la domiciliu.
HomeKitOrderPanel[]
obligatoriu
Panelul atașat acestei comenzi de kit de testare la domiciliu — cel pe care l-ai trimis ca panel_id, înregistrat cu ora creării comenzii. Întotdeauna exact unul. Consultă detaliile panelului (nume, biomarkeri) prin Listează panelurile.
HomeKitOrderIndividualBiomarker[]
obligatoriu
Biomarkeri atașați în afara panelului. Gol la o creare obișnuită — comenzile de kit de testare la domiciliu se comandă pe panel, iar modificarea ulterioară a acestei liste necesită scope-ul de capabilitate home_kit_orders_individual_biomarker_selection. La un kit de înlocuire conține biomarker_ids pe care i-ai trimis, adică ceea ce reanalizează laboratorul.
HomeKitOrderShipmentLink[]
obligatoriu
Colete asociate acestei comenzi de kit de testare la domiciliu, în ordinea vechimii asocierii. Întotdeauna gol la creare — citește coletele complete cu Listează expedierile și ?home_kit_order_id=.

Răspunsuri de eroare