Pāriet uz galveno saturu
Pieraksts ir ieplānota asins paņemšana pacienta profilam fiziskā testēšanas vietā, ko veic veselības aprūpes speciālists. Komplekti, kas nosūtīti pacientam pa pastu, nav pieraksti — skatīt Mājas testa komplektu pasūtījumi.

Lauki

string
obligāts
Aniva automātiski ģenerēts UUID. Izmanto to, lai pievienotu paneļus, apstiprinātu asins paņemšanu un iegūtu rezultātus.
string
obligāts
Profila UUID, kuram pieder šis pieraksts.
string
Testēšanas vietas UUID, kurā notiks asins paņemšana. Mājas testa komplekti nav pieraksti — skatīt Mājas testa komplektu pasūtījumi.
string
Ieplānotais asins paņemšanas datums un laiks ISO 8601 formātā. Vienmēr tiek atgriezts kā UTC laiks ar Z sufiksu (piem., 2026-04-15T08:30:00Z). Izveides / atjaunināšanas laikā vērtībai jāietver laika joslas norāde (vai nu Z, vai skaidra nobīde, piem., +02:00) — datumi un laiki bez laika joslas tiek noraidīti. Tam jābūt nākotnē, un Aniva pārvaldītajās atrašanās vietās vismaz 12 stundas iepriekš (minimālais pieteikšanas termiņš).
string
obligāts
Pašreizējais dzīves cikla statuss. Viens no: pending, confirmed, blood_drawn vai cancelled. Skatīt Dzīves cikls zemāk. Laboratorijas rezultātu gatavības detalizācija (in_progress vai completed) tiek iegūta no Iegūt rezultātus; detalizētāka sūtījuma virzība (ceļā, piegādāts u. c.) tiek iegūta, sekojot katram ierakstam iekļautajā masīvā shipments uz Iegūt sūtījumu.
string
Brīva teksta iemesls, kas fiksēts pieraksta atcelšanas brīdī (piem., neierašanās, vēla atcelšana, ‘Neizdevās. Nepieciešams atkārtot’). Ir null, ja vien status nav cancelled.
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
obligāts
Asins paņemšanas metode: capillary (no pirksta gala vai augšdelma mikrostobriņos) vai venous (no vēnas stobriņos). Tā ir metode, ko nosaka pieraksts, vai arī tā vietas default_draw_method. Pēc asins paņemšanas tā ir izmantotā metode.
string
obligāts
ISO 8601 laikspiedols, kad pieraksts tika izveidots.
string
Pēdējā atjauninājuma laika zīmogs ISO 8601 formātā. Null, ja pieraksts nekad nav ticis atjaunināts.
string[]
obligāts
Laboratorijas kodi (stobriņu svītrkodi), kas reģistrēti, izsaucot Apstiprināt asins paņemšanu, skenēšanas secībā. Tukšs, līdz asins paņemšana ir apstiprināta. Venozai asins paņemšanai ir viens kods uz katra stobriņa; kapilārai asins paņemšanai ir viens kods uz katru mikrokonteineru. Rezultāti un dokumenti atsaucas uz tiem ar lab_code.
object[]
obligāts
Šim pierakstam pievienotie paneļi kā { panel_id, added_at } ieraksti. Skatīt Paneļu pievienošana.
object[]
obligāts
Atsevišķi izvēlētie biomarķieri, kas pievienoti šim pierakstam, kā { biomarker_id, added_at } ieraksti. Skatīt Atsevišķi biomarķieri.
object[]
obligāts
Šim pierakstam piesaistītie sūtījumi kā { id, added_at } ieraksti, sākot ar vecāko piesaisti. Skatīt Sūtījumu piesaistīšana.
object
obligāts
Pilns pacienta profila objekts, kas iekļauts katrā pieraksta atbildē. Tālāk norādītie lauki ir tikai daļa no tiem. Visi lauki ir uzskaitīti sadaļā Iegūt pierakstu.

Dzīves cikls

Pierakstiem ir četri dzīves cikla stāvokļi:
Pieraksta statusu līmenis ir apzināti vispārīgs — detalizētāka virzība ir pieejama atsevišķos galapunktos:
  • Laboratorijas rezultātu gatavība → Iegūt rezultātus — augšējā līmeņa lauks status ir in_progress vai completed.
  • Sūtījuma virzība (ceļā, piegādāts u. c.) → seko katram ierakstam pierakstā iekļautajā masīvā shipments uz Iegūt sūtījumu — katram sūtījumam ir savs status un status_updates notikumu žurnāls.
Katra statusa izmaiņa nosūta appointment.* webhook paziņojumu, piemēram, appointment.confirmed. Jauns laiks vai atrašanās vieta nosūta appointment.rescheduled.
Pieraksta apstiprināšana (pāreja uz blood_drawn) ir neatgriezeniska. Kad iesniedz laboratorijas kodu vai kodus, tiek palaista laboratorijas pasūtījumu plūsma, un to nevar atsaukt. Atjauninājumi un atcelšana ir atļauta tikai tad, kad pieraksts ir pending vai confirmed statusā.

Pierakstu saraksts

Iegūsti visus tavai API atslēgai pieejamos pierakstus:
Pēc izvēles pievieno ?profile_id={uuid}, lai filtrētu pēc konkrēta profila. Bez šī parametra tiek piemērots noklusējuma laika periods (no pēdējiem 2 mēnešiem līdz nākamajam 1 mēnesim).

Pieraksta atjaunināšana

Pirms asins paņemšana ir apstiprināta, tu vari pārcelt laiku vai mainīt testēšanas vietu:
Lai atjauninātu, nodod jebkuru scheduled_at, location_id, draw_method un results_ready_emails kombināciju. Iekļauj tikai tos laukus, kurus vēlies mainīt.

Asins paņemšanas metode

Katram pierakstam ir draw_method: capillary (no pirksta gala vai augšdelma mikrokonteineros) vai venous (no vēnas stobriņos). Tas attiecas tikai uz asins paņemšanu. Urīna, uztriepes un citi paraugi, kas nav asinis, abos gadījumos tiek paņemti vienādi. Pēc noklusējuma tā ir atrašanās vietas default_draw_method. Iestati draw_method izveides vai atjaunināšanas laikā, lai izmantotu citu metodi, vai iestati to uz null, lai atgrieztos pie atrašanās vietas noklusējuma. Atrašanās vietai šī metode jānorāda laukā draw_methods, un pieteiktajām analīzēm ar to jābūt iespējamām, pretējā gadījumā pieprasījums atgriež 400. Pēc asins paņemšanas to vairs nevar mainīt. Pēc asins paņemšanas draw_method norāda izmantoto metodi.

Viens pieraksts katram profilam, atrašanās vietai un laikam

Profilam var būt ne vairāk kā viens neatcelts pieraksts uz vienu (location_id, scheduled_at) pāri — vienai personai nevar paņemt asinis divreiz vienā vietā un vienā brīdī neatkarīgi no tā, cik paralēlus pierakstus atrašanās vieta pieņem. Gan Izveidot pierakstu, gan Atjaunināt pierakstu to ievēro, atgriežot 409 ar appointment_id, kas norāda uz jau esošo pierakstu. Uztver šo atbildi kā norādi, ka pieraksts jau ir pieteikts, nevis kā kļūdu, ko mēģināt atkārtot: ielādē, pārcel vai atcel tajā norādīto pierakstu. Praktiski tas nozīmē, ka atkārtota izveide ir droša. Izveides pieprasījums, ko atkārtoti nosūti pēc tīkla noildzes vai ko lietotājs izsauc divreiz, tiek apstrādāts kā viens pieraksts, nevis divi — tas arī nozīmē, ka tev nekad nav vēlāk jāsaskaņo dublēti pieraksti tam pašam pacientam.
Izmaiņas ir atļautas tikai pirms asins paņemšanas — t. i., kamēr pieraksts ir pending vai confirmed statusā. Kad pieraksts pāriet blood_drawn statusā vai ir cancelled, to vairs nevar mainīt. Vienīgais izņēmums ir results_ready_emails: to vienu pašu joprojām vari mainīt pēc asins paņemšanas.

Pieraksta atcelšana

Atcel pierakstu, kas vairs nav vajadzīgs:
Tas iestata pieraksta statusu uz cancelled. Atbildē tiek atgriezts atceltais pieraksts. Pēc izvēles pieprasījuma saturā nosūti cancellation_reason (līdz 500 rakstzīmēm), lai norādītu iemeslu. Tas tiek saglabāts pie pieraksta un, to vēlāk nolasot, atgriezts kā cancellation_reason.
Atcelšana ir atļauta tikai pirms asins paņemšanas — t. i., kamēr pieraksts ir pending vai confirmed statusā. Pierakstus, kas jau pārgājuši blood_drawn statusā, atcelt nevar.

Paneļu pievienošana

Pirms apstiprini asins paņemšanu, pievieno vēlamos asins analīžu paneļus, izsaucot:
Laukā panel_ids padod paneļu UUID masīvu. Paneļu ID tavam partnera kontam piešķir Aniva.
Paneļi jāpievieno pirms asins paņemšanas — t. i., kamēr pieraksts ir pending vai confirmed statusā. Kad pieraksts ir pārgājis blood_drawn statusā, paneļus vairs nevar pievienot vai mainīt.

Paneļu noņemšana

Ja pirms asins paņemšanas jānoņem paneļi, izsauc:
Laukā panel_ids padod paneļu UUID masīvu. Noņemšana ir idempotenta: panelis, kas nav piesaistīts, tiek ignorēts.
Tāpat kā paneļu pievienošana, arī to noņemšana ir atļauta tikai pirms asins paņemšanas — t. i., kamēr pieraksts ir pending vai confirmed statusā. Kad pieraksts ir pārgājis blood_drawn statusā, paneļus vairs nevar noņemt.

Atsevišķi biomarķieri

Pierakstam vari piesaistīt atsevišķus biomarķierus kā analīzes pēc izvēles, ārpus iepriekš izveidotiem paneļiem. Tas noder, kad speciālists vēlas pielāgotu izvēli, nevis iepriekš definētu komplektu. Piesaistītie biomarķieri pieraksta atbildē parādās kā individual_biomarkers masīvs (līdzās panels). Maršrutēšanas lēmumus tālāk pieņem pasūtījumu loģistikas plūsma, balstoties uz katra biomarķiera sasaisti ar attiecīgo laboratoriju. Pievieno biomarķierus (idempotenti — jau piesaistītie biomarķieri tiek saglabāti):
Noņem biomarķierus (idempotenti — biomarķieri, kas nav piesaistīti, tiek ignorēti):
Abi galapunkti pieņem biomarker_ids masīvu un pārbauda izveidoto kopu atbilstoši katras laboratorijas slēgtības noteikumiem — pasūtījums, ko nevar korekti iesniegt (piem., CRP/HDL attiecība bez CRP un HDL), atgriež 400 ar biomarķieriem, kas tev būtu jāpievieno, un neko nesaglabā. Lai atrastu biomarķieru ID, izmanto Biomarķieru sarakstu.
Tāpat kā paneļu izmaiņas, arī atsevišķus biomarķierus var pievienot vai noņemt tikai pirms asins paņemšanas — t. i., kamēr pieraksts ir pending vai confirmed statusā. Kad pieraksts pāriet blood_drawn statusā, pielāgotais sastāvs tiek fiksēts.

Nepieciešamo paraugu trauku priekšskatījums

Pēc paneļu vai atsevišķu biomarķieru pievienošanas apskati fiziskos paraugu ņemšanas traukus, kas būs vajadzīgi paraugu savākšanai:
Atbildes containers masīvs ietver katra nepieciešamā trauka veidu, nosaukumu, vāciņa krāsu, tilpumu, ražotāja artikula numuru un skaitu. Tas palīdz speciālistiem pirms asins paņemšanas sagatavot pareizos materiālus. Atbildē ir iekļauts arī pricing objekts — visa pieraksta groza rēķins (piemērotās pozīcijas, piesaistītie paneļi un viena rinda katram nodrošinātajam biomarķierim pēc tava cenrāža ar mazumtirdzniecības cenu līdzās; skat. Cenas), kas tiek aizpildīts, ja pierakstam ir piesaistītas analīzes un tavai atslēgai ir prices_view tvērums, pretējā gadījumā — null. routing apzināti nekad netiek atklāts un vienmēr ir null.
Priekšskatījums atspoguļo pašlaik piesaistītos paneļus un biomarķierus. Ja pēc priekšskatījuma pievieno vai noņem paneļus, izsauc priekšskatījuma galapunktu vēlreiz, lai iegūtu atjauninātās prasības paraugu traukiem.

Asins paņemšanas apstiprināšana

Pēc asins paņemšanas iesniedz laboratorijas kodus (stobriņu svītrkodus), lai palaistu laboratorijas pasūtījumu plūsmu:
Nosūti lab_code, ja uz katra stobriņa ir uzdrukāts viens kods (venozo asiņu paņemšana), vai lab_codes ar vienu ierakstu katram kodam — katrā norādot aptvertos panel_ids —, ja katram panelim asinis paņem atsevišķos stobriņos ar savu kodu (kapilāro asiņu paņemšana). Tad katrs panelis ar savu kodu veido atsevišķu laboratorijas nosūtījumu. Kodi pierakstā tiek atgriezti kā lab_codes. Kapilāro asiņu paņemšanā paraugs tiek pildīts mikrokonteineros. Vispirms tiek izvietoti paneļi rezervācijas secībā. Pēc tam atsevišķie biomarķieri aizpilda brīvo vietu paneļu mikrokonteineros. Ja tiem vajag vairāk vietas, tiek atvērti jauni mikrokonteineri. Mēs tos sadalām vienmērīgi. Katrā mikrokonteinerā ietilpst ne vairāk kā 150 µl atsevišķu biomarķieru. Izsaukumi, kas maina paneļus vai biomarķierus, atbild ar 400, ja izveidotā kopa pārkāpj šo noteikumu. Tas maina pieraksta statusu uz blood_drawn un uzsāk laboratorijas apstrādi. Šī darbība ir neatgriezeniska.

Sūtījuma savākšana

POST /api/v1/appointments/pickup ir noņemts kopā ar shipment_picked_up pieraksta statusu. Tagad tas atbild ar 405 Method Not Allowed, jo ceļš nonāk pieraksta pēc ID maršrutā. Pēdējā posmā galapunkts darbojās kā tukšs izsaukums, kas pieņēma pieprasījumu un neko nedarīja, tāpēc tā noņemšana nemaina nekādu darbību, uz kuru tu būtu paļāvies.
Lai sekotu līdzi procesam pēc asins paņemšanas, pārbaudi katru ierakstu pieraksta iekļautajā shipments masīvā ar Sūtījuma iegūšanu — katram sūtījumam ir savs status un status_updates vēsture.

Sūtījumu sasaistīšana

Pierakstu var sasaistīt ar vienu vai vairākiem sūtījumiem (un otrādi — saite ir daudz pret daudz). Pašreizējās sasaistes tiek iekļautas abās pusēs:
  • pierakstā — kā shipments masīvs ar { id, added_at } ierakstiem;
  • sūtījumā — kā appointments masīvs ar { id, added_at } ierakstiem.
Abos masīvos vecākās sasaistes ir pirmās. Katrs id atsaucas uz kanonisko detalizēto galapunktu (Sūtījuma iegūšana / Pieraksta iegūšana), kur pieejami pilni dati. Sūtījumi tiek sasaistīti izveides brīdī, izmantojot lauku appointment_id galapunktā Sūtījuma izveide. Pēc izveides pārvaldi sasaistes no sūtījuma puses ar Pierakstu piesaistīšanu sūtījumam un Pierakstu atsaistīšanu no sūtījuma; katrs atgriež atjaunināto šī sūtījuma pierakstu sarakstu. Lai pilnībā nolasītu pieraksta pakas, izmanto Sūtījumu sarakstu ar ?appointment_id=. Izmaiņu noteikums ir šāds: sasaistes var izveidot vai noņemt, ja VAI NU
  • pierakstam jau veikta asins paņemšana (blood_drawn), vai
  • sūtījums izveidots pirms mazāk nekā 24 stundām.
Ārpus šī perioda sasaiste ir bloķēta, lai vēsturiskie ieraksti paliktu nemainīgi.

Laboratorijas rezultātu iegūšana

Kad laboratorija būs apstrādājusi asins paraugus, iegūsti klīniskos un ģenētiskos rezultātus:
Atbildē līdzās saņemtajiem rezultātiem ir iekļauti plānotie testi (statuss planned), lai tu varētu sekot līdzi tam, kas vēl tiek gaidīts. Augstākā līmeņa lauks status ir in_progress, līdz katrs iesniegums ir noslēgts, un tad kļūst par completed (vai fault, ja neviens no tiem nav iesniedzis datus) — izmanto to, lai noteiktu, vai pieraksta laboratorijas darbs ir pabeigts. appointment.results.completed webhook tev paziņo, kad tas notiek, tāpēc tev nav jāveic regulāri pieprasījumi. Masīvs submissions to sadala pa laboratorijas nosūtījumiem, katram norādot tā lab_code. Katram saņemtajam rezultātam un dokumentam ir norādīts lab_code, ar kuru tas tika reģistrēts. Atsauces uz laboratorijas pārskatu PDF failiem ir masīvā documents — izmanto GET /api/v1/documents/{id}, lai tos lejupielādētu.

Pieraksta piemērs