> ## 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.

# Luo ajanvaraus

> Tee verinäytteenoton ajanvaraus profiilille testipaikkaan

Varaa verinäytteenoton ajanvaraus potilasprofiilille tiettyyn testaustoimipisteeseen. Kun ajanvaraus on luotu, se saa oletuksena tilan `confirmed` (joissakin toimipisteissä oletustila voi sen sijaan olla `pending` — tämä on toimipistekohtainen asetus). Liitä verikoepaneelit kutsulla [Lisää paneelit](https://docs.anivahealth.com/fi/api/appointments/add-panels.md) ennen [verinäytteenoton vahvistamista](https://docs.anivahealth.com/fi/api/appointments/confirm-blood-draw.md).

> [!NOTE]
>
> Profiililla voi olla enintään **yksi** ajanvaraus toimipistettä ja ajankohtaa kohden. Ajanvarauksen
> luominen ajankohdalle, jonka profiili on jo varannut, palauttaa vastauksen `409` ja olemassa olevan
> `appointment_id`-tunnisteen toisen ajanvarauksen sijaan — joten uudelleen yritetty tai vahingossa
> toistettu pyyntö ei voi koskaan luoda kaksoisvarausta. Katso
> [Päällekkäiset ajanvaraukset](#paeaellekkaeiset-ajanvaraukset).

Lähetä valinnainen `Idempotency-Key`-otsikko, jotta luontipyynnön voi yrittää turvallisesti uudelleen — saman avaimen toistaminen palauttaa alkuperäisen vastauksen toisen luomisen sijaan. Katso [Idempotenssi](https://docs.anivahealth.com/fi/concepts/idempotency.md).

Vaatii scope-oikeuden `appointments_schedule`.

## Pyyntö

### Runkoparametrit

**profile\_id** `string` *required*

Sen potilasprofiilin UUID, jolle ajanvaraus luodaan.

**location\_id** `string` *required*

Sen testaustoimipisteen UUID, jossa verinäytteenotto tehdään. Hae saatavilla olevien toimipisteiden
tunnisteet kutsulla [Listaa toimipisteet](https://docs.anivahealth.com/fi/api/locations/list-locations.md).

**scheduled\_at** `string` *required*

Ajanvarauksen päivämäärä ja kellonaika ISO 8601 -muodossa (esim. `2026-05-15T10:30:00Z` tai
`2026-05-15T12:30:00+02:00`). **Aikavyöhykemerkintä on pakollinen** — joko `Z` tai nimenomainen
aikavyöhyke-ero kuten `+02:00`; aikavyöhykkeettömät ajankohdat hylätään. Ajankohdan on oltava tulevaisuudessa.

Ajankohdan on oltava tarkka alkamisaika toimipisteen ajanvarausaikataulussa, ja ajassa on oltava
vielä tilaa — tarkista ensin [Hae saatavuus](https://docs.anivahealth.com/fi/api/locations/get-availability.md). Aikataulun
ulkopuoliset ajat palauttavat `400`; täyteen varattu aika palauttaa `409`. Anivan ylläpitämissä
toimipisteissä ajankohdan on oltava myös vähintään 12 tunnin päässä — katso
[Vähimmäisennakkoaika](#vaehimmaeisennakkoaika).

**results\_ready\_emails** `string[]`

Enintään 5 osoitetta, joista kukin saa yhden sähköpostin, kun kaikki laboratoriotulokset ovat
valmiit. Sähköpostissa on linkki tulossivulle Anivan hallintapaneelissa. Avaimesi tarvitsee
`results_view`-oikeuden potilaaseen, muutoin palautetaan `403`. Jätä kenttä pois, jos haluat
käyttää potilaan ryhmälle asetettuja oletusosoitteita. Tyhjä lista poistaa sähköpostit käytöstä.
Katso [Sähköpostit valmiista tuloksista](https://docs.anivahealth.com/fi/concepts/results.md#saehkoepostit-tulosten-valmistumisesta).

**draw\_method** `string`

Verinäytteenottotapa: `capillary` tai `venous`. Jätä kenttä pois, jos haluat käyttää toimipisteen
`default_draw_method`-arvoa. Menetelmän on oltava toimipisteen `draw_methods`-listassa, muutoin
palautetaan `400`.

## Vastaus

Onnistuessaan API palauttaa `201 Created` ja uuden ajanvarauksen.

**id** `string` *required*

Ajanvarauksen yksilöllinen tunniste (UUID).

**profile\_id** `string` *required*

Sen profiilin UUID, johon tämä ajanvaraus kuuluu.

**location\_id** `string`

Sen testipaikan UUID, jossa verinäytteenotto tehdään.

**scheduled\_at** `string`

Ajanvarauksen sovittu päivämäärä ja aika UTC-hetkenä (ISO 8601 ja `Z`-pääte, esim.
`2026-05-15T10:30:00Z`). Voi olla `null`.

**status** `string` *required*

Ajanvarauksen nykyinen tila. Jokin arvoista `pending`, `confirmed`, `blood_drawn` tai `cancelled`.
Laboratoriotulosten tarkempi valmistumistila saadaan kutsusta [Hae tulokset](https://docs.anivahealth.com/fi/api/appointments/get-results.md);
lähetyksen tarkempi eteneminen kunkin `shipments`-taulukon alkion (katso alla) kautta kutsusta
[Hae lähetys](https://docs.anivahealth.com/fi/api/shipments/get-shipment.md).

**cancellation\_reason** `string`

Vapaamuotoinen syy, joka kirjattiin ajanvarauksen perumisen yhteydessä (esim. saapumatta jääminen,
myöhäinen peruminen, "Epäonnistui. Uusinta tarvitaan"). `null`, ellei `status` ole `cancelled`.

**results\_ready\_emails** `string[]` *required*

Osoitteet pienillä kirjaimilla, joista jokainen saa yhden sähköpostin kaikkien laboratoriotulosten
valmistuttua. Tyhjä, kun toiminto on pois päältä. Katso
[Tulokset valmiit -sähköpostit](https://docs.anivahealth.com/fi/concepts/results.md#saehkoepostit-tulosten-valmistumisesta).

**draw\_method** `string` *required*

Verinäytteenottotapa: `capillary` (sormenpäästä tai olkavarresta mikroputkiin) tai `venous` (laskimosta
putkiin). Se on ajanvaraukselle asetettu tapa tai muutoin sen [toimipisteen](https://docs.anivahealth.com/fi/concepts/locations.md)
`default_draw_method`. Verinäytteenoton jälkeen se on käytetty tapa.

**profile** `object` *required*

Tähän ajanvaraukseen liitetty potilasprofiili.

**profile**

**id** `string`

Profiilin yksilöivä tunniste (UUID).

**handle** `string`

Profiilin tunnus tai käyttäjänimi. Voi olla `null`.

**first\_name** `string`

Etunimi. Voi olla `null`.

**last\_name** `string`

Sukunimi. Voi olla `null`.

**email** `string`

Sähköpostiosoite. Voi olla `null`.

**phone** `string`

Puhelinnumero E.164-muodossa. Voi olla `null`.

**sex** `integer`

Biologinen sukupuoli standardin ISO/IEC 5218 mukaan. Voi olla `null`.

**date\_of\_birth** `string`

Syntymäaika muodossa `YYYY-MM-DD`. Voi olla `null`.

**height** `number`

Pituus senttimetreinä. Voi olla `null`.

**weight** `number`

Paino kilogrammoina. Voi olla `null`.

**language** `string`

Ensisijainen kieli: jokin 32 koodista sivulla [Luo profiili](https://docs.anivahealth.com/fi/api/profiles/create-profile.md).

**transactional\_emails\_enabled** `boolean`

Vastaanottaako profiili tapahtumapohjaisia (ohjelmallisia) sähköposteja. Voi olla `null`.

**panels** `AppointmentPanel[]` *required*

Tähän ajanvaraukseen tällä hetkellä liitetyt paneelit. Tyhjä vasta luoduille ajanvarauksille —
liitä kutsulla [Lisää paneelit](https://docs.anivahealth.com/fi/api/appointments/add-panels.md). Hae paneelien tiedot (nimi,
biomarkkerit) kutsulla [Listaa paneelit](https://docs.anivahealth.com/fi/api/panels/list-panels.md).

**Liitetyn paneelin kentät**

**panel\_id** `string`

Paneelin UUID — tarkista tiedot kutsulla [Listaa paneelit](https://docs.anivahealth.com/fi/api/panels/list-panels.md).

**added\_at** `string`

ISO 8601 -aikaleima hetkestä, jolloin paneeli liitettiin tähän ajanvaraukseen ensimmäisen kerran.

**individual\_biomarkers** `AppointmentIndividualBiomarker[]` *required*

Yksittäiset biomarkkerit, jotka on liitetty tähän ajanvaraukseen paneelien ulkopuolelta. Tyhjä
vasta luoduille ajanvarauksille — liitä kutsulla [Lisää yksittäisiä biomarkkereita](https://docs.anivahealth.com/fi/api/appointments/add-individual-biomarkers.md).
Hae kunkin `biomarker_id`-tunnisteen näyttötiedot kutsun [Listaa biomarkkerit](https://docs.anivahealth.com/fi/api/biomarkers/list-biomarkers.md)
avulla.

**Yksittäisen biomarkkerin kentät**

**biomarker\_id** `integer`

Biomarkkerin tunniste — tarkista tiedot kutsulla
[Listaa biomarkkerit](https://docs.anivahealth.com/fi/api/biomarkers/list-biomarkers.md).

**added\_at** `string`

ISO 8601 -aikaleima hetkestä, jolloin biomarkkeri liitettiin tähän ajanvaraukseen ensimmäisen kerran.

**shipments** `AppointmentShipmentLink[]` *required*

Tähän ajanvaraukseen linkitetyt lähetykset, vanhin linkitys ensin. Tyhjä vasta luoduille
ajanvarauksille — linkitä kutsulla [Luo lähetys](https://docs.anivahealth.com/fi/api/shipments/create-shipment.md)
(parametrilla `appointment_id`) tai [Liitä ajanvaraukset lähetykseen](https://docs.anivahealth.com/fi/api/shipments/attach-appointments-to-shipment.md).

**Lähetyslinkin kentät**

**id** `string`

Lähetyksen viitetunniste — tarkista tiedot kutsulla
[Hae lähetys](https://docs.anivahealth.com/fi/api/shipments/get-shipment.md).

**added\_at** `string`

ISO 8601 -aikaleima hetkestä, jolloin lähetys linkitettiin tähän ajanvaraukseen ensimmäisen kerran.

**lab\_codes** `string[]` *required*

Tälle ajanvaraukselle kirjatut laboratoriokoodit (putkien viivakoodit) skannausjärjestyksessä. Tyhjä,
kunnes verinäytteenotto on vahvistettu. Laskimonäytteenotossa on yksi koodi painettuna jokaiseen putkeen,
kapillaarinäytteenotossa taas yksi koodi mikroputkea kohti. Kutsun [Hae tulokset](https://docs.anivahealth.com/fi/api/appointments/get-results.md)
tulokset ja asiakirjat viittaavat näihin koodeihin kentällä `lab_code`.

## Vähimmäisennakkoaika

Ajanvaraukset Anivan ylläpitämiin toimipisteisiin on tehtävä vähintään **12 tuntia** etukäteen;
tämän aikarajan sisällä varaaminen palauttaa `400`. [Hae saatavuus](https://docs.anivahealth.com/fi/api/locations/get-availability.md)
jättää nämä ajat jo valmiiksi pois, joten kaikki sieltä saadut ajat ovat varattavissa.

Itse ylläpitämissäsi toimipisteissä ei ole vähimmäisennakkoaikaa — saman päivän ja paikan päällä tehtävät varaukset toimivat kuten ennenkin.

## Päällekkäiset ajanvaraukset

Profiililla voi olla enintään yksi muu kuin peruutettu ajanvaraus toimipistettä ja ajankohtaa kohden —
yhdeltä henkilöltä ei voi ottaa verinäytettä kahdesti samassa paikassa samaan aikaan, olipa
toimipisteessä kuinka monta tuolia tahansa.

Ajanvarauksen luominen ajankohdalle, jonka profiili on jo varannut, palauttaa vastauksen `409` ja
`appointment_id`-tunnisteen, joka viittaa jo olemassa olevaan ajanvaraukseen:

```json theme={null}
{
  "error": "This profile already has an appointment at this location and time. Reschedule or cancel the existing appointment instead of creating a second one.",
  "appointment_id": "03e916d2-7fd6-4414-8276-8532a105edc3"
}
```

Käsittele tilanne pitämällä pyyntöä jo toteutettuna: hae ajanvaraus kutsulla
[Hae ajanvaraus](https://docs.anivahealth.com/fi/api/appointments/get-appointment.md), siirrä sitä kutsulla
[Päivitä ajanvaraus](https://docs.anivahealth.com/fi/api/appointments/update-appointment.md) tai peruuta se kutsulla
[Peruuta ajanvaraus](https://docs.anivahealth.com/fi/api/appointments/cancel-appointment.md). Älä yritä luontipyyntöä uudelleen — se
palauttaa jatkuvasti `409`.

Tämä tekee toistetuista luontipyynnöistä turvallisia: aikakatkaisun jälkeen uudelleen lähetetty
pyyntö tai kahdesti lähetetty lomake ei voi luoda kahta ajanvarausta samalle potilaalle samaan
aikaan.

> [!NOTE]
>
> `appointment_id` on mukana vain päällekkäisyydestä johtuvassa `409`-vastauksessa. Kapasiteetista
> johtuva `409` — aika on täynnä, koska *muut* potilaat ovat varanneet sen — palauttaa pelkän
> `error`-kentän, jolloin oikea tapa edetä on valita toinen aika kutsusta
> [Hae saatavuus](https://docs.anivahealth.com/fi/api/locations/get-availability.md).

## Virhevastaukset

| Tila | Kuvaus |
| - | - |
| `400` | Validointivirhe – esimerkiksi `scheduled_at` on menneisyydessä, alle 12 tunnin päässä Anivan omassa toimipisteessä tai ei ole tarkka ajan alkamisaika toimipisteen aikataulussa, tai toimipisteessä ei ole näyteastioita menetelmälle `draw_method`. |
| `403` | Pääsy estetty – API-avaimellasi ei ole oikeutta tähän toimintoon, tai `results_ready_emails` on asetettu ilman potilaan `results_view`-oikeutta. |
| `404` | Profiilia tai toimipistettä ei löytynyt, tai toimipiste ei ole aktiivinen. |
| `409` | Tällä profiililla on jo ajanvaraus tässä toimipisteessä ja tähän aikaan (sisältää kentän `appointment_id`), aika on täynnä, toimipiste on suljettu kyseisenä päivänä, `Idempotency-Key` käytettiin uudelleen eri sisällöllä tai sen alkuperäinen pyyntö ei ole vielä valmistunut. |
| `500` | Sisäinen palvelinvirhe. |

```bash cURL theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/appointments \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
    "scheduled_at": "2026-05-15T10:30:00Z"
  }'
```

```json 201 theme={null}
{
  "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
  "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
  "scheduled_at": "2026-05-15T10:30:00Z",
  "status": "confirmed",
  "cancellation_reason": null,
  "results_ready_emails": [],
  "draw_method": "venous",
  "created_at": "2026-04-01T09:45:00Z",
  "updated_at": null,
  "profile": {
    "id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "handle": null,
    "first_name": "Maria",
    "last_name": "Schmidt",
    "email": "maria.schmidt@example.com",
    "phone": "+4930123456789",
    "sex": 2,
    "date_of_birth": "1985-03-22",
    "height": 168,
    "weight": 65,
    "language": "de",
    "transactional_emails_enabled": true,
    "created_at": "2026-04-01T09:14:32Z",
    "updated_at": null
  },
  "panels": [],
  "individual_biomarkers": [],
  "shipments": [],
  "lab_codes": []
}
```

```json 400 theme={null}
{
  "error": "Appointments must be booked at least 12 hours in advance. Please pick a later time."
}
```

```json 404 theme={null}
{
  "error": "Location not found or inactive"
}
```

```json 409 theme={null}
{
  "error": "This profile already has an appointment at this location and time. Reschedule or cancel the existing appointment instead of creating a second one.",
  "appointment_id": "03e916d2-7fd6-4414-8276-8532a105edc3"
}
```


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