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

# Skapa bokning

> Skapa en bokning för blodprovstagning åt en profil på en provtagningsplats

Boka en blodprovstagning för en patientprofil på en specifik provtagningsplats. När bokningen har skapats får den statusen `confirmed` som standard (vissa platser kan i stället ha `pending` som standard – det är en inställning per plats). Använd [Lägg till paneler](https://docs.anivahealth.com/sv/api/appointments/add-panels.md) för att koppla blodprovspaneler innan du [bekräftar blodprovstagningen](https://docs.anivahealth.com/sv/api/appointments/confirm-blood-draw.md).

> [!NOTE]
>
> En profil kan ha högst **en** bokning per plats och tidpunkt. Om du skapar en bokning för en
> tidslucka som profilen redan har returneras `409` med befintligt `appointment_id` i stället för en
> andra bokning – så ett nytt försök eller en oavsiktligt upprepad begäran kan aldrig skapa en
> dubblettbokning. Se [Dubblettbokningar](#dubblettbokningar).

Skicka med en valfri `Idempotency-Key`-header så att anropet säkert kan upprepas – om samma nyckel skickas igen returneras det ursprungliga svaret i stället för att en andra bokning skapas. Se [Idempotens](https://docs.anivahealth.com/sv/concepts/idempotency.md).

Kräver scopet `appointments_schedule`.

## Förfrågan

### Body-parametrar

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

UUID för patientprofilen som bokningen ska skapas för.

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

UUID för provtagningsplatsen där blodprovstagningen ska ske. Använd [Lista
platser](https://docs.anivahealth.com/sv/api/locations/list-locations.md) för att hitta tillgängliga plats-ID:n.

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

Datum och tid för bokningen i ISO 8601-format (t.ex. `2026-05-15T10:30:00Z` eller
`2026-05-15T12:30:00+02:00`). **Måste innehålla en tidszonsangivelse** – antingen `Z` eller en
uttrycklig förskjutning som `+02:00`; datum och tider utan tidszon avvisas. Måste ligga i framtiden.

Måste vara en exakt starttid i platsens tidsschema, och tidsluckan måste fortfarande ha ledig
kapacitet – läs [Hämta tillgänglighet](https://docs.anivahealth.com/sv/api/locations/get-availability.md) först. Tider utanför
schemat returnerar `400`; en fullbokad tidslucka returnerar `409`. På platser som drivs av Aniva
måste tiden också ligga minst 12 timmar framåt – se [Minsta framförhållning](#minsta-framfoerhallning).

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

Upp till 5 adresser som vardera får ett mejl när alla labbresultat är klara. Mejlet länkar till
resultatsidan i Anivas adminpanel. Din nyckel behöver behörigheten `results_view` för patienten,
annars returneras `403`. Utelämna fältet för att använda standardadresserna för patientens grupp.
En tom lista stänger av mejlen. Se [Mejl när resultat är klara](https://docs.anivahealth.com/sv/concepts/results.md#mejl-naer-resultat-aer-klara).

**draw\_method** `string`

Hur blodprovstagningen görs: `capillary` eller `venous`. Utelämna fältet för att använda platsens
`default_draw_method`. Platsen måste ange metoden i sina `draw_methods`, annars returneras `400`.

## Svar

Om begäran lyckas returnerar API:et `201 Created` med den nya bokningen.

**id** `string` *required*

Unik identifierare för bokningen (UUID).

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

UUID för den profil som bokningen tillhör.

**location\_id** `string`

UUID för provtagningsstället där blodprovstagningen sker.

**scheduled\_at** `string`

Planerat datum och tid för bokningen i UTC (ISO 8601 med `Z`-suffix, t.ex.
`2026-05-15T10:30:00Z`). Kan vara `null`.

**status** `string` *required*

Aktuell bokningsstatus. Något av `pending`, `confirmed`, `blood_drawn` eller `cancelled`.
Detaljerad status för färdigställda labbresultat får du från [Hämta resultat](https://docs.anivahealth.com/sv/api/appointments/get-results.md);
mer detaljerad försändelsestatus från varje post i `shipments`-arrayen nedan vidare till [Hämta
försändelse](https://docs.anivahealth.com/sv/api/shipments/get-shipment.md).

**cancellation\_reason** `string`

Orsak i fritext som registrerades när bokningen avbokades (t.ex. uteblivet besök, sen avbokning,
'Misslyckades. Behöver göras om'). `null` om inte `status` är `cancelled`.

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

Adresser som var och en får ett mejl när alla labbresultat är slutgiltiga, i gemener. Tom när funktionen är avstängd. Se
[Mejl när resultat är klara](https://docs.anivahealth.com/sv/concepts/results.md#mejl-naer-resultat-aer-klara).

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

Hur blodet tas: `capillary` (fingertopp eller överarm, i mikrorör) eller `venous` (från ven,
i provrör). Det är metoden som bokningen anger, annars `default_draw_method` för dess
[provtagningsställe](https://docs.anivahealth.com/sv/concepts/locations.md). Efter blodprovstagningen är det den metod som användes.

**profile** `object` *required*

Patientprofilen som är kopplad till den här bokningen.

**profile**

**id** `string`

Unik profilidentifierare (UUID).

**handle** `string`

Profil-handle eller användarnamn. Kan vara `null`.

**first\_name** `string`

Förnamn. Kan vara `null`.

**last\_name** `string`

Efternamn. Kan vara `null`.

**email** `string`

E-postadress. Kan vara `null`.

**phone** `string`

Telefonnummer i E.164-format. Kan vara `null`.

**sex** `integer`

Biologiskt kön enligt ISO/IEC 5218. Kan vara `null`.

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

Födelsedatum i formatet `YYYY-MM-DD`. Kan vara `null`.

**height** `number`

Längd i centimeter. Kan vara `null`.

**weight** `number`

Vikt i kilogram. Kan vara `null`.

**language** `string`

Föredraget språk: en av de 32 koderna i [Skapa profil](https://docs.anivahealth.com/sv/api/profiles/create-profile.md).

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

Om profilen tar emot transaktionsmejl (programmatiska mejl). Kan vara `null`.

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

Paneler som för närvarande är kopplade till den här bokningen. Tom för nyskapade bokningar – koppla
via [Lägg till paneler](https://docs.anivahealth.com/sv/api/appointments/add-panels.md). Slå upp paneldetaljer (namn, biomarkörer) via
[Lista paneler](https://docs.anivahealth.com/sv/api/panels/list-panels.md).

**Fält för kopplade paneler**

**panel\_id** `string`

Panelens UUID — korsreferera mot [Lista paneler](https://docs.anivahealth.com/sv/api/panels/list-panels.md).

**added\_at** `string`

ISO 8601-tidsstämpel för när panelen först kopplades till bokningen.

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

Enskilda biomarkörer som är kopplade till den här bokningen utanför någon panel. Tom för nyskapade
bokningar – koppla via [Lägg till enskilda biomarkörer](https://docs.anivahealth.com/sv/api/appointments/add-individual-biomarkers.md).
Matcha varje `biomarker_id` mot [Lista biomarkörer](https://docs.anivahealth.com/sv/api/biomarkers/list-biomarkers.md) för
visningsdata.

**Fält för enskilda biomarkörer**

**biomarker\_id** `integer`

Identifierare för biomarkören — korsreferera mot
[Lista biomarkörer](https://docs.anivahealth.com/sv/api/biomarkers/list-biomarkers.md).

**added\_at** `string`

ISO 8601-tidsstämpel för när biomarkören först kopplades till bokningen.

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

Försändelser som är kopplade till den här bokningen, äldsta kopplingen först. Tom för nyskapade
bokningar – koppla via [Skapa försändelse](https://docs.anivahealth.com/sv/api/shipments/create-shipment.md) (med `appointment_id`)
eller [Koppla bokningar till försändelse](https://docs.anivahealth.com/sv/api/shipments/attach-appointments-to-shipment.md).

**Fält för försändelselänkar**

**id** `string`

Referensidentifierare för försändelsen — korsreferera mot
[Hämta försändelse](https://docs.anivahealth.com/sv/api/shipments/get-shipment.md).

**added\_at** `string`

ISO 8601-tidsstämpel för när försändelsen först länkades till bokningen.

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

Labbkoder (rörens streckkoder) som registrerats för den här bokningen, i skanningsordning. Tom tills blodprovstagningen
är bekräftad. En venös blodprovstagning har en kod tryckt på varje provrör; en kapillär blodprovstagning har en
kod per mikrorör. Resultat och dokument i [Hämta resultat](https://docs.anivahealth.com/sv/api/appointments/get-results.md) refererar till
dessa koder via `lab_code`.

## Minsta framförhållning

Bokningar på platser som drivs av Aniva måste göras minst **12 timmar** i förväg; bokar du inom det
tidsfönstret returneras `400`. [Hämta tillgänglighet](https://docs.anivahealth.com/sv/api/locations/get-availability.md) döljer redan
de tidsluckorna, så allt du läser från det schemat går att boka.

Platser som du driver själv har ingen minsta framförhållning – bokning samma dag och drop-in är oförändrat.

## Dubblettbokningar

En profil kan ha högst en icke-avbokad bokning per plats och tidpunkt – en person kan inte ta
blodprov två gånger på samma plats vid samma tidpunkt, oavsett hur många stolar platsen har.

Om du skapar en bokning för en tidslucka som profilen redan har returneras `409` med ett
`appointment_id` som anger den bokning som redan finns:

```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"
}
```

Hantera det genom att behandla begäran som redan genomförd: hämta bokningen med
[Hämta bokning](https://docs.anivahealth.com/sv/api/appointments/get-appointment.md), flytta den med
[Uppdatera bokning](https://docs.anivahealth.com/sv/api/appointments/update-appointment.md) eller ta bort den med
[Avbryt bokning](https://docs.anivahealth.com/sv/api/appointments/cancel-appointment.md). Försök inte skapa bokningen igen – det kommer
att fortsätta returnera `409`.

Det gör upprepade skapanden säkra: en begäran som du skickar igen efter en timeout, eller ett formulär
som skickats två gånger, kan inte skapa två bokningar för samma patient vid samma tidpunkt.

> [!NOTE]
>
> `appointment_id` finns bara med vid dubblett-`409`. Kapacitets-`409` – tidsluckan är full
> eftersom *andra* patienter har bokat den – returnerar bara `error`, och rätt åtgärd då är att välja
> en annan tidslucka från [Hämta tillgänglighet](https://docs.anivahealth.com/sv/api/locations/get-availability.md).

## Felsvar

| Status | Beskrivning |
| - | - |
| `400` | Valideringsfel — t.ex. om `scheduled_at` ligger i det förflutna, är mindre än 12 timmar framåt på en plats som drivs av Aniva eller inte är en exakt starttid i platsens tidsschema, eller om platsen inte har behållare i lager för `draw_method`. |
| `403` | Åtkomst nekad — din API-nyckel har inte behörighet för den här åtgärden, eller så är `results_ready_emails` inställt utan `results_view`-åtkomst till patienten. |
| `404` | Profilen eller platsen hittades inte, eller så är platsen inaktiv. |
| `409` | Den här profilen har redan en bokning på den här platsen och tiden (innehåller `appointment_id`), tiden är fullbokad, platsen är stängd det datumet eller så återanvändes `Idempotency-Key` med en annan body, eller så har den ursprungliga begäran inte slutförts. |
| `500` | Internt serverfel. |

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