Pāriet uz galveno saturu
Aniva Partner API ir REST API, kas ļauj veselības aprūpes partneriem pārvaldīt pacientu profilus, plānot asins paņemšanas pierakstus testēšanas vietās un uzsākt laboratorijas pasūtījumu plūsmas. Tu sazinies ar API caur HTTPS, izmantojot savu partnera API atslēgu.

Ko tu vari darīt

  • Profilu pārvaldība — Izveidot, izgūt un atjaunināt pacientu demogrāfiskos profilus.
  • Pierakstu plānošana — Pieteikt asins paņemšanas pierakstus Aniva testēšanas vietās.
  • Paneļu pārvaldība — Pievienot vai noņemt laboratorijas analīžu paneļus esošam pierakstam.
  • Atsevišķi biomarķieri — Pievienot vai noņemt atsevišķus biomarķierus pierakstam, neizvēloties paneli.
  • Mājas testa komplektu pasūtījumi — Nosūtīt pacientam mājas testa komplektu pa pastu, sekot līdzi tā sūtījumiem un ziņot, kad paraugs ir paņemts.
  • Paneļu katalogs — Pārlūkot pieejamos paneļus ar GET /api/v1/panels, lai uzzinātu paneļu ID un tajos iekļautos biomarķierus.
  • Biomarķieru katalogs — Pārlūkot biomarķierus, ko vari pasūtīt testēšanas vietā vai mājas testa komplektā, ar GET /api/v1/biomarkers, lai uzzinātu to ID.
  • Asins paņemšanas apstiprināšana — Pēc asins paņemšanas iesniegt laboratorijas kodu(-s), lai uzsāktu laboratorijas pasūtījumu plūsmu.
  • Laboratorijas rezultāti — Izgūt klīniskos un ģenētiskos rezultātus un lejupielādēt laboratorijas pārskatu PDF failus.
  • Testēšanas vietu atlase — Izgūt pieejamo testēšanas vietu sarakstu, ko parādīt pacientiem.
  • Sūtījumu loģistika — Izveidot, izsekot, mainīt un atcelt kurjera sūtījumu pasūtījumus.
  • Webhooks — Saņemt HTTPS izsaukumu, kad mainās pieraksts, mājas testa komplekta pasūtījums, tā rezultāti, testēšanas vieta, profils vai sūtījums. Skati Webhooks.

Izpēti dokumentāciju

Autentifikācija

Autentificē pieprasījumus ar savu partnera API atslēgu.

Ātrais sākums

Veic pirmo API izsaukumu dažu minūšu laikā ar soli pa solim piemēriem.

Profili

Uzzini, kā darbojas pacientu profili un kādus datus tie glabā.

Pieraksti

Izproti pieraksta dzīves ciklu no plānošanas līdz apstiprināšanai.

Mājas testa komplektu pasūtījumi

Nosūti testa komplektu pacientam uz mājām un seko tam līdzi, līdz paraugs nonāk laboratorijā.

API versiju pārvaldība

Pašreizējā API versija ir v1. Visiem galapunktiem ir prefikss /api/v1/. Bāzes URL ir https://anivahealth.com.
Nesaderīgas izmaiņas tiks ieviestas ar jaunu versijas prefiksu. API v1 paliks pieejams, un par jebkādu atbalsta pārtraukšanu tiks paziņots iepriekš.

Datumi un laika joslas

Visi pārsūtītie laika punkti ir formātā UTC ISO 8601 (Z sufikss). Tikai kalendāra laukos tiek izmantotas vietējā laika daļas (YYYY-MM-DD, HH:MM). Īpašas piezīmes:
  • Ievades laukos, kas pieņem datumu un laiku (piem., scheduled_at pieprasījumos POST / PATCH /api/v1/appointments), obligāti jānorāda laika joslas apzīmējums — vai nu Z, vai skaidra nobīde, piemēram, +02:00. Datumi un laiki bez laika joslas tiek noraidīti ar kļūdu 400. Abas formas apzīmē vienu un to pašu laika punktu; atbildē scheduled_at vienmēr tiek atgriezts UTC formātā ar Z. Lai attēlošanai formatētu laika punktu vietējā laikā, izmanto testēšanas vietas lauku timezone (vai jebkuru citu IANA identifikatoru).
  • Vietējā laika ievades dati tiek interpretēti mērķa resursa laika joslā: pieejamības datumiem tiek izmantots vaicājuma parametrs timezone (pēc noklusējuma testēšanas vietas laika josla); sūtījuma pickup_date / pickup_time_* tiek interpretēti izsūtīšanas vietas laika joslā.
  • Atbildes lauki, kas satur tikai datumu (piem., tested_at, pieejamības availability[].date), ir kalendāra datumi bez laika joslas.

Piekļuves iegūšana

API atslēgas katram partnerim izsniedz Aniva.
Sazinies ar Aniva, lai saņemtu savu partnera API atslēgu.