> ## 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 bestilling av hjemmetestsett

> Bestill et postsendt hjemmetestsett for en profil

Be om en bestilling av hjemmetestsett for en pasientprofil. En bestilling av hjemmetestsett sender et gjør-det-selv-testsett i posten — Aniva sender settet til leveringsadressen, pasienten tar prøven selv hjemme og sender den tilbake i posten. Dette skiller seg fra en [time](https://docs.anivahealth.com/no/api/appointments/create-appointment.md), som er en venøs blodprøvetaking på et teststed.

**Nøyaktig ett panel kreves.** Et hjemmetestsett tilsvarer 1:1 et fysisk settprodukt — panelet er settet — og bestillingen går rett i pakkekøen så snart den er opprettet, så sammensetningen må være endelig på forhånd. Du kan likevel bytte panel via [Oppdater bestilling av hjemmetestsett](https://docs.anivahealth.com/no/api/home-kit-orders/update-home-kit.md) mens bestillingen er `pending`.

## Erstatningssett

Når et sett ikke kan gi resultater — pasienten fikk ikke fylt røret, prøven kom frem med for lite materiale, laboratoriet kunne ikke analysere den — bestiller du en **erstatning** ved å sende `replaces_home_kit_order_id`.

En erstatning er en ny bestilling med en ny laboratoriekode, også når det første settet aldri ble aktivert: laboratoriet trenger en ny rekvisisjon, og to prøver under én kode kan ikke skilles fra hverandre. Bestillingen du erstatter blir ikke berørt — den beholder sin egen status, sin egen laboratoriekode og eventuelle resultater som allerede er registrert på den.

To ting følger av dette:

* **Panelet arves.** Utelat `panel_id`, så får erstatningen panelet fra bestillingen den erstatter, som er det pasienten kjøpte og slik esken er profilert.
* **Du velger hva som kjøres på nytt.** Send `biomarker_ids` med markørene som feilet, så kjører laboratoriet bare disse på nytt, og settet sendes bare med rørene som trengs. Utelat feltet for å kjøre hele panelet på nytt.

Markører kjøres på nytt som panelets grupper, ikke én og én. Oppgir du én markør i en gruppe, kjøres hele gruppen på nytt, fordi en laboratoriebestilling som rapporterer mer enn det som ble bedt om ikke kan legges inn. En erstatning for én markør kan derfor komme med mer enn ett resultat, og antall rør kan være høyere enn markørlisten antyder.

Bare én erstatning per sett kan være på vei av gangen.

> [!NOTE]
>
> Hvis du integrerte før disse feltene fantes, leser Aniva også `metadata.original_kit_id` og
> `metadata.replacement_reason` ved opprettelse og behandler bestillingen som en erstatning. Dette er det eneste
> stedet metadata tolkes, det finnes bare for å støtte den tidligere integrasjonen, og feltene
> over vinner alltid. Send feltene.

En `201` betyr at bestillingen er bekreftet og sendes videre til ordrehåndtering — du trenger ikke gjøre noe mer for at settet skal bli pakket og sendt.

Krever scope-et `home_kit_orders_manage`.

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

## Forespørsel

### Body-parametere

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

UUID for pasientprofilen bestillingen av hjemmetestsett skal opprettes for.

**panel\_id** `string` *required*

UUID for katalogpanelet som skal bestilles. Nøyaktig ett — et hjemmetestsett tilsvarer 1:1 et fysisk settprodukt,
så panelet er settet. Panel-ID-er oppgis av Aniva for partnerkontoen din; se [List opp
paneler](https://docs.anivahealth.com/no/api/panels/list-panels.md). Valgfritt på en erstatning, der standardverdien er panelet fra
bestillingen du erstatter.

**replaces\_home\_kit\_order\_id** `string`

UUID for bestillingen av hjemmetestsett som denne erstatter. Sender du dette, blir dette et erstatningssett — se
[Erstatningssett](#erstatningssett) over. Bestillingen må tilhøre samme profil, og kan
ikke allerede ha en erstatning på vei.

**replacement\_reason** `string`

Hvorfor erstatningen trengs, i én setning (for eksempel `Zu wenig Material, HbA1c nicht
    auswertbar`). Påkrevd når du sender `replaces_home_kit_order_id`, og ignoreres ellers. Høyst
500 tegn.

**biomarker\_ids** `integer[]`

På en erstatning, markørene laboratoriet skal kjøre på nytt — normalt de det første settet ikke kunne
levere. Hver av dem må være en del av det bestillingen du erstatter ba om; kryssjekk mot [List opp
biomarkører](https://docs.anivahealth.com/no/api/biomarkers/list-biomarkers.md) med `home_kit=true`. Utelat feltet for å kjøre hele panelet på nytt. Godtas bare
sammen med `replaces_home_kit_order_id`, og ikke sammen med en annen `panel_id`.
Dette krever ikke noe ekstra scope: å kjøre markører pasienten allerede har betalt for på nytt er ikke et à la carte-valg.

**metadata** `object`

Dine egne nøkkel/verdi-par, som returneres ordrett ved hver lesing og aldri tolkes av Aniva. Bruk
feltet til å sende med din egen ordrereferanse, slik at du kan koble bestillinger uten å lagre våre ID-er. Høyst 20 nøkler;
nøkler må samsvare med `[A-Za-z0-9_-]` og ha høyst 40 tegn; verdier er en streng, et tall eller en boolsk verdi,
der strenger har høyst 500 tegn; 16 384 byte serialisert totalt. Nøkler som begynner med `aniva_` er
reservert. Legg aldri personopplysninger eller kliniske data i `metadata` — det behandles ikke som pasientdata.

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

**delivery\_address** `object` *required*

Adressen settet skal sendes til — én av to former: enten `{ location_id }` som refererer til et kjent teststed, eller adressefeltene direkte (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` er valgfrie — samme vokabular som i locations-API-et). Oppgi nøyaktig én — en stedsreferanse eller en adresse direkte, ikke begge.

**leveringsadresse**

> [tab] Referanse til et sted
>
> **location\_id** `string` *required*
>
> UUID for et kjent teststed som settet skal sendes til. Koble mot [List opp
> steder](https://docs.anivahealth.com/no/api/locations/list-locations.md).

> [tab] Adresse direkte
>
> **name** `string` *required*
>
> Navn på mottaker, selskap eller sted.
>
> **company\_name** `string`
>
> Selskap som tar imot pakken for mottakeren — en `c/o`-part eller en avdeling.
>
> **street** `string` *required*
>
> Gatenavn, uten husnummer (f.eks. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Husnummer (f.eks. `118` eller `12a`).
>
> **address\_line\_2** `string`
>
> Bygning, inngang eller etasje.
>
> **city** `string` *required*
>
> **state** `string`
>
> Delstat eller provins. Valgfritt.
>
> **postal\_code** `string` *required*
>
> Postnummer. En tysk adresse (`country_code` `DE`) må ha nøyaktig 5 sifre, f.eks. `10117`.
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2-kode (to bokstaver, f.eks. `DE`). Små bokstaver godtas og lagres som store
> bokstaver.
>
> **phone** `string`
>
> Mottakerens telefonnummer, med landskode (f.eks. `+4791234567`). Transportøren bruker det til å
> varsle mottakeren om pakken, for eksempel at den venter på et hentested. Utelater
> du det, får ikke transportøren noe telefonnummer.
>
> **email** `string`
>
> Mottakerens e-postadresse. Transportøren bruker den på samme måte som `phone`. Utelater du den, får ikke transportøren noen
> e-postadresse.

> [!NOTE]
>
> **Packstation eller Postfiliale (bare Tyskland):** sett `street` til `Packstation` eller `Postfiliale`,
> `house_number` til det tresifrede stasjonsnummeret, og `address_line_2` til mottakerens DHL
> Postnummer (6–10 sifre, mellomrom er tillatt). Uten Postnummer kan pakken ikke bestilles.
> Postfach støttes ikke.

## Respons

Ved suksess returnerer API-et `201 Created` med den nye bestillingen av hjemmetestsett.

**id** `string` *required*

Unik identifikator (UUID) for bestillingen av hjemmetestsett.

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

UUID for profilen denne bestillingen av hjemmetestsett tilhører.

**status** `string` *required*

Nåværende status for bestillingen av hjemmetestsett. Én av `pending`, `dispatched`, `activated` eller `cancelled`. En
nyopprettet bestilling starter i `pending`.

**delivery\_address** `object` *required*

Adressen settet skal sendes til – én av to former: enten `{ location_id }` som refererer til et kjent teststed, eller direkte adressefelt (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` er valgfrie – samme struktur som i lokasjons-API-et). Oppgi nøyaktig én – en stedsreferanse eller en direkte adresse, ikke begge.

**leveringsadresse**

> [tab] Stedsreferanse
>
> **location\_id** `string` *required*
>
> UUID for teststedet settet sendes til.

> [tab] Direkte adresse
>
> **name** `string` *required*
>
> Navn på mottaker, bedrift eller sted.
>
> **company\_name** `string`
>
> Bedrift som tar imot pakken for mottakeren – en `c/o`-mottaker eller en avdeling.
>
> **street** `string` *required*
>
> Gatenavn, uten husnummer (f.eks. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Husnummer (f.eks. `118` eller `12a`).
>
> **address\_line\_2** `string`
>
> Bygning, inngang eller etasje.
>
> **city** `string` *required*
>
> **state** `string`
>
> Delstat eller provins. Valgfritt.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2-kode (to bokstaver, f.eks. `DE`).
>
> **phone** `string`
>
> **email** `string`

**metadata** `object` *required*

Nøkkel/verdi-parene du oppga. Alltid til stede — `{}` når du ikke angir noen.

**replaces\_home\_kit\_order\_id** `string`

Bestillingen av hjemmetestsett som denne erstatter. `null` på en vanlig bestilling.

**replacement\_reason** `string`

Begrunnelsen du oppga. `null` på en vanlig bestilling.

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

**lab\_code** `string`

Prøvekode hos laboratoriet som resultatene rapporteres under – trykt på det fysiske settet, og det
pasienten leser av esken som aktiveringskode. `null` til settet er pakket.
Skrivebeskyttet.

**activated\_at** `string` *required*

Tidspunkt for prøvetaking rapportert via [Aktiver](https://docs.anivahealth.com/no/api/home-kit-orders/activate-home-kit.md). `null` frem til
settet er aktivert.

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

ISO 8601-tidsstempel for når bestillingen av hjemmetestsett ble opprettet.

**updated\_at** `string`

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

**profile** `object` *required*

Pasientprofilen som er knyttet til denne bestillingen av hjemmetestsett.

**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** `HomeKitOrderPanel[]` *required*

Panelet knyttet til denne bestillingen av hjemmetestsett — det du oppga som `panel_id`, stemplet med
opprettelsestidspunktet for bestillingen. Alltid nøyaktig ett. Slå opp paneldetaljer (navn, biomarkører) via
[List opp paneler](https://docs.anivahealth.com/no/api/panels/list-panels.md).

**Felter for tilknyttet panel**

**panel\_id** `string`

Panel-UUID – kryssreferanse 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 bestillingen av hjemmetestsett.

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

Biomarkører lagt til utenfor panelet. Tom ved en vanlig opprettelse — bestillinger av hjemmetestsett bestilles per
panel, og å endre denne listen i etterkant krever
funksjonsscopet `home_kit_orders_individual_biomarker_selection`. På en erstatning inneholder den
`biomarker_ids` du sendte, som er det laboratoriet kjører på nytt.

**Felter for enkeltstående biomarkør**

**biomarker\_id** `integer`

Biomarkør-ID – kryssreferanse mot
[Vis biomarkører](https://docs.anivahealth.com/no/api/biomarkers/list-biomarkers.md) med `home_kit=true`.

**added\_at** `string`

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

**shipments** `HomeKitOrderShipmentLink[]` *required*

Pakker koblet til denne bestillingen av hjemmetestsett, eldste kobling først. Alltid tom ved opprettelse — les
de fullstendige pakkene med [List opp forsendelser](https://docs.anivahealth.com/no/api/shipments/list-shipments.md) og `?home_kit_order_id=`.

**Felter for forsendelseskobling**

**id** `string`

Forsendelsesreferanse – kryssreferanse mot [Hent forsendelse](https://docs.anivahealth.com/no/api/shipments/get-shipment.md).

**added\_at** `string`

ISO 8601-tidsstempel for når forsendelsen ble koblet til denne bestillingen av hjemmetestsett.

## Feilresponser

| Status | Beskrivelse |
| - | - |
| `400` | Valideringsfeil — f.eks. mangler `delivery_address` et felt eller har et tysk postnummer som ikke er på 5 sifre, `panel_id` er ikke en gyldig UUID, eller `replacement_reason` mangler på en erstatning. |
| `403` | Forbudt — API-nøkkelen din har ikke tilgang til denne operasjonen, profilen er utenfor tilgangsscopet ditt, eller du satte `results_ready_emails` uten `results_view`-tilgang til pasienten. |
| `404` | Profil, panel eller bestillingen av hjemmetestsett som skal erstattes ble ikke funnet. |
| `409` | Konflikt — `Idempotency-Key` er allerede brukt med et annet innhold, den opprinnelige forespørselen er ikke fullført ennå, eller settet du erstatter har allerede en erstatning på vei. |
| `422` | Panelet kan ikke bestilles som et hjemmetestsett — det er ikke konfigurert noe settprodukt for utsendelse for det. På en erstatning: bestillingen du erstatter tilhører en annen profil, en oppføring i `biomarker_ids` er ikke en del av det den ba om, eller du sendte markører sammen med en annen `panel_id`. |
| `500` | Intern serverfeil. |

```bash cURL theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/home-kit-orders \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
    "metadata": { "your_order_ref": "ORD-10482", "priority": true },
    "delivery_address": {
      "name": "Maria Schmidt",
      "company_name": "c/o Weber",
      "street": "Friedrichstraße",
      "house_number": "123",
      "postal_code": "10117",
      "city": "Berlin",
      "country_code": "DE",
      "phone": "+4930123456789",
      "email": "maria.schmidt@example.com"
    }
  }'
```

```bash Replacement kit theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/home-kit-orders \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "replaces_home_kit_order_id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
    "replacement_reason": "Too little material, HbA1c could not be analysed",
    "biomarker_ids": [103],
    "metadata": { "your_order_ref": "ORD-10482-R1" },
    "delivery_address": {
      "name": "Maria Schmidt",
      "street": "Friedrichstraße",
      "house_number": "123",
      "postal_code": "10117",
      "city": "Berlin",
      "country_code": "DE"
    }
  }'
```

```json 201 theme={null}
{
  "id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
  "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "status": "pending",
  "delivery_address": {
    "name": "Maria Schmidt",
    "company_name": "c/o Weber",
    "address_line_2": null,
    "street": "Friedrichstraße",
    "house_number": "123",
    "postal_code": "10117",
    "city": "Berlin",
    "country_code": "DE",
    "phone": "+4930123456789",
    "email": "maria.schmidt@example.com"
  },
  "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": [
    {
      "panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
      "added_at": "2026-04-01T09:45:00Z"
    }
  ],
  "individual_biomarkers": [],
  "metadata": { "your_order_ref": "ORD-10482", "priority": true },
  "replaces_home_kit_order_id": null,
  "replacement_reason": null,
  "results_ready_emails": [],
  "lab_code": null,
  "activated_at": null,
  "shipments": []
}
```

```json 400 theme={null}
{
  "error": "panel_id: panel_id must be a valid UUID"
}
```

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

```json 409 theme={null}
{
  "error": "Idempotency-Key \"ORD-10482\" was already used with a different request body. Use a new key for a different request, or resend the original body to read back its result."
}
```


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