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

# Opret ordre på hjemmetestkit

> Bestil et postsendt hjemmetestkit til en profil

Anmod om en ordre på et hjemmetestkit til en patientprofil. En ordre på et hjemmetestkit sender et gør-det-selv-testkit med posten — Aniva sender kittet til leveringsadressen, patienten tager selv en prøve derhjemme og sender den tilbage. Det adskiller sig fra en [tid](https://docs.anivahealth.com/da/api/appointments/create-appointment.md), som er en venøs blodprøvetagning på et teststed.

**Der kræves præcis ét panel.** Et hjemmetestkit svarer 1:1 til et fysisk kitprodukt — panelet er kittet — og ordren kommer i pakkekøen, så snart den oprettes, så sammensætningen skal ligge fast fra starten. Du kan stadig skifte panelet via [Opdater ordre på hjemmetestkit](https://docs.anivahealth.com/da/api/home-kit-orders/update-home-kit.md), mens ordren har status `pending`.

## Erstatningskits

Når et kit ikke kan levere sine resultater — patienten kunne ikke fylde røret, prøven ankom med for lidt materiale, laboratoriet kunne ikke analysere den — så bestil en **erstatning** ved at sende `replaces_home_kit_order_id`.

En erstatning er en ny ordre med en ny laboratoriekode, også når det første kit aldrig blev aktiveret: Laboratoriet har brug for en ny rekvisition, og to prøver med samme kode kan ikke skelnes fra hinanden. Den ordre, du erstatter, røres ikke — den beholder sin egen status, sin egen laboratoriekode og eventuelle resultater, der allerede er registreret under den.

To ting følger af det:

* **Panelet nedarves.** Udelad `panel_id`, så overtager erstatningen panelet fra den ordre, den erstatter, hvilket er det, patienten har købt, og sådan æsken er brandet.
* **Du vælger, hvad der skal køres igen.** Send `biomarker_ids` med de markører, der fejlede, så kører laboratoriet kun dem igen, og kittet indeholder kun de rør, de kræver. Udelad feltet for at køre hele panelet igen.

Markører køres igen som panelets grupper, ikke én ad gangen. Angiver du én markør i en gruppe, køres hele gruppen igen, fordi der ikke kan oprettes en laboratorieordre, som rapporterer mere, end der blev bestilt. En erstatning med én markør kan derfor komme tilbage med mere end ét resultat, og antallet af rør kan være større, end listen over markører antyder.

Der må kun være én erstatning pr. kit på vej ad gangen.

> [!NOTE]
>
> Hvis du integrerede, før disse felter fandtes, læser Aniva også `metadata.original_kit_id` og
> `metadata.replacement_reason` ved oprettelse og behandler ordren som en erstatning. Det er det
> eneste sted, hvor metadata fortolkes; det findes kun for at understøtte den tidligere integration,
> og felterne ovenfor vinder altid. Send felterne.

En `201` betyder, at ordren er bekræftet og sendes videre til ekspedition — du behøver ikke gøre andet, for at kittet bliver pakket og sendt.

Kræver scopet `home_kit_orders_manage`.

Send en valgfri `Idempotency-Key`-header for at gøre denne oprettelse sikker at prøve igen — gentages den samme nøgle, returneres det oprindelige svar i stedet for at oprette endnu en. Se [Idempotens](https://docs.anivahealth.com/da/concepts/idempotency.md).

## Forespørgsel

### Body-parametre

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

UUID for den patientprofil, som ordren på hjemmetestkittet skal oprettes til.

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

UUID for det katalogpanel, der skal bestilles. Præcis ét — et hjemmetestkit svarer 1:1 til et fysisk kitprodukt,
så panelet er kittet. Panel-ID'er udleveres af Aniva til din partnerkonto; se [Vis
paneler](https://docs.anivahealth.com/da/api/panels/list-panels.md). Valgfrit ved en erstatning, hvor det som standard bruger panelet fra den
ordre, du erstatter.

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

UUID for den ordre på et hjemmetestkit, som denne erstatter. Sender du det, bliver ordren et erstatningskit — se
[Erstatningskits](#erstatningskits) ovenfor. Ordren skal tilhøre samme profil og må
ikke allerede have en erstatning på vej.

**replacement\_reason** `string`

Hvorfor erstatningen er nødvendig, i én sætning (for eksempel `Zu wenig Material, HbA1c nicht
    auswertbar`). Påkrævet, når du sender `replaces_home_kit_order_id`, og ignoreres ellers. Højst
500 tegn.

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

Ved en erstatning de markører, laboratoriet kører igen — normalt dem, det første kit ikke kunne
levere. Hver markør skal være en del af det, den erstattede ordre bestilte; krydstjek med [Vis
biomarkører](https://docs.anivahealth.com/da/api/biomarkers/list-biomarkers.md) med `home_kit=true`. Udelad feltet for at køre hele panelet igen. Accepteres kun
sammen med `replaces_home_kit_order_id` og ikke sammen med et andet `panel_id`.
Det kræver intet ekstra scope: At køre markører igen, som patienten allerede har betalt for, er ikke et à la carte-valg.

**metadata** `object`

Dine egne nøgle/værdi-par, som returneres ordret ved hver læsning og aldrig fortolkes af Aniva. Brug
det til din egen ordrereference, så du kan koble data sammen uden at gemme vores ID'er. Højst 20 nøgler;
nøgler skal matche `[A-Za-z0-9_-]` og må højst være 40 tegn; værdier skal være en streng, et tal eller en boolean,
hvor strenge højst må være 500 tegn; 16.384 bytes serialiseret i alt. Nøgler, der begynder med `aniva_`, er
reserverede. Læg aldrig personlige eller kliniske data i `metadata` — det behandles ikke som patientdata.

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

Op til 5 adresser, der hver får én e-mail, når alle laboratorieresultater er endelige. E-mailen linker til
resultatsiden i Anivas adminpanel. Din nøgle skal have `results_view`-adgang til patienten, ellers
`403`. Udelad feltet for at bruge de standardadresser, der er angivet for patientens gruppe. En tom liste slår
e-mails fra. Se [E-mails om færdige resultater](https://docs.anivahealth.com/da/concepts/results.md#e-mails-nar-resultater-er-klar).

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

Adressen, kittet skal sendes til — i én af to former: enten `{ location_id }`, der henviser til et kendt teststed, eller de inline-adressefelter (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` er valgfrie — samme feltnavne som i locations-API'et). Angiv præcis én — en henvisning til et teststed eller en inline-adresse, ikke begge.

**leveringsadresse**

> [tab] Henvis til et teststed
>
> **location\_id** `string` *required*
>
> UUID for et kendt teststed, som kittet skal sendes til. Sammenhold med [Vis
> lokationer](https://docs.anivahealth.com/da/api/locations/list-locations.md).

> [tab] Inline-adresse
>
> **name** `string` *required*
>
> Navn på modtager, virksomhed eller sted.
>
> **company\_name** `string`
>
> Virksomhed, der modtager pakken på modtagerens vegne — en `c/o`-adresse eller en afdeling.
>
> **street** `string` *required*
>
> Vejnavn uden husnummer (f.eks. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Husnummer (f.eks. `118` eller `12a`).
>
> **address\_line\_2** `string`
>
> Bygning, opgang eller etage.
>
> **city** `string` *required*
>
> **state** `string`
>
> Delstat eller provins. Valgfrit.
>
> **postal\_code** `string` *required*
>
> Postnummer. En tysk adresse (`country_code` `DE`) kræver præcis 5 cifre, f.eks. `10117`.
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2-kode (to bogstaver, f.eks. `DE`). Små bogstaver accepteres og gemmes som store
> bogstaver.
>
> **phone** `string`
>
> Modtagerens telefonnummer med landekode (f.eks. `+4791234567`). Fragtfirmaet bruger det til at
> give modtageren besked om pakken, f.eks. at den ligger klar i en pakkeshop. Udelader du
> det, får fragtfirmaet intet telefonnummer.
>
> **email** `string`
>
> Modtagerens e-mail. Fragtfirmaet bruger den på samme måde som `phone`. Udelader du den, får fragtfirmaet ingen
> e-mail.

> [!NOTE]
>
> **Packstation eller Postfiliale (kun Tyskland):** Sæt `street` til `Packstation` eller `Postfiliale`,
> `house_number` til det trecifrede stationsnummer og `address_line_2` til modtagerens DHL
> Postnummer (6–10 cifre, mellemrum tilladt). Uden Postnummer kan pakken ikke bookes.
> Postfach understøttes ikke.

## Svar

Ved succes returnerer API'et `201 Created` med den nye ordre på hjemmetestkittet.

**id** `string` *required*

Unikt id (UUID) for hjemmetestkitordren.

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

UUID for den profil, som denne hjemmetestkitordre tilhører.

**status** `string` *required*

Aktuel status for ordren på hjemmetestkittet. En af `pending`, `dispatched`, `activated` eller `cancelled`. En
nyoprettet ordre starter som `pending`.

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

Adressen, som kittet skal sendes til — i en af to former: enten `{ location_id }`, der henviser til en kendt testlokation, eller de direkte adressefelter (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` er valgfri — samme feltnavne som i locations-API'et). Angiv præcis én — enten en lokationsreference eller en direkte adresse, ikke begge dele.

**leveringsadresse**

> [tab] Lokationsreference
>
> **location\_id** `string` *required*
>
> UUID for den testlokation, som kittet sendes til.

> [tab] Direkte adresse
>
> **name** `string` *required*
>
> Navn på modtager, virksomhed eller lokation.
>
> **company\_name** `string`
>
> Virksomhed, der opbevarer pakken for modtageren — en `c/o`-part eller en afdeling.
>
> **street** `string` *required*
>
> Vejnavn uden husnummer (f.eks. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Husnummer (f.eks. `118` eller `12a`).
>
> **address\_line\_2** `string`
>
> Bygning, indgang eller etage.
>
> **city** `string` *required*
>
> **state** `string`
>
> Delstat eller provins. Valgfrit.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2-kode (to bogstaver, f.eks. `DE`).
>
> **phone** `string`
>
> **email** `string`

**metadata** `object` *required*

De nøgle/værdi-par, du har angivet. Altid til stede — `{}`, når du ikke angiver nogen.

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

Den ordre på et hjemmetestkit, som denne erstatter. `null` ved en almindelig ordre.

**replacement\_reason** `string`

Den årsag, du har angivet. `null` ved en almindelig ordre.

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

**lab\_code** `string`

Laboratoriets prøvekode, som resultaterne rapporteres under — trykt på det fysiske kit, og det,
patienten aflæser på æsken som aktiveringskode. `null`, indtil kittet er pakket.
Skrivebeskyttet.

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

Tidspunkt for prøvetagning rapporteret via [Aktiver](https://docs.anivahealth.com/da/api/home-kit-orders/activate-home-kit.md). `null`, indtil
kittet er aktiveret.

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

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

**updated\_at** `string`

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

**profile** `object` *required*

Patientprofilen, der er knyttet til denne hjemmetestkitordre.

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

Panelet, der er knyttet til denne ordre på et hjemmetestkit — det, du angav som `panel_id`, stemplet med
ordrens oprettelsestidspunkt. Altid præcis ét. 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 — slå op i [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 tilknyttet denne hjemmetestkitordre.

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

Biomarkører tilknyttet uden for panelet. Tom ved en almindelig oprettelse — ordrer på hjemmetestkits bestilles pr.
panel, og ændring af denne liste bagefter kræver
`home_kit_orders_individual_biomarker_selection`-scopet. Ved en erstatning indeholder den de
`biomarker_ids`, du sendte, som er dem, laboratoriet kører igen.

**Felter for individuelle biomarkører**

**biomarker\_id** `integer`

Biomarkør-id — slå op i
[Vis biomarkører](https://docs.anivahealth.com/da/api/biomarkers/list-biomarkers.md) med `home_kit=true`.

**added\_at** `string`

ISO 8601-tidsstempel for, hvornår biomarkøren første gang blev tilknyttet denne hjemmetestkitordre.

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

Pakker knyttet til denne ordre på et hjemmetestkit, ældste tilknytning først. Altid tom ved oprettelse — hent de
fulde pakkeoplysninger med [Vis forsendelser](https://docs.anivahealth.com/da/api/shipments/list-shipments.md) og `?home_kit_order_id=`.

**Felter for forsendelsestilknytning**

**id** `string`

Forsendelsesreference — slå op via [Hent forsendelse](https://docs.anivahealth.com/da/api/shipments/get-shipment.md).

**added\_at** `string`

ISO 8601-tidsstempel for, hvornår forsendelsen blev knyttet til denne hjemmetestkitordre.

## Fejlsvar

| Status | Beskrivelse |
| - | - |
| `400` | Valideringsfejl — f.eks. mangler `delivery_address` et felt eller har et tysk postnummer, der ikke er på 5 cifre, `panel_id` er ikke et gyldigt UUID, eller `replacement_reason` mangler ved en erstatning. |
| `403` | Forbudt — din API-nøgle har ikke adgang til denne handling, profilen ligger uden for dit tilladelsesområde, eller du satte `results_ready_emails` uden `results_view`-adgang til patienten. |
| `404` | Profilen, panelet eller den ordre på et hjemmetestkit, der skal erstattes, blev ikke fundet. |
| `409` | Konflikt — `Idempotency-Key` er allerede brugt med en anden body, den oprindelige anmodning er endnu ikke fuldført, eller det kit, du erstatter, har allerede en erstatning på vej. |
| `422` | Panelet kan ikke bestilles som et hjemmetestkit — der er ikke konfigureret et kitprodukt til ekspedition for det. Ved en erstatning: Den ordre, du erstatter, tilhører en anden profil, et element i `biomarker_ids` er ikke en del af det, den bestilte, eller du sendte markører sammen med et andet `panel_id`. |
| `500` | Intern serverfejl. |

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