Siirry pääsisältöön
Aniva Partner API on REST-rajapinta, jonka avulla terveydenhuollon kumppanit voivat hallita potilasprofiileja, tehdä verinäytteenoton ajanvarauksia testauspisteisiin ja käynnistää laboratoriotilausputkia. Käytät rajapintaa HTTPS-yhteydellä kumppanin API-avaimellasi.

Mitä voit tehdä

  • Profiilien hallinta — Luo, hae ja päivitä potilaiden perustietoprofiileja.
  • Ajanvaraus — Tee verinäytteenoton ajanvarauksia Anivan testauspisteisiin.
  • Paneelien hallinta — Lisää laboratoriotestipaneeleja olemassa olevaan ajanvaraukseen tai poista niitä.
  • Yksittäiset biomarkkerit — Liitä yksittäisiä biomarkkereita ajanvaraukseen tai poista niitä valitsematta paneelia.
  • Kotitestipakkausten tilaukset — Lähetä kotiin postitettava testipakkaus potilaalle, seuraa sen paketteja ja ilmoita, kun näyte on otettu.
  • Paneelikatalogi — Selaa saatavilla olevia paneeleja kutsulla GET /api/v1/panels löytääksesi paneelien tunnukset ja niihin kuuluvat biomarkkerit.
  • Biomarkkerikatalogi — Selaa toimipisteessä tai kotitestipakkauksessa tilattavia biomarkkereita kutsulla GET /api/v1/biomarkers löytääksesi niiden tunnukset.
  • Verinäytteenoton vahvistus — Lähetä laboratoriokoodi(t) verinäytteenoton jälkeen käynnistääksesi laboratoriotilausputken.
  • Laboratoriotulokset — Hae kliinisiä ja geneettisiä tuloksia sekä lataa laboratorioraporttien PDF-tiedostoja.
  • Toimipisteiden haku — Listaa käytettävissä olevat testauspisteet potilaille näytettäväksi.
  • Lähetyslogistiikka — Luo, seuraa, muokkaa ja peruuta kuriirilähetystilauksia.
  • Webhookit — Vastaanota HTTPS-kutsu, kun ajanvaraus, kotitestipakkauksen tilaus, sen tulokset, toimipiste, profiili tai lähetys muuttuu. Katso Webhookit.

Tutustu dokumentaatioon

Todennus

Todenna pyynnöt kumppanin API-avaimellasi.

Pika-aloitus

Tee ensimmäinen API-kutsusi muutamassa minuutissa vaiheittaisten esimerkkien avulla.

Profiilit

Tutustu potilasprofiilien toimintaan ja siihen, mitä tietoja ne sisältävät.

Ajanvaraukset

Ymmärrä ajanvarauksen elinkaari varaamisesta vahvistukseen.

Kotitestipakkausten tilaukset

Lähetä testipakkaus potilaan kotiin ja seuraa sitä, kunnes näyte saapuu laboratorioon.

API:n versiointi

Nykyinen API-versio on v1. Kaikkien päätepisteiden etuliite on /api/v1/. Perus-URL on https://anivahealth.com.
Yhteensopivuuden rikkovat muutokset otetaan käyttöön uuden versioetuliitteen alla. v1-rajapinta pysyy käytettävissä, ja mahdollisista käytöstä poistoista ilmoitetaan etukäteen.

Päivämäärät ja aikavyöhykkeet

Kaikki rajapinnassa siirrettävät ajanhetket ovat UTC ISO 8601 -muodossa (Z-pääte). Pelkät kalenterikentät käyttävät seinäkelloajan osia (YYYY-MM-DD, HH:MM). Erityishuomiot:
  • Päivämäärän ja kellonajan sisältävissä syötteissä (esim. scheduled_at kutsuissa POST / PATCH /api/v1/appointments) on oltava aikavyöhykemerkintä — joko Z tai nimenomainen aikavyöhyke-ero, kuten +02:00. Ilman aikavyöhykettä annetut ajat hylätään koodilla 400. Molemmat muodot kuvaavat samaa ajanhetkeä; vastaus muotoilee scheduled_at-kentän aina UTC Z -muotoon. Käytä toimipisteen timezone-kenttää (tai muuta IANA-tunnistetta) muotoillaksesi ajanhetken paikalliseen seinäkelloaikaan sitä näytettäessä.
  • Seinäkelloaikasyötteet tulkitaan kohteena olevan resurssin aikavyöhykkeessä: saatavuuspäivämäärät käyttävät timezone-kyselyparametria (oletuksena toimipisteen aikavyöhyke); lähetyksen pickup_date / pickup_time_* tulkitaan lähtötoimipisteen aikavyöhykkeessä.
  • Vain päivämäärän sisältävät vastauskentät (esim. tested_at, saatavuuden availability[].date) ovat kalenteripäivämääriä ilman aikavyöhykettä.

Käyttöoikeuden hankkiminen

Aniva myöntää API-avaimet kumppanikohtaisesti.
Ota yhteyttä Anivaan saadaksesi kumppanin API-avaimesi.