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

# Aflys tid

> Aflys en tid til blodprøvetagning

Aflys en tid ved at sætte dens status til `cancelled`. Kun tider, hvor blodprøvetagningen endnu ikke er bekræftet, kan aflyses.

At aflyse en tid, der allerede er `cancelled`, returnerer `200` med den tid og skriver intet — der registreres ingen ny aflysning. Svaret har `Idempotent-Replayed: true`, så du kan skelne en gentagelse fra det kald, der udførte arbejdet. En gentagelse med en **anden** `cancellation_reason` returnerer i stedet `409`: den registrerede årsag bliver aldrig overskrevet. Se [Idempotens](https://docs.anivahealth.com/da/concepts/idempotency.md).

> [!WARNING]
>
> Tider kan ikke aflyses, når blodprøvetagningen er bekræftet — det returnerer `409
>     Conflict`.

Kræver scope `appointments_schedule` eller `appointments_manage`.

## Forespørgsel

### Stiparametre

**id** `string` *required*

Unikt id (UUID) for den tid, der skal aflyses.

### Body-parametre

Body er valgfri — send slet ingen body for at aflyse uden at registrere en årsag.

**cancellation\_reason** `string`

Fritekstårsag til aflysningen på op til 500 tegn (f.eks. `Patient no-show`). Gemmes på
tiden og returneres som `cancellation_reason` i dette og senere opslag.

## Svar

Ved succes returnerer API'et `200 OK` med den aflyste tid og dens indlejrede profil.

**id** `string` *required*

Unikt id for tiden (UUID).

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

UUID for den profil, denne tid tilhører.

**location\_id** `string`

UUID for det teststed, hvor blodprøvetagningen finder sted.

**scheduled\_at** `string`

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

**status** `string` *required*

Tidens status. Vil være `cancelled` efter en gennemført aflysning.

**cancellation\_reason** `string`

Fritekstårsag registreret ved aflysning af tiden (f.eks. udeblivelse, sen aflysning,
'Failed. Repeat required'). `null`, medmindre `status` er `cancelled`.

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

Adresser med små bogstaver, som hver modtager én e-mail, når alle laboratorieresultater er endelige. Tom, når funktionen er slået fra. Se
[E-mails når resultater er klar](https://docs.anivahealth.com/da/concepts/results.md#e-mails-nar-resultater-er-klar).

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

Hvordan blodet tages: `capillary` (fingerspids eller overarm i mikrorør) eller `venous` (fra venen
i prøveglas). Det er den metode, tiden angiver, ellers `default_draw_method` for dens
[lokation](https://docs.anivahealth.com/da/concepts/locations.md). Efter blodprøvetagningen er det den metode, der blev brugt.

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

ISO 8601-tidsstempel for, hvornår tiden blev oprettet.

**updated\_at** `string`

ISO 8601-tidsstempel for den seneste opdatering. Kan være `null`.

**profile** `object` *required*

Den patientprofil, der er knyttet til denne tid.

**Profil**

**id** `string`

Unikt id for profilen (UUID).

**handle** `string`

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

**first\_name** `string`

Fornavn. Kan være `null`.

**last\_name** `string`

Efternavn. Kan være `null`.

**email** `string`

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

**phone** `string`

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

**sex** `integer`

Biologisk køn efter ISO/IEC 5218. Kan være `null`.

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

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

**height** `number`

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

**weight** `number`

Vægt i kilogram. Kan være `null`.

**language** `string`

Foretrukket sprog: en af de 32 koder i [Opret profil](https://docs.anivahealth.com/da/api/profiles/create-profile.md).

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

Om denne profil modtager transaktionelle (programmatiske) e-mails. Kan være `null`.

**created\_at** `string`

ISO 8601-tidsstempel for, hvornår profilen blev oprettet.

**updated\_at** `string`

ISO 8601-tidsstempel for den seneste opdatering af profilen. Kan være `null`.

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

Paneler, der var knyttet til denne tid før aflysningen. Slå paneldetaljer (navn,
biomarkører) op via [Vis paneler](https://docs.anivahealth.com/da/api/panels/list-panels.md).

**Felter for tilknyttet panel**

**panel\_id** `string`

Panelets UUID — krydsreferer med [Vis paneler](https://docs.anivahealth.com/da/api/panels/list-panels.md).

**added\_at** `string`

ISO 8601-tidsstempel for, hvornår panelet første gang blev knyttet til denne tid.

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

À la carte-biomarkører knyttet til denne tid uden for et panel (se [Tilføj valgfrie
biomarkører](https://docs.anivahealth.com/da/api/appointments/add-individual-biomarkers.md)). Krydsreferer hvert `biomarker_id`
med [Vis biomarkører](https://docs.anivahealth.com/da/api/biomarkers/list-biomarkers.md) for visningsdata.

**Felter for individuel biomarkør**

**biomarker\_id** `integer`

Biomarkør-id — krydsreferer med
[Vis biomarkører](https://docs.anivahealth.com/da/api/biomarkers/list-biomarkers.md).

**added\_at** `string`

ISO 8601-tidsstempel for, hvornår biomarkøren første gang blev knyttet til denne tid.

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

Forsendelser, der var knyttet til denne tid før aflysningen. Hvert `id` krydsrefererer
til [Hent forsendelse](https://docs.anivahealth.com/da/api/shipments/get-shipment.md).

**Felter for forsendelseslink**

**id** `string`

Forsendelsens reference-id — krydsreferer med
[Hent forsendelse](https://docs.anivahealth.com/da/api/shipments/get-shipment.md).

**added\_at** `string`

ISO 8601-tidsstempel for, hvornår forsendelsen første gang blev knyttet til denne tid.

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

Laboratoriekoder (stregkoder på prøveglas) registreret for denne tid i scanningsrækkefølge. Tom, indtil blodprøvetagningen
er bekræftet. En venøs blodprøvetagning har én kode trykt på hvert prøveglas; en kapillær blodprøvetagning har én
kode pr. mikrorør. Resultater og dokumenter i [Hent resultater](https://docs.anivahealth.com/da/api/appointments/get-results.md) henviser
til disse koder via `lab_code`.

## Fejlsvar

| Status | Beskrivelse |
| - | - |
| `400` | Ugyldigt id-format, eller en ugyldig body / `cancellation_reason` på mere end 500 tegn. |
| `403` | Forbudt — din API-nøgle har ikke adgang til denne handling, eller tiden ligger uden for din adgangskontekst. |
| `404` | Tiden blev ikke fundet. |
| `409` | Blodprøvetagningen er allerede bekræftet, eller tiden er allerede aflyst med en anden årsag. |
| `500` | Intern serverfejl. |

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