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

# Hae ajanvaraus

> Hae verinäytteenoton ajanvaraus ID:llä

Hae yksittäinen verinäytteenoton ajanvaraus sen UUID-tunnisteella, mukaan lukien sisällytetty potilasprofiili. Käytä tätä päätepistettä ajanvarauksen tilan tarkistamiseen, aikataulutietojen vahvistamiseen tai liitettyjen profiilitietojen hakemiseen.

Vaatii `appointments_view`- tai `appointments_schedule`-käyttöoikeuden.

## Pyyntö

### Polkuparametrit

**id** `string` *required*

Haettavan ajanvarauksen yksilöllinen tunniste (UUID).

## Vastaus

Onnistuessaan API palauttaa `200 OK` sekä ajanvarauksen ja siihen sisällytetyn profiilin.

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

**created\_at** `string` *required*

ISO 8601 -aikaleima ajanvarauksen luontihetkestä.

**updated\_at** `string`

ISO 8601 -aikaleima viimeisimmästä päivityksestä. Voi olla `null`.

**profile** `object` *required*

Tähän ajanvaraukseen liitetty potilasprofiili.

**profiili**

**id** `string`

Profiilin yksilöllinen tunniste (UUID).

**handle** `string`

Profiilin nimimerkki tai käyttäjätunnus. 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 mukaisesti. 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: yksi 32 koodista sivulla [Luo profiili](https://docs.anivahealth.com/fi/api/profiles/create-profile.md).

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

Saako tämä profiili tapahtumapohjaisia (automaattisia) sähköposteja. Voi olla `null`.

**created\_at** `string`

ISO 8601 -aikaleima profiilin luontihetkestä.

**updated\_at** `string`

ISO 8601 -aikaleima profiilin viimeisimmästä päivityksestä. Voi olla `null`.

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

Tähän ajanvaraukseen tällä hetkellä liitetyt paneelit. Ei sisällä peruttuja liitoksia. Katso paneelin
tiedot (nimi, biomarkkerit) päätepisteestä [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 (katso [Lisää
yksittäisiä biomarkkereita](https://docs.anivahealth.com/fi/api/appointments/add-individual-biomarkers.md)). Hae kunkin `biomarker_id`-arvon
näyttötiedot kutsulla [Listaa biomarkkerit](https://docs.anivahealth.com/fi/api/biomarkers/list-biomarkers.md).

**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 liitetyt lähetykset vanhimmasta liitoksesta alkaen. Tyhjä taulukko, kun lähetyksiä ei ole
liitetty. Hae kunkin `id`-arvon täydet lähetystiedot (tila, seurantanumero, tilapäivitykset jne.) päätepisteestä
[Hae lähetys](https://docs.anivahealth.com/fi/api/shipments/get-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`.

## Toistuvat kutsut

Aniva tallentaa tämän päätepisteen vastauksen 15 minuutiksi kullekin API-avaimelle. Tämän ajan sisällä
tehty toistuva kutsu saa tallennetun vastauksen, jos ajanvaraus ei ole muuttunut. Muutoksen jälkeen saat tuoreen
vastauksen. Otsikot `Cache-Status` ja `Age` osoittavat, että vastaus on
tallennettu ja kuinka vanha se on.

Jos haluat tiedon muutoksesta heti, tilaa webhook-tapahtumat `appointment.created`, `appointment.rescheduled` sekä kunkin tilan tapahtuma, esimerkiksi `appointment.confirmed`.
Katso [Toistuvat haut](https://docs.anivahealth.com/fi/concepts/webhooks.md#toistuvat-haut).

## Virhevastaukset

| Tila | Kuvaus |
| - | - |
| `400` | Virheellinen tunnistemuoto – annettu arvo ei ole kelvollinen UUID. |
| `403` | Pääsy estetty – API-avaimellasi ei ole oikeutta tähän toimintoon. |
| `404` | Ajanvarausta ei löytynyt. |
| `500` | Sisäinen palvelinvirhe. |

```bash cURL theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 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": [
    {
      "panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
      "added_at": "2026-04-01T09:50:00Z"
    }
  ],
  "individual_biomarkers": [
    {
      "biomarker_id": 42,
      "added_at": "2026-04-01T09:52:00Z"
    }
  ],
  "shipments": [
    {
      "id": "P2611194821",
      "added_at": "2026-04-15T07:00:00Z"
    }
  ],
  "lab_codes": []
}
```

```json 400 theme={null}
{
  "error": "Invalid appointment ID format"
}
```

```json 404 theme={null}
{
  "error": "Appointment not found"
}
```


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