Pāriet uz galveno saturu
POST
Pieprasi mājas testa komplekta pasūtījumu pacienta profilam. Mājas testa komplekta pasūtījums nosūta pa pastu piegādājamu pašveicamu testa komplektu — Aniva nosūta komplektu uz piegādes adresi, pacients mājās pats paņem paraugu un nosūta to atpakaļ pa pastu. Tas atšķiras no pieraksta, kas ir venoza asins paņemšana testēšanas vietā. Nepieciešams tieši viens panelis. Mājas testa komplekts atbilst fiziskam komplekta produktam attiecībā 1:1 — panelis ir komplekts —, un pasūtījums nonāk pakošanas rindā uzreiz pēc izveides, tāpēc sastāvam jābūt galīgam jau sākotnēji. Tu joprojām vari nomainīt paneli, izmantojot Atjaunināt mājas testa komplekta pasūtījumu, kamēr pasūtījums ir statusā pending.

Aizvietošanas komplekti

Ja ar komplektu nevar iegūt rezultātus — pacients nevarēja piepildīt stobriņu, paraugs pienāca ar pārāk maz materiāla, laboratorija nevarēja to analizēt —, pasūti aizvietojumu, nosūtot replaces_home_kit_order_id. Aizvietojums ir jauns pasūtījums ar jaunu laboratorijas kodu, arī tad, ja pirmais komplekts nekad netika aktivizēts: laboratorijai nepieciešams jauns nosūtījums, un divus paraugus ar vienu kodu nevar atšķirt. Pasūtījums, ko aizvieto, netiek skarts — tas saglabā savu statusu, savu laboratorijas kodu un visus tam jau pievienotos rezultātus. No tā izriet divas lietas:
  • Panelis tiek mantots. Nenorādi panel_id, un aizvietojums pārņems aizvietojamā pasūtījuma paneli, ko pacients iegādājās un kam atbilst kastes noformējums.
  • Tu izvēlies, ko analizēt atkārtoti. Nosūti biomarker_ids ar marķieriem, kas neizdevās, un laboratorija atkārtoti analizēs tikai tos, tāpēc komplektā tiks nosūtīti tikai tiem nepieciešamie stobriņi. Nenorādi to, lai atkārtoti analizētu visu paneli.
Marķieri tiek atkārtoti analizēti pa paneļa grupām, nevis pa vienam. Norādot vienu grupas marķieri, tiek atkārtoti analizēta visa grupa, jo nevar veikt laboratorijas pasūtījumu, kas ziņo vairāk, nekā pieprasīts. Tāpēc viena marķiera aizvietojums var pienākt ar vairāk nekā vienu rezultātu, un tā stobriņu skaits var būt lielāks, nekā liek domāt marķieru saraksts. Vienlaikus ceļā var būt tikai viens aizvietojums vienam komplektam.
Ja integrēji pirms šo lauku ieviešanas, Aniva izveides brīdī nolasa arī metadata.original_kit_id un metadata.replacement_reason un apstrādā pasūtījumu kā aizvietojumu. Šī ir vienīgā vieta, kur metadati tiek interpretēti, tā pastāv tikai šīs agrākās integrācijas uzturēšanai, un iepriekš minētie lauki vienmēr ir prioritāri. Sūti laukus.
201 nozīmē, ka pasūtījums ir apstiprināts un tiks nodots izpildei — tev nekas cits nav jādara, lai komplekts tiktu sapakots un nosūtīts. Nepieciešams home_kit_orders_manage tvērums. Nosūti neobligātu Idempotency-Key galveni, lai šo izveides pieprasījumu varētu droši atkārtot — atkārtojot to pašu atslēgu, tiek atgriezta sākotnējā atbilde, nevis izveidots otrs pieraksts. Skati Idempotence.

Pieprasījums

Pieprasījuma satura parametri

string
obligāts
Pacienta profila UUID, kuram izveidot mājas testa komplekta pasūtījumu.
string
obligāts
Pasūtāmā kataloga paneļa UUID. Tieši viens — mājas testa komplekts atbilst fiziskam komplekta produktam attiecībā 1:1, tāpēc panelis ir komplekts. Paneļu ID tavam partnera kontam piešķir Aniva; skati Paneļu sarakstu. Nav obligāts aizvietojumam, kur pēc noklusējuma tiek izmantots aizvietojamā pasūtījuma panelis.
string
Tā mājas testa komplekta pasūtījuma UUID, kuru šis aizvieto. Tā nosūtīšana padara šo par aizvietošanas komplektu — skati Aizvietošanas komplekti iepriekš. Pasūtījumam jāpieder tam pašam profilam, un tam nedrīkst jau būt ceļā aizvietojums.
string
Kāpēc nepieciešams aizvietojums, vienā teikumā (piemēram, Zu wenig Material, HbA1c nicht auswertbar). Obligāts, ja nosūti replaces_home_kit_order_id, citādi tiek ignorēts. Ne vairāk kā 500 rakstzīmju.
integer[]
Aizvietojumam — marķieri, kurus laboratorija analizēs atkārtoti, parasti tie, kurus ar pirmo komplektu nevarēja iegūt. Katram jābūt daļai no tā, kas tika pieprasīts aizvietojamajā pasūtījumā; salīdzini ar Biomarķieru sarakstu ar home_kit=true. Nenorādi to, lai atkārtoti analizētu visu paneli. Tiek pieņemts tikai kopā ar replaces_home_kit_order_id un ne kopā ar citu panel_id. Tam nav nepieciešams papildu tvērums: tādu marķieru atkārtota analīze, par kuriem pacients jau samaksāja, nav individuāla izvēle.
object
Tavi atslēgu/vērtību pāri, kas katrā nolasīšanā tiek atgriezti bez izmaiņām un ko Aniva nekad neinterpretē. Izmanto tos, lai pievienotu savu pasūtījuma atsauci un varētu tos sasaistīt, neglabājot mūsu ID. Ne vairāk kā 20 atslēgu; atslēgas atbilst [A-Za-z0-9_-] un ir ne garākas par 40 rakstzīmēm; vērtības ir virkne, skaitlis vai būla vērtība, turklāt virknes ir ne garākas par 500 rakstzīmēm; kopā serializētā veidā 16 384 baiti. Atslēgas, kas sākas ar aniva_, ir rezervētas. Nekad neievieto personas vai klīniskos datus laukā metadata — tie netiek apstrādāti kā pacienta dati.
string[]
Līdz 5 adresēm, no kurām katra saņem vienu e-pastu, kad visi laboratorijas rezultāti ir galīgi. E-pastā ir saite uz rezultātu lapu Aniva administrēšanas panelī. Tavai atslēgai nepieciešama results_view piekļuve pacientam, pretējā gadījumā tiks atgriezts 403. Izlaid šo lauku, lai izmantotu pacienta grupai iestatītās noklusējuma adreses. Tukšs saraksts izslēdz šos e-pastus. Skati E-pasti par gataviem rezultātiem.
object
obligāts
Adrese, uz kuru nosūtīt komplektu — viena no divām formām: vai nu { location_id }, kas norāda uz zināmu testēšanas vietu, vai tiešie adreses lauki (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email nav obligāti — tā pati terminoloģija kā vietu API). Norādi tieši vienu — atsauci uz vietu vai tiešo adresi, nevis abas.
Packstation vai Postfiliale (tikai Vācijā): iestati street uz Packstation vai Postfiliale, house_number uz trīsciparu stacijas numuru un address_line_2 uz saņēmēja DHL Postnummer (6–10 cipari, atstarpes atļautas). Bez Postnummer sūtījumu nevar noformēt. Postfach netiek atbalstīts.

Atbilde

Veiksmīgas izpildes gadījumā API atgriež 201 Created ar jauno mājas testa komplekta pasūtījumu.
string
obligāts
Unikālais mājas testa komplekta pasūtījuma identifikators (UUID).
string
obligāts
Tā profila UUID, kuram pieder šis mājas testa komplekta pasūtījums.
string
obligāts
Pašreizējais mājas testa komplekta pasūtījuma statuss. Viens no pending, dispatched, activated vai cancelled. Tikko izveidots pasūtījums sākas statusā pending.
object
obligāts
Adrese, uz kuru nosūtīt komplektu — vienā no divām formām: vai nu { location_id }, kas atsaucas uz zināmu testēšanas vietu, vai tiešās adreses lauki (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email nav obligāti — tie paši lauki kā atrašanās vietu API). Norādi tieši vienu — atsauci uz vietu vai tiešo adresi, ne abas.
object
obligāts
Tavi norādītie atslēgu/vērtību pāri. Vienmēr iekļauts — {}, ja neesi nevienu norādījis.
string
Mājas testa komplekta pasūtījums, kuru šis aizvieto. Parastam pasūtījumam null.
string
Tavs norādītais iemesls. Parastam pasūtījumam null.
string[]
obligāts
Adreses mazajiem burtiem, no kurām katra saņem vienu e-pastu, tiklīdz visi laboratorijas rezultāti ir galīgi. Tukšs, kad izslēgts. Skatīt E-pasti par gataviem rezultātiem.
string
Laboratorijas parauga kods, zem kura tiek ziņoti rezultāti — uzdrukāts uz fiziskā komplekta, un tas ir kods, ko pacients nolasa no kastītes kā aktivizācijas kodu. null, līdz komplekts ir iepakots. Tikai lasīšanai.
string
obligāts
Parauga paņemšanas laikspiedols, kas ziņots ar Aktivizēt. null, līdz komplekts tiek aktivizēts.
string
obligāts
ISO 8601 laikspiedols, kad tika izveidots mājas testa komplekta pasūtījums.
string
Pēdējā atjauninājuma ISO 8601 laikspiedols. Var būt null.
object
obligāts
Pacienta profils, kas saistīts ar šo mājas testa komplekta pasūtījumu.
HomeKitOrderPanel[]
obligāts
Šim mājas testa komplekta pasūtījumam pievienotais panelis — tas, ko norādīji kā panel_id, ar pasūtījuma izveides laiku. Vienmēr tieši viens. Paneļa informāciju (nosaukumu, biomarķierus) skati Paneļu sarakstā.
HomeKitOrderIndividualBiomarker[]
obligāts
Biomarķieri, kas pievienoti ārpus paneļa. Parastā izveidē tukšs — mājas testa komplektus pasūta pa paneļiem, un šī saraksta mainīšanai vēlāk nepieciešams iespēju tvērums home_kit_orders_individual_biomarker_selection. Aizvietojumā tas satur tavus nosūtītos biomarker_ids, ko laboratorija analizēs atkārtoti.
HomeKitOrderShipmentLink[]
obligāts
Šim mājas testa komplekta pasūtījumam piesaistītie sūtījumi, sākot ar vecāko piesaisti. Izveides brīdī vienmēr tukšs — pilnu sūtījumu informāciju skati Sūtījumu sarakstā ar ?home_kit_order_id=.

Kļūdu atbildes