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

# Avbestill time

> Avbestill en time til blodprøvetaking

Avbestill en time ved å sette statusen til `cancelled`. Bare timer der blodprøvetakingen ennå ikke er bekreftet, kan avbestilles.

Å avbestille en time som allerede er `cancelled`, returnerer `200` med den timen og skriver ingenting – ingen ny avbestilling registreres. Svaret inneholder `Idempotent-Replayed: true` slik at du kan skille en gjentakelse fra kallet som utførte jobben. En gjentakelse med en **annen** `cancellation_reason` returnerer i stedet `409`: den registrerte årsaken overskrives aldri. Se [Idempotens](https://docs.anivahealth.com/no/concepts/idempotency.md).

> [!WARNING]
>
> Timer kan ikke avbestilles etter at blodprøvetakingen er bekreftet – det returnerer `409
>     Conflict`.

Krever tilgangsomfanget `appointments_schedule` eller `appointments_manage`.

## Forespørsel

### Stiparametere

**id** `string` *required*

Unik identifikator (UUID) for timen som skal avbestilles.

### Body-parametere

Body er valgfri – ikke send noen body i det hele tatt for å avbestille uten å registrere en årsak.

**cancellation\_reason** `string`

Fritekstårsak for avbestillingen, opptil 500 tegn (f.eks. `Patient no-show`). Lagres på
timen og returneres som `cancellation_reason` ved dette og senere oppslag.

## Respons

Når kallet lykkes, returnerer API-et `200 OK` med den avbestilte timen og den innebygde profilen.

**id** `string` *required*

Unik timeidentifikator (UUID).

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

UUID for profilen denne timen tilhører.

**location\_id** `string`

UUID for teststedet der blodprøvetakingen finner sted.

**scheduled\_at** `string`

Planlagt tidspunkt for timen i UTC (ISO 8601 med `Z`-suffiks, f.eks.
`2026-05-15T10:30:00Z`). Kan være `null`.

**status** `string` *required*

Timestatus. Vil være `cancelled` etter en vellykket avbestilling.

**cancellation\_reason** `string`

Fritekstårsak som ble registrert da timen ble avbestilt (f.eks. manglende oppmøte, sen avbestilling,
«Mislyktes. Må gjentas»). `null` med mindre `status` er `cancelled`.

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

Adresser som hver får én e-post når alle labresultater er endelige, i små bokstaver. Tom når den er slått av. Se
[E-poster om klare resultater](https://docs.anivahealth.com/no/concepts/results.md#e-poster-nar-resultater-er-klare).

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

Hvordan blodprøven tas: `capillary` (fingertupp eller overarm, i mikrorør) eller `venous` (fra vene,
i prøverør). Det er metoden som er satt på timen, ellers `default_draw_method` for
[stedet](https://docs.anivahealth.com/no/concepts/locations.md). Etter blodprøvetakingen er det metoden som ble brukt.

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

ISO 8601-tidsstempel for når timen ble opprettet.

**updated\_at** `string`

ISO 8601-tidsstempel for siste oppdatering. Kan være `null`.

**profile** `object` *required*

Pasientprofilen som er knyttet til denne timen.

**profil**

**id** `string`

Unik profilidentifikator (UUID).

**handle** `string`

Profil-handle eller brukernavn. Kan være `null`.

**first\_name** `string`

Fornavn. Kan være `null`.

**last\_name** `string`

Etternavn. Kan være `null`.

**email** `string`

E-postadresse. Kan være `null`.

**phone** `string`

Telefonnummer i E.164-format. Kan være `null`.

**sex** `integer`

Biologisk kjønn etter ISO/IEC 5218. Kan være `null`.

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

Fødselsdato i `YYYY-MM-DD`-format. Kan være `null`.

**height** `number`

Høyde i centimeter. Kan være `null`.

**weight** `number`

Vekt i kilogram. Kan være `null`.

**language** `string`

Foretrukket språk: en av de 32 kodene i [Opprett profil](https://docs.anivahealth.com/no/api/profiles/create-profile.md).

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

Om denne profilen mottar transaksjonelle (programmatiske) e-poster. Kan være `null`.

**created\_at** `string`

ISO 8601-tidsstempel for når profilen ble opprettet.

**updated\_at** `string`

ISO 8601-tidsstempel for siste profiloppdatering. Kan være `null`.

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

Paneler som var knyttet til denne timen før avbestillingen. Slå opp paneldetaljer (navn,
biomarkører) via [Vis paneler](https://docs.anivahealth.com/no/api/panels/list-panels.md).

**Felt for tilknyttet panel**

**panel\_id** `string`

Panel-UUID – kryssreferer mot [Vis paneler](https://docs.anivahealth.com/no/api/panels/list-panels.md).

**added\_at** `string`

ISO 8601-tidsstempel for når panelet først ble knyttet til denne timen.

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

Enkeltbiomarkører knyttet til denne timen utenfor et panel (se [Legg til egendefinerte
biomarkører](https://docs.anivahealth.com/no/api/appointments/add-individual-biomarkers.md)). Kryssreferer hver `biomarker_id`
mot [Vis biomarkører](https://docs.anivahealth.com/no/api/biomarkers/list-biomarkers.md) for visningsdata.

**Felt for enkeltbiomarkør**

**biomarker\_id** `integer`

Biomarkøridentifikator – kryssreferer mot
[Vis biomarkører](https://docs.anivahealth.com/no/api/biomarkers/list-biomarkers.md).

**added\_at** `string`

ISO 8601-tidsstempel for når biomarkøren først ble knyttet til denne timen.

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

Forsendelser som var koblet til denne timen før avbestillingen. Hver `id` kryssrefererer
til [Hent forsendelse](https://docs.anivahealth.com/no/api/shipments/get-shipment.md).

**Felt for forsendelseskobling**

**id** `string`

Referanseidentifikator for forsendelsen – kryssreferer mot
[Hent forsendelse](https://docs.anivahealth.com/no/api/shipments/get-shipment.md).

**added\_at** `string`

ISO 8601-tidsstempel for når forsendelsen først ble koblet til denne timen.

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

Labkoder (strekkoder på prøverør) som er registrert for denne timen, i skannerekkefølge. Tom til blodprøvetakingen
er bekreftet. En venøs blodprøvetaking har én kode trykket på hvert prøverør; en kapillær blodprøvetaking har én
kode per mikrorør. Resultater og dokumenter i [Hent resultater](https://docs.anivahealth.com/no/api/appointments/get-results.md) refererer til
disse kodene via `lab_code`.

## Feilresponser

| Status | Beskrivelse |
| - | - |
| `400` | Ugyldig ID-format, eller feilformatert body / `cancellation_reason` på over 500 tegn. |
| `403` | Ingen tilgang – API-nøkkelen din har ikke tilgang til denne operasjonen, eller timen ligger utenfor tilgangskonteksten din. |
| `404` | Timen ble ikke funnet. |
| `409` | Blodprøvetakingen er allerede bekreftet, eller timen er allerede avbestilt med en annen årsak. |
| `500` | Intern serverfeil. |

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