> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Johdanto

> Yleiskatsaus Aniva Partner API:hin, REST-rajapintaan apteekkien ja vastaanottojen verikokeita, kotitestipakkauksia ja laboratoriotuloksia varten.

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](https://docs.anivahealth.com/fi/concepts/webhooks.md).

## Tutustu dokumentaatioon

> [card] [Todennus](https://docs.anivahealth.com/fi/authentication.md)
>
> Todenna pyynnöt kumppanin API-avaimellasi.

> [card] [Pika-aloitus](https://docs.anivahealth.com/fi/quickstart.md)
>
> Tee ensimmäinen API-kutsusi muutamassa minuutissa vaiheittaisten esimerkkien avulla.

> [card] [Profiilit](https://docs.anivahealth.com/fi/concepts/profiles.md)
>
> Tutustu potilasprofiilien toimintaan ja siihen, mitä tietoja ne sisältävät.

> [card] [Ajanvaraukset](https://docs.anivahealth.com/fi/concepts/appointments.md)
>
> Ymmärrä ajanvarauksen elinkaari varaamisesta vahvistukseen.

> [card] [Kotitestipakkausten tilaukset](https://docs.anivahealth.com/fi/concepts/home-kit-orders.md)
>
> 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`.

```text theme={null}
https://anivahealth.com/api/v1/
```

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`).

| Luokka | Muoto | Käyttökohde |
| - | - | - |
| **Ajanhetki** | ISO 8601 UTC-ajassa (`Z`-pääte, esim. `2026-04-15T08:30:00Z`) | Jokainen tulosteen päivämäärä ja kellonaika — ajanvarauksen `scheduled_at`, saatavuuden `slots[]`, lähetyksen `pickup.from` / `pickup.till`, `created_at`, `updated_at`, `added_at`. Muunna haluamaasi paikalliseen aikavyöhykkeeseen asiakaspuolella. |
| **Palveluntarjoajan tapahtuma** | ISO 8601 ulkoisen palveluntarjoajan aikavyöhyke-erolla (välitetään sellaisenaan) | Vain lähetyksen `status_updates[].time` — aikavyöhyke-ero vastaa kuriirin ilmoittamaa arvoa. |
| **Seinäkelloaika** | `YYYY-MM-DD` päivämäärille, `HH:MM` kellonajoille — ei aikavyöhyke-eroa | Pelkät kalenteri- tai kellonaika-arvot — `date_of_birth`, tulosten `tested_at`, saatavuuden `start_date` / `end_date`, lähetyksen `pickup_date` / `pickup_time_from` / `pickup_time_till`, toimipisteen `open_hours`. |

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.

> [!NOTE]
>
> Ota yhteyttä Anivaan saadaksesi kumppanin API-avaimesi.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.