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

# Oppdater bestilling av hjemmetestsett

> Endre et postsendt hjemmetestsett

Oppdater leveringsadresse, panel, metadata eller e-poster om klare resultater for en bestilling av hjemmetestsett. Ta bare med feltene du vil endre.

Leveringsadressen og panelet kan bare endres mens bestillingen er `pending`, fordi det fysiske settet sendes ved utsendelse. `metadata` er din egen bokføring og kan skrives til i hele bestillingens levetid.

Det finnes ingen endepunkter for å legge til eller fjerne paneler: Et hjemmetestsett inneholder nøyaktig ett panel (det tilsvarer 1:1 et fysisk settprodukt), så den eneste meningsfulle paneloperasjonen er byttet du gjør her.

Krever scope-et `home_kit_orders_manage`.

## Forespørsel

### Stiparametere

**id** `string` *required*

Unik identifikator (UUID) for bestillingen av hjemmetestsett du vil oppdatere.

### Body-parametere

Alle body-parametere er valgfrie – ta bare med feltene du vil endre.

**delivery\_address** `object`

Adressen settet skal sendes til — i ett av to formater: 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 feltstruktur som i steds-API-et). Oppgi nøyaktig én — en stedsreferanse eller en direkte adresse, 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.

**panel\_id** `string`

UUID for panelet som skal knyttes til i stedet for det nåværende — med nøyaktig ett panel per
sett er et bytte den eneste meningsfulle operasjonen. Bare mens bestillingen er `pending`, og
bare til et panel Aniva har konfigurert med et settprodukt for utsendelse (`422` ellers); et
bytte til panelet som allerede er tilknyttet har ingen effekt.

**metadata** `object`

Dine egne nøkkel/verdi-par. **Slås sammen** med eksisterende metadata i stedet for å erstatte
dem: Nøkler du utelater blir beholdt, en nøkkel som sendes med verdien `null` slettes, og et
tomt objekt `{}` tømmer alt. Grensene tilsvarer [Opprett bestilling av
hjemmetestsett](https://docs.anivahealth.com/no/api/home-kit-orders/create-home-kit.md), og valideringen er alt-eller-ingenting —
hvis én nøkkel avvises, skrives ingenting. Legg aldri personlige eller kliniske data i
`metadata` — feltet behandles ikke som pasientdata.

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

Erstatter listen med opptil 5 adresser som hver får én e-post når alle labresultater er
endelige. Send `[]` for å slå av e-postene. Kan redigeres i alle statuser unntatt `cancelled`.
Nøkkelen din trenger `results_view`-tilgang til pasienten, ellers returneres `403`. Se
[E-poster om klare resultater](https://docs.anivahealth.com/no/concepts/results.md#e-poster-nar-resultater-er-klare).

## Respons

Ved suksess returnerer API-et `200 OK` med den oppdaterte bestillingen av hjemmetestsett og tilhørende innebygd profil.

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

Gjeldende status for bestillingen av hjemmetestsett. En av `pending`, `dispatched`, `activated` eller `cancelled`.

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

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

Prøvetakingstidspunkt rapportert via [Aktiver](https://docs.anivahealth.com/no/api/home-kit-orders/activate-home-kit.md) – når
pasienten tok prøven sin. `null` til settet er aktivert.

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

Bestillingen av hjemmetestsett som denne erstatter, når det er et erstatningssett. `null` ved en vanlig bestilling. Se
[Opprett bestilling av hjemmetestsett](https://docs.anivahealth.com/no/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Hvorfor erstatningen ble sendt. `null` ved 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).

**metadata** `object` *required*

Partnerdefinerte nøkkel/verdi-par, returnert uendret. Alltid med – `{}` når ikke angitt.

**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 som er knyttet til denne bestillingen av hjemmetestsett — alltid nøyaktig ett (et
hjemmetestsett tilsvarer 1:1 et fysisk settprodukt), og erstattes direkte når du sender
`panel_id`. Slå opp paneldetaljer (navn, biomarkører) via [Vis 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*

Enkeltstående biomarkører som er knyttet til denne bestillingen av hjemmetestsett utenom et panel. Kryssjekk hver
`biomarker_id` mot [List opp biomarkører](https://docs.anivahealth.com/no/api/biomarkers/list-biomarkers.md) med `home_kit=true` for visningsdata.

**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 knyttet til denne bestillingen av hjemmetestsett, med den eldste først – vanligvis settet til pasienten
og prøven tilbake til laboratoriet. Tom inntil lageret skriver ut en fraktetikett. Les de
fullstendige pakkedetaljene 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. ugyldig UUID-format eller et manglende felt i `delivery_address`. |
| `403` | Forbudt — API-nøkkelen din har ikke tilgang til denne operasjonen, bestillingen av hjemmetestsett er utenfor rettighetsomfanget ditt, eller du satte `results_ready_emails` uten `results_view`-tilgang til pasienten. |
| `404` | Fant ikke bestillingen av hjemmetestsett, eller panelet i `panel_id` finnes ikke. |
| `409` | Konflikt — bestillingen er ikke lenger `pending`; adresse og panel kan bare endres før utsendelse. |
| `409` | Konflikt — bestillingen er et erstatningssett, som beholder panelet fra bestillingen det erstatter. |
| `409` | Konflikt — bestillingen er `cancelled` og du sendte `results_ready_emails`. |
| `422` | Panelet kan ikke bestilles som hjemmetestsett — det er ikke konfigurert noe settprodukt for utsendelse. |
| `500` | Intern serverfeil. |

```bash cURL theme={null}
curl --request PATCH \
  --url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "delivery_address": {
      "name": "Maria Schmidt",
      "street": "Unter den Linden",
      "house_number": "77",
      "postal_code": "10117",
      "city": "Berlin",
      "country_code": "DE",
      "phone": "+4930123456789",
      "email": "maria.schmidt@example.com"
    }
  }'
```

```json 200 theme={null}
{
  "id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
  "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "status": "pending",
  "delivery_address": {
    "name": "Maria Schmidt",
    "street": "Unter den Linden",
    "house_number": "77",
    "postal_code": "10117",
    "city": "Berlin",
    "country_code": "DE",
    "phone": "+4930123456789",
    "email": "maria.schmidt@example.com"
  },
  "created_at": "2026-04-01T09:45:00Z",
  "updated_at": "2026-04-01T13:10: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": [],
  "metadata": { "your_order_ref": "ORD-10482" },
  "replaces_home_kit_order_id": null,
  "replacement_reason": null,
  "results_ready_emails": [],
  "lab_code": null,
  "activated_at": null,
  "shipments": []
}
```

```json 400 theme={null}
{
  "error": "delivery_address: Invalid input"
}
```

```json 409 theme={null}
{
  "error": "Panels and biomarkers can only be changed while the home kit order is pending. Once it is dispatched, activated, or cancelled its composition is locked."
}
```

```json 404 theme={null}
{
  "error": "Home kit order not found"
}
```


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