Hopp til hovedinnhold
Aniva Partner API er et REST-API som lar helsepartnere administrere pasientprofiler, bestille timer for blodprøvetaking på teststeder og starte labbestillingsflyter. Du kommuniserer med API-et over HTTPS ved hjelp av din partner-API-nøkkel.

Hva du kan gjøre

  • Profiladministrasjon — Opprett, hent og oppdater demografiske pasientprofiler.
  • Timebestilling — Bestill timer for blodprøvetaking på Anivas teststeder.
  • Paneladministrasjon — Legg til eller fjern labtestpaneler på en eksisterende time.
  • Enkeltbiomarkører — Legg til eller fjern enkeltbiomarkører på en time uten å velge et panel.
  • Bestilling av hjemmetestsett — Send et hjemmetestsett i posten til en pasient, spor pakkene og rapporter når prøven ble tatt.
  • Panelkatalog — Bla gjennom tilgjengelige paneler med GET /api/v1/panels for å finne panel-ID-er og hvilke biomarkører som inngår.
  • Biomarkørkatalog — Bla gjennom biomarkørene du kan bestille på et teststed eller i et hjemmetestsett med GET /api/v1/biomarkers for å finne ID-er.
  • Bekreftelse av blodprøvetaking — Send inn labkode(r) etter en blodprøvetaking for å starte labbestillingsflyten.
  • Labresultater — Hent kliniske og genetiske resultater og last ned labrapporter som PDF.
  • Teststedsoversikt — List opp tilgjengelige teststeder for å vise dem til pasienter.
  • Forsendelseslogistikk — Opprett, spor, endre og kanseller budforsendelser.
  • Webhooks — Motta et HTTPS-kall når en time, en bestilling av hjemmetestsett, tilhørende resultater, et teststed, en profil eller en forsendelse endres. Se Webhooks.

Utforsk dokumentasjonen

Autentisering

Autentiser forespørsler med din partner-API-nøkkel.

Hurtigstart

Gjør ditt første API-kall på få minutter med trinnvise eksempler.

Profiler

Lær hvordan pasientprofiler fungerer og hvilke data de inneholder.

Timer

Forstå livssyklusen til en time, fra bestilling til bekreftelse.

Bestillinger av hjemmetestsett

Send et testsett hjem til en pasient og følg det til prøven når laben.

API-versjonering

Gjeldende API-versjon er v1. Alle endepunkter har prefikset /api/v1/. Base-URL-en er https://anivahealth.com.
Brytende endringer innføres under et nytt versjonsprefiks. v1-API-et forblir tilgjengelig med forhåndsvarsel ved eventuelle utfasinger.

Datoer og tidssoner

Alle tidspunkter som sendes, er i UTC ISO 8601 (Z-suffiks). Rene kalenderfelt bruker lokal dato og klokketid (YYYY-MM-DD, HH:MM). Spesifikke merknader:
  • Inndata som tar dato og klokkeslett (f.eks. scheduled_at på POST / PATCH /api/v1/appointments) må inkludere en tidssoneangivelse — enten Z eller en eksplisitt forskyvning som +02:00. Tidspunkter uten tidssone avvises med 400. Begge formene angir samme tidspunkt; svaret returnerer alltid scheduled_at som UTC Z. Bruk teststedets timezone-felt (eller en annen IANA-identifikator) for å formatere tidspunktet i lokal klokketid når det vises.
  • Inndata i lokal tid tolkes i tidssonen til ressursen de gjelder: tilgjengelighetsdatoer bruker spørringsparameteren timezone (standard er teststedets tidssone); forsendelsens pickup_date / pickup_time_* tolkes i avsenderstedets tidssone.
  • Svarfelt med kun dato (f.eks. tested_at, availability[].date for tilgjengelighet) er kalenderdatoer uten tidssone.

Få tilgang

API-nøkler utstedes per partner av Aniva.
Kontakt Aniva for å få din partner-API-nøkkel.