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

# Avboka bokning

> Avboka en bokning för blodprovstagning

Avboka en bokning genom att sätta dess status till `cancelled`. Endast bokningar där blodprovstagningen ännu inte har bekräftats kan avbokas.

Att avboka en bokning som redan är `cancelled` returnerar `200` med den bokningen och skriver ingenting — ingen andra avbokning registreras. Svaret innehåller `Idempotent-Replayed: true` så att du kan skilja en upprepning från anropet som gjorde jobbet. En upprepning som har en **annan** `cancellation_reason` returnerar `409` i stället: den registrerade orsaken skrivs aldrig över. Se [Idempotens](https://docs.anivahealth.com/sv/concepts/idempotency.md).

> [!WARNING]
>
> Bokningar kan inte avbokas efter att blodprovstagningen har bekräftats — då returneras `409
>     Conflict`.

Kräver scopet `appointments_schedule` eller `appointments_manage`.

## Förfrågan

### Sökvägsparametrar

**id** `string` *required*

Unik identifierare (UUID) för bokningen som ska avbokas.

### Body-parametrar

Bodyn är valfri — skicka ingen body alls för att avboka utan att registrera en orsak.

**cancellation\_reason** `string`

Orsak till avbokningen i fritext, upp till 500 tecken (t.ex. `Patient no-show`). Sparas på
bokningen och returneras som `cancellation_reason` vid denna och senare läsningar.

## Svar

Om anropet lyckas returnerar API:et `200 OK` med den avbokade bokningen och dess inbäddade profil.

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

Bokningens status. Blir `cancelled` efter en lyckad avbokning.

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

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

ISO 8601-tidsstämpel för när bokningen skapades.

**updated\_at** `string`

ISO 8601-tidsstämpel för den senaste uppdateringen. Kan vara `null`.

**profile** `object` *required*

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

**profil**

**id** `string`

Unik identifierare för profilen (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 transaktionella (programmatiska) mejl. Kan vara `null`.

**created\_at** `string`

ISO 8601-tidsstämpel för när profilen skapades.

**updated\_at** `string`

ISO 8601-tidsstämpel för den senaste uppdateringen av profilen. Kan vara `null`.

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

Paneler som var kopplade till den här bokningen före avbokningen. Slå upp panelinformation (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 (se [Lägg till anpassade
biomarkörer](https://docs.anivahealth.com/sv/api/appointments/add-individual-biomarkers.md)). Korsreferera 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 var länkade till den här bokningen före avbokningen. Varje `id` korsrefererar
till [Hämta försändelse](https://docs.anivahealth.com/sv/api/shipments/get-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`.

## Felsvar

| Status | Beskrivning |
| - | - |
| `400` | Ogiltigt ID-format, eller en felformaterad body / `cancellation_reason` längre än 500 tecken. |
| `403` | Åtkomst nekad — din API-nyckel har inte åtkomst till den här åtgärden eller så ligger bokningen utanför din åtkomstkontext. |
| `404` | Bokningen hittades inte. |
| `409` | Blodprovstagningen har redan bekräftats, eller så är bokningen redan avbokad med en annan orsak. |
| `500` | Internt serverfel. |

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

```bash cURL (with a reason) theme={null}
curl --request DELETE \
  --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 '{
    "cancellation_reason": "Patient no-show"
  }'
```

```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": "cancelled",
  "cancellation_reason": "Patient no-show",
  "results_ready_emails": [],
  "draw_method": "venous",
  "created_at": "2026-04-01T09:45:00Z",
  "updated_at": "2026-04-10T12:00: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": "This appointment is already cancelled with a different cancellation_reason. Re-send the recorded reason, or omit it, to read the cancelled appointment back."
}
```

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


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