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

# List opp bestillinger av hjemmetestsett

> Hent postsendte hjemmetestsett som API-nøkkelen din har tilgang til

Hent en liste over bestillinger av hjemmetestsett. En bestilling av hjemmetestsett sender ut et hjemmetestsett i posten – Aniva sender settet, pasienten tar prøven selv hjemme og sender den tilbake i posten. Hver bestilling av hjemmetestsett inkluderer den innebygde pasientprofilen.

Når `profile_id` oppgis, returneres alle bestillinger av hjemmetestsett for denne profilen. Når det utelates, returneres alle tilgjengelige bestillinger av hjemmetestsett.

Krever scopet `home_kit_orders_view` eller `home_kit_orders_manage`.

## Forespørsel

### Spørreparametere

**profile\_id** `string`

Filtrer etter profilens UUID. Når den oppgis, returneres alle bestillinger av hjemmetestsett for denne profilen.

**lab\_code** `string`

Filtrer etter labkode (nøyaktig treff) – finn bestillingen som hører til et fysisk testsett du har i hånden ved hjelp av koden
som står trykt på det, f.eks. før du kaller [Aktiver](https://docs.anivahealth.com/no/api/home-kit-orders/activate-home-kit.md).

## Respons

Ved suksess returnerer API-et `200 OK` med et array med objekter for bestillinger 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*

Gjeldende status for bestillingen av hjemmetestsett. En av `pending`, `dispatched`, `activated` eller `cancelled`.
Detaljert ferdigstillelsesstatus for laboratorieresultater hentes fra [Hent resultater](https://docs.anivahealth.com/no/api/home-kit-orders/get-results.md).

**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 testsettprodukt), og det kan byttes via [Oppdater](https://docs.anivahealth.com/no/api/home-kit-orders/update-home-kit.md) mens status er
`pending`. 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*

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.

## Gjentatte kall

Aniva lagrer svaret fra dette endepunktet i 5 minutter for hver API-nøkkel. Et gjentatt kall innenfor
denne tiden får det lagrede svaret. Headerne `Cache-Status` og `Age` viser at svaret er
lagret og hvor gammelt det er.

For å få beskjed om en endring med én gang kan du abonnere på webhook-hendelsene `home_kit_order.created` og hendelsen for hver status, for eksempel `home_kit_order.activated`.
Se [Gjentatte lesinger](https://docs.anivahealth.com/no/concepts/webhooks.md#gjentatte-lesinger).

## Feilresponser

| Status | Beskrivelse |
| - | - |
| `400` | Valideringsfeil – for eksempel er `profile_id` ikke en gyldig UUID, eller spørringen inneholder en ukjent parameter. |
| `403` | Ingen tilgang – API-nøkkelen din har ikke tilgang til denne operasjonen, eller den forespurte profilen ligger utenfor tilgangsområdet ditt. |
| `500` | Intern serverfeil. |

```bash cURL (all home kit orders) theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/home-kit-orders \
  --header 'x-api-key: YOUR_API_KEY'
```

```bash cURL (by profile) theme={null}
curl --request GET \
  --url 'https://anivahealth.com/api/v1/home-kit-orders?profile_id=a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d' \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
[
  {
    "id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
    "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "status": "dispatched",
    "delivery_address": {
      "name": "Maria Schmidt",
      "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": "2026-04-02T08: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": [
      {
        "biomarker_id": 42,
        "added_at": "2026-04-01T09:52:00Z"
      }
    ],
    "metadata": {},
    "replaces_home_kit_order_id": null,
    "replacement_reason": null,
    "results_ready_emails": [],
    "lab_code": "7642000123",
    "activated_at": null,
    "shipments": [
      { "id": "K2604021FQ7", "added_at": "2026-04-02T08:00:00Z" },
      { "id": "K260402P3XD", "added_at": "2026-04-02T08:00:00Z" }
    ]
  }
]
```

```json 403 theme={null}
{
  "error": "Access denied: profile is outside your permission scope"
}
```


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