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

# Opprett time

> Bestill en time til blodprøvetaking for en profil på et teststed

Bestill en time for blodprøvetaking for en pasientprofil på en bestemt testlokasjon. Når timen er opprettet, får den statusen `confirmed` som standard (noen lokasjoner kan i stedet ha `pending` som standard — dette stilles inn per lokasjon). Bruk [Legg til paneler](https://docs.anivahealth.com/no/api/appointments/add-panels.md) for å legge til blodprøvepaneler før du [bekrefter blodprøvetakingen](https://docs.anivahealth.com/no/api/appointments/confirm-blood-draw.md).

> [!NOTE]
>
> En profil kan ha høyst **én** time per lokasjon og tidspunkt. Hvis du oppretter en time for
> en tidsluke profilen allerede har, returneres `409` med eksisterende `appointment_id` i stedet for
> en ny time — slik at en ny eller utilsiktet gjentatt forespørsel aldri kan opprette en dobbeltbestilling.
> Se [Dupliserte timer](#dupliserte-timer).

Send en valgfri `Idempotency-Key`-header for å gjøre denne opprettelsen trygg å prøve på nytt — hvis samme nøkkel sendes igjen, returneres det opprinnelige svaret i stedet for å opprette en til. Se [Idempotens](https://docs.anivahealth.com/no/concepts/idempotency.md).

Krever scopet `appointments_schedule`.

## Forespørsel

### Body-parametere

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

UUID for pasientprofilen det skal opprettes time for.

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

UUID for testlokasjonen der blodprøvetakingen skal finne sted. Bruk [List opp
lokasjoner](https://docs.anivahealth.com/no/api/locations/list-locations.md) for å finne tilgjengelige lokasjons-ID-er.

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

Dato og klokkeslett for timen i ISO 8601-format (f.eks. `2026-05-15T10:30:00Z` eller
`2026-05-15T12:30:00+02:00`). **Må inkludere tidssoneangivelse** — enten `Z` eller en eksplisitt
tidsforskyvning som `+02:00`; tidspunkter uten tidssone avvises. Må ligge i fremtiden.

Må være en nøyaktig starttid for en tidsluke i lokasjonens timeplan, og tidsluken må fortsatt ha kapasitet — les
[Hent tilgjengelighet](https://docs.anivahealth.com/no/api/locations/get-availability.md) først. Tidspunkter utenfor timeplanen returnerer `400`, og en tidsluke som
er full returnerer `409`. På lokasjoner som drives av Aniva, må tidspunktet også være minst 12 timer frem i tid — se
[Minimumsfrist](#minimumsfrist).

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

Opptil 5 adresser som hver får én e-post når alle laboratorieresultatene er endelige. E-posten lenker til
resultatsiden i Anivas adminpanel. Nøkkelen din må ha `results_view`-tilgang til pasienten, ellers
returneres `403`. Utelat feltet for å bruke standardadressene som er angitt for pasientens gruppe. En tom liste slår
e-postene av. Se [E-poster om klare resultater](https://docs.anivahealth.com/no/concepts/results.md#e-poster-nar-resultater-er-klare).

**draw\_method** `string`

Hvordan blodprøvetakingen utføres: `capillary` eller `venous`. Utelat feltet for å bruke lokasjonens
`default_draw_method`. Lokasjonen må ha metoden i `draw_methods`, ellers returneres `400`.

## Respons

Når kallet lykkes, returnerer API-et `201 Created` med den nye timen.

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

Gjeldende status for timen. En av `pending`, `confirmed`, `blood_drawn` eller `cancelled`.
Detaljert status for laboratorieresultater henter du fra [Hent resultater](https://docs.anivahealth.com/no/api/appointments/get-results.md),
og mer detaljert fremdrift for forsendelser fra hvert element i den innebygde `shipments`-listen (se nedenfor)
videre til [Hent forsendelse](https://docs.anivahealth.com/no/api/shipments/get-shipment.md).

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

**profile** `object` *required*

Pasientprofilen som er knyttet til denne timen.

**profil**

**id** `string`

Unik profil-ID (UUID).

**handle** `string`

Profilnavn 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 formatet `YYYY-MM-DD`. 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`.

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

Paneler som for øyeblikket er knyttet til denne timen. Tom for nyopprettede timer — legg til via
[Legg til paneler](https://docs.anivahealth.com/no/api/appointments/add-panels.md). Slå opp detaljer om paneler (navn, biomarkører) via
[List opp 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*

Enkeltstående biomarkører som er knyttet til denne timen utenom paneler. Tom for nyopprettede
timer — legg til via [Legg til individuelle biomarkører](https://docs.anivahealth.com/no/api/appointments/add-individual-biomarkers.md).
Slå opp hver `biomarker_id` mot [List opp 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 er knyttet til denne timen, med eldste kobling først. Tom for nyopprettede timer —
knytt til via [Opprett forsendelse](https://docs.anivahealth.com/no/api/shipments/create-shipment.md) (med `appointment_id`) eller
[Knytt timer til forsendelse](https://docs.anivahealth.com/no/api/shipments/attach-appointments-to-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`.

## Minimumsfrist

Timer på lokasjoner som drives av Aniva, må bestilles minst **12 timer** i forveien; bestilling innenfor
dette vinduet returnerer `400`. [Hent tilgjengelighet](https://docs.anivahealth.com/no/api/locations/get-availability.md) holder allerede tilbake
disse tidslukene, så alt du leser fra den timeplanen, kan bestilles.

Lokasjoner du driver selv har ingen minimumsfrist — bestilling samme dag og drop-in er uendret.

## Dupliserte timer

En profil kan ha høyst én ikke-avbestilt time per lokasjon og tidspunkt — én person kan ikke
gjennomføre blodprøvetaking to ganger på samme sted og tidspunkt, uansett hvor mange stoler lokasjonen har.

Hvis du oppretter en time for en tidsluke profilen allerede har, returneres `409` med en
`appointment_id` som angir timen som allerede finnes:

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

Håndter dette ved å behandle forespørselen som allerede utført: hent timen med
[Hent time](https://docs.anivahealth.com/no/api/appointments/get-appointment.md), flytt den med
[Oppdater time](https://docs.anivahealth.com/no/api/appointments/update-appointment.md), eller fjern den med
[Avbestill time](https://docs.anivahealth.com/no/api/appointments/cancel-appointment.md). Ikke prøv opprettelsen på nytt — den vil fortsette
å returnere `409`.

Dette gjør gjentatte opprettelser trygge: en forespørsel du sender på nytt etter et tidsavbrudd, eller et skjema som sendes inn to ganger,
kan ikke opprette to timer for samme pasient på samme tidspunkt.

> [!NOTE]
>
> `appointment_id` er bare med på `409` ved duplikat. Ved `409` på grunn av kapasitet — tidsluken er full
> fordi *andre* pasienter har den — returneres kun `error`, og riktig løsning da er å velge
> en annen tidsluke fra [Hent tilgjengelighet](https://docs.anivahealth.com/no/api/locations/get-availability.md).

## Feilresponser

| Status | Beskrivelse |
| - | - |
| `400` | Valideringsfeil – f.eks. at `scheduled_at` er i fortiden, er mindre enn 12 timer frem i tid på en Aniva-drevet lokasjon eller ikke er en eksakt start på en tidsluke i lokasjonens timeplan, eller at lokasjonen ikke har beholdere på lager for `draw_method`. |
| `403` | Forbudt – API-nøkkelen din har ikke tilgang til denne operasjonen, eller `results_ready_emails` er satt uten `results_view`-tilgang til pasienten. |
| `404` | Profil eller lokasjon ble ikke funnet, eller lokasjonen er inaktiv. |
| `409` | Denne profilen har allerede en time på denne lokasjonen og dette tidspunktet (inneholder `appointment_id`), tidsluken er full, lokasjonen er stengt den datoen, eller `Idempotency-Key` ble brukt på nytt med en annen body, eller den opprinnelige forespørselen er ikke fullført. |
| `500` | Intern serverfeil. |

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