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/panelslöytääksesi paneelien tunnukset ja niihin kuuluvat biomarkkerit. - Biomarkkerikatalogi — Selaa toimipisteessä tai kotitestipakkauksessa tilattavia biomarkkereita kutsulla
GET /api/v1/biomarkerslö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.
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_atkutsuissaPOST/PATCH /api/v1/appointments) on oltava aikavyöhykemerkintä — jokoZtai nimenomainen aikavyöhyke-ero, kuten+02:00. Ilman aikavyöhykettä annetut ajat hylätään koodilla400. Molemmat muodot kuvaavat samaa ajanhetkeä; vastaus muotoileescheduled_at-kentän aina UTCZ-muotoon. Käytä toimipisteentimezone-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ähetyksenpickup_date/pickup_time_*tulkitaan lähtötoimipisteen aikavyöhykkeessä. - Vain päivämäärän sisältävät vastauskentät (esim.
tested_at, saatavuudenavailability[].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.