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

# Päivitä ajanvaraus

> Muokkaa ajanvarauksen tietoja ennen verinäytteenottoa

Päivitä ajanvarauksen tietoja, kuten varattua aikaa tai näytteenottopaikkaa. Vain sellaisia ajanvarauksia voi muokata, joiden verinäytteenottoa ei ole vielä vahvistettu.

> [!WARNING]
>
> Ajanvarauksia ei voi muokata verinäytteenoton vahvistamisen jälkeen tai jos ne on jo peruttu.
> Yritys päivittää tällaista ajanvarausta palauttaa virheen `409 Conflict`. Ainoa poikkeus on
> `results_ready_emails`, jota voit muuttaa vielä verinäytteenoton jälkeen.

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

## Pyyntö

### Polkuparametrit

**id** `string` *required*

Päivitettävän ajanvarauksen yksilöllinen tunniste (UUID).

### Runkoparametrit

Kaikki runkoparametrit ovat valinnaisia — sisällytä vain kentät, joita haluat muuttaa.

**scheduled\_at** `string`

Uusi ajanvarauksen päivämäärä ja kellonaika ISO 8601 -muodossa (esim. `2026-05-20T14:00:00Z` tai
`2026-05-20T16:00:00+02:00`). **Täytyy sisältää aikavyöhykemerkintä** — joko `Z` tai
nimenomainen siirtymä, kuten `+02:00`; aikavyöhykkeettömät ajankohdat hylätään. Täytyy olla
tulevaisuudessa.

Täytyy olla vapaata kapasiteettia sisältävän aikavälin tarkka alkamisaika — katso
[Hae saatavuus](https://docs.anivahealth.com/fi/api/locations/get-availability.md). Siirrettävä ajanvaraus ei koskaan kuluta oman
kohdeaikavälinsä kapasiteettia, mutta siirtäminen aikavälille, jolla samalla profiililla on jo
*toinen* ajanvaraus, palauttaa koodin `409` ja kyseisen ajanvarauksen `appointment_id`-tunnisteen.

Jos *kohdetoimipiste* on Anivan ylläpitämä, uuden ajan on myös oltava vähintään 12 tunnin päässä —
katso [Vähimmäisennakkoaika](https://docs.anivahealth.com/fi/api/appointments/create-appointment.md#vaehimmaeisennakkoaika).

**location\_id** `string`

Uuden näytteenottopaikan UUID. Toimipisteen on oltava olemassa ja aktiivinen. Löydät saatavilla
olevien toimipisteiden tunnisteet sivulta [Listaa toimipisteet](https://docs.anivahealth.com/fi/api/locations/list-locations.md).

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

Korvaa enintään 5 osoitteen luettelon, joihin kuhunkin lähetetään yksi sähköposti, kun kaikki
laboratoriotulokset ovat lopullisia. Lähetä `[]` poistaaksesi sähköpostit käytöstä. Tämä kenttä
pysyy muokattavana verinäytteenoton jälkeen; vain peruttu ajanvaraus hylkää sen. Lähetä se
verinäytteenoton jälkeen yksinään: jos samassa rungossa on `scheduled_at` tai `location_id`,
pyyntö palauttaa koodin `409`. Avaimesi tarvitsee `results_view`-käyttöoikeuden potilaaseen, muuten
palautetaan `403`. Katso [Sähköpostit tulosten
valmistumisesta](https://docs.anivahealth.com/fi/concepts/results.md#saehkoepostit-tulosten-valmistumisesta).

**draw\_method** `string | null`

Uusi näytteenottotapa: `capillary` tai `venous`, tai `null`, jos haluat käyttää jälleen
toimipisteen arvoa `default_draw_method`. Toimipisteen täytyy listata tapa kentässään
`draw_methods`, ja varattujen testien täytyy olla mahdollisia sillä, muuten palautetaan `400`.
Kun siirrät ajanvarauksen toiseen toimipisteeseen, sama tarkistus ajetaan siellä: ajanvarauksen
omalle arvolle `draw_method`, tai muuten uuden toimipisteen arvolle `default_draw_method`.

## Vastaus

Onnistuessaan API palauttaa vastauksen `200 OK` sekä päivitetyn ajanvarauksen ja siihen upotetun 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 ajankohta UTC-aikana (ISO 8601 `Z`-päätteellä, esim.
`2026-05-20T14:00: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 linkitetyt lähetykset vanhimmasta linkistä alkaen. Tyhjä taulukko, kun
lähetyksiä ei ole linkitetty. Tarkista kunkin `id`-tunnisteen avulla lähetyksen koko sisältö
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`.

## Virhevastaukset

| Tila | Kuvaus |
| - | - |
| `400` | Validointivirhe – esim. `scheduled_at` on menneisyydessä, on alle 12 tunnin päässä Anivan ylläpitämässä toimipisteessä, virheellinen UUID-muoto, toimipisteellä ei ole näyteastioita menetelmälle `draw_method` tai varattuja testejä ei voi tehdä menetelmällä `draw_method`. |
| `403` | Estetty – API-avaimellasi ei ole oikeutta tähän toimintoon, ajanvaraus tai toimipiste on käyttöoikeusalueesi ulkopuolella tai `results_ready_emails` on asetettu ilman `results_view`-oikeutta potilaaseen. |
| `404` | Ajanvarausta tai toimipistettä ei löytynyt. |
| `409` | Ajanvarausta ei voi muokata (verinäytteenotto on jo vahvistettu tai ajanvaraus on peruttu), kohdeaika on täynnä, toimipiste on suljettu kyseisenä päivänä tai tällä profiililla on jo toinen ajanvaraus kohdetoimipisteessä samaan aikaan (sisältää kentän `appointment_id`). |
| `500` | Sisäinen palvelinvirhe. |

```bash cURL theme={null}
curl --request PATCH \
  --url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "scheduled_at": "2026-05-20T14:00:00Z",
    "location_id": "d8f3e1a2-4c5b-6d7e-8f9a-0b1c2d3e4f5a"
  }'
```

```json 200 theme={null}
{
  "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
  "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "location_id": "d8f3e1a2-4c5b-6d7e-8f9a-0b1c2d3e4f5a",
  "scheduled_at": "2026-05-20T14:00:00Z",
  "status": "confirmed",
  "cancellation_reason": null,
  "results_ready_emails": [],
  "draw_method": "venous",
  "created_at": "2026-04-01T09:45:00Z",
  "updated_at": "2026-04-10T11:30:00Z",
  "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": [],
  "shipments": [],
  "lab_codes": []
}
```

```json 409 theme={null}
{
  "error": "Appointment cannot be modified after blood draw has been confirmed"
}
```

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


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