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

# Otthoni tesztkészlet-rendelés létrehozása

> Igényelj egy postán küldött, otthon elvégezhető tesztkészletet egy profilhoz

Kérj otthoni tesztkészlet-rendelést egy páciensprofilhoz. Az otthoni tesztkészlet-rendelés keretében egy otthon elvégezhető, postai tesztkészletet küldünk – az Aniva kiszállítja a készletet a szállítási címre, a páciens otthon maga veszi le a mintát, és postán visszaküldi. Ez eltér az [időponttól](https://docs.anivahealth.com/hu/api/appointments/create-appointment.md), amely egy vizsgálati helyszínen történő vénás vérvétel.

**Pontosan egy panel megadása kötelező.** Egy otthoni tesztkészlet 1:1 arányban felel meg egy fizikai készletterméknek – a panel maga a készlet –, és a rendelés a létrehozásakor azonnal bekerül a csomagolási sorba, ezért az összetételnek már eleve véglegesnek kell lennie. A panelt még lecserélheted az [Otthoni tesztkészlet-rendelés frissítése](https://docs.anivahealth.com/hu/api/home-kit-orders/update-home-kit.md) segítségével, amíg a rendelés `pending` állapotban van.

## Cserekészletek

Ha egy készlet nem tud eredményeket adni – a páciens nem tudta megtölteni a csövet, a minta túl kevés anyaggal érkezett, a laboratórium nem tudta elemezni –, rendelj **cserekészletet** a `replaces_home_kit_order_id` elküldésével.

A csere egy új rendelés új laborkóddal, akkor is, ha az első készletet soha nem aktiválták: a laboratóriumnak új vizsgálatkérésre van szüksége, és egy kód alatt két minta nem különböztethető meg. A lecserélt rendelés érintetlen marad – megtartja a saját állapotát, a saját laborkódját és a hozzá már rögzített eredményeket.

Ebből két dolog következik:

* **A panel öröklődik.** Hagyd el a `panel_id` mezőt, és a csere a lecserélt rendelés paneljét viszi tovább, amelyet a páciens megvásárolt, és amely a doboz arculatát is meghatározza.
* **Te választod ki, mit futtassanak újra.** Küldd el a `biomarker_ids` mezőt a sikertelen markerekkel, és a laboratórium csak azokat futtatja újra, így a készlet csak a hozzájuk szükséges csövekkel érkezik. Hagyd el a teljes panel újrafuttatásához.

A markerek a panel csoportjai szerint futnak újra, nem egyenként. Egy csoport egyetlen markerének megadásával a teljes csoport újrafut, mert nem adható le olyan laboratóriumi rendelés, amely többet közöl a kértnél. Egy egymarkeres csere ezért egynél több eredménnyel is megérkezhet, a csövek száma pedig nagyobb lehet annál, mint amit a markerlista sugall.

Egyszerre készletenként csak egy csere lehet úton.

> [!NOTE]
>
> Ha ezeknek a mezőknek a megjelenése előtt integráltál, az Aniva létrehozáskor a `metadata.original_kit_id` és
> a `metadata.replacement_reason` mezőket is beolvassa, és csereként kezeli a rendelést. Ez az egyetlen
> hely, ahol a metaadatokat értelmezzük, kizárólag a korábbi integráció működésének fenntartására szolgál, és a fenti
> mezők mindig elsőbbséget élveznek. Küldd a mezőket.

A `201` azt jelenti, hogy a rendelést rögzítettük és átadjuk teljesítésre – nincs más teendőd ahhoz, hogy a készletet becsomagolják és kiszállítsák.

Szükséges hozzá a `home_kit_orders_manage` scope.

Küldj opcionális `Idempotency-Key` fejlécet, hogy a létrehozás biztonságosan újrapróbálható legyen — ugyanazzal a kulccsal megismételve az eredeti válasz érkezik vissza egy újabb létrehozása helyett. Lásd: [Idempotencia](https://docs.anivahealth.com/hu/concepts/idempotency.md).

## Kérés

### Törzsparaméterek

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

Annak a páciensprofilnak az UUID-je, amelyhez az otthoni tesztkészlet-rendelést létrehozod.

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

A megrendelni kívánt katalóguspanel UUID-je. Pontosan egy – egy otthoni tesztkészlet 1:1 arányban felel meg egy fizikai készletterméknek,
tehát a panel maga a készlet. A panelazonosítókat az Aniva biztosítja a partnerfiókodhoz; lásd: [Panelek
listázása](https://docs.anivahealth.com/hu/api/panels/list-panels.md). Csere esetén opcionális, ilyenkor alapértelmezés szerint a lecserélt rendelés
panelje lesz érvényes.

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

Annak az otthoni tesztkészlet-rendelésnek az UUID-je, amelyet ez a rendelés lecserél. Megadásával ez cserekészletnek minősül – lásd
fentebb a [Cserekészletek](#cserekeszletek) részt. A rendelésnek ugyanahhoz a profilhoz kell tartoznia, és nem lehet
már úton egy másik cseréje.

**replacement\_reason** `string`

Miért van szükség a cserére, egy mondatban (például `Zu wenig Material, HbA1c nicht
    auswertbar`). Kötelező, ha elküldöd a `replaces_home_kit_order_id` mezőt, egyébként figyelmen kívül hagyjuk. Legfeljebb
500 karakter.

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

Csere esetén azok a markerek, amelyeket a laboratórium újrafuttat – jellemzően azok, amelyeket az első készlet nem tudott
szolgáltatni. Mindegyiknek szerepelnie kell a lecserélt rendelésben kértek között; vesd össze a [Biomarkerek
listázása](https://docs.anivahealth.com/hu/api/biomarkers/list-biomarkers.md) adataival `home_kit=true` paraméterrel. Hagyd el a teljes panel újrafuttatásához. Csak
a `replaces_home_kit_order_id` mezővel együtt fogadjuk el, eltérő `panel_id` mellett viszont nem.
Ehhez nincs szükség külön scope-ra: a páciens által már kifizetett markerek újrafuttatása nem egyedi
válogatás.

**metadata** `object`

Saját kulcs-érték párok, amelyeket minden lekérdezéskor változtatás nélkül visszaadunk, és az Aniva soha nem értelmezi őket. Használd
a saját rendeléshivatkozásod átadására, így a mi azonosítóink tárolása nélkül is összerendelheted az adatokat. Legfeljebb 20 kulcs;
a kulcsok a `[A-Za-z0-9_-]` mintának felelnek meg és legfeljebb 40 karakteresek; az értékek szövegek, számok vagy logikai értékek,
a szövegek legfeljebb 500 karakteresek; szerializálva összesen 16 384 bájt. Az `aniva_` előtaggal kezdődő kulcsok
fenntartottak. Soha ne tegyél személyes vagy klinikai adatot a `metadata` mezőbe – nem páciensadatként kezeljük.

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

Legfeljebb 5 cím, amelyek mindegyike egy e-mailt kap, amint minden laboreredmény végleges. Az
e-mail az Aniva adminfelületének eredményoldalára mutat. A kulcsodnak `results_view` hozzáférésre
van szüksége a pácienshez, különben `403`-at kapsz. Hagyd el, ha a páciens csoportjához beállított
alapértelmezett címeket szeretnéd használni. Üres listával kikapcsolhatod az e-maileket. Lásd:
[Elkészült eredményekről szóló e-mailek](https://docs.anivahealth.com/hu/concepts/results.md#e-mailek-az-elkeszuelt-eredmenyekrol).

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

A cím, ahová a készletet postázzuk – kétféle formában adható meg: vagy `{ location_id }` egy ismert vizsgálati helyszínre hivatkozva, vagy a közvetlenül megadott címmezők (`name`, `street`, `city`, `postal_code`, `country_code`; opcionálisan `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` – ugyanaz a mezőkészlet, mint a helyszínek API-ban). Pontosan az egyiket add meg – helyszínhivatkozást vagy közvetlen címet, mindkettőt ne.

**szállítási cím**

> [tab] Hivatkozás helyszínre
>
> **location\_id** `string` *required*
>
> Annak az ismert vizsgálati helyszínnek az UUID-je, ahová a készletet szállítjuk. Egyeztesd a [Helyszínek
> listázása](https://docs.anivahealth.com/hu/api/locations/list-locations.md) listájával.

> [tab] Közvetlen cím
>
> **name** `string` *required*
>
> Címzett, cég vagy helyszín neve.
>
> **company\_name** `string`
>
> A csomagot a címzett részére átvevő cég – egy `c/o` fél vagy részleg.
>
> **street** `string` *required*
>
> Utcanév, házszám nélkül (pl. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Házszám (pl. `118` vagy `12a`).
>
> **address\_line\_2** `string`
>
> Épület, lépcsőház vagy emelet.
>
> **city** `string` *required*
>
> **state** `string`
>
> Állam vagy tartomány. Opcionális.
>
> **postal\_code** `string` *required*
>
> Irányítószám. Német cím esetén (`country_code` `DE`) pontosan 5 számjegy szükséges, pl. `10117`.
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2 kód (két betű, pl. `DE`). Kisbetűs formában is elfogadjuk, és nagybetűsként
> tároljuk.
>
> **phone** `string`
>
> A címzett telefonszáma országkóddal (pl. `+4791234567`). A futárszolgálat ezen keresztül
> értesíti a címzettet a csomagról, például arról, hogy átvehető egy csomagponton. Ha
> kihagyod, a futárszolgálat nem kap telefonszámot.
>
> **email** `string`
>
> A címzett e-mail-címe. A futárszolgálat ugyanúgy használja, mint a `phone` mezőt. Ha kihagyod, a futárszolgálat nem kap
> e-mail-címet.

> [!NOTE]
>
> **Packstation vagy Postfiliale (csak Németországban):** állítsd a `street` értékét `Packstation` vagy `Postfiliale` értékre,
> a `house_number` legyen a háromjegyű állomásszám, az `address_line_2` pedig a címzett DHL
> Postnummer azonosítója (6–10 számjegy, szóközök megengedettek). A Postnummer nélkül a csomag nem foglalható le.
> A Postfach nem támogatott.

## Válasz

Sikeres kérés esetén az API `201 Created` választ ad vissza az új otthoni tesztkészlet-rendeléssel.

**id** `string` *required*

Az otthoni tesztkészlet-rendelés egyedi azonosítója (UUID).

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

Annak a profilnak az UUID-ja, amelyhez ez az otthoni tesztkészlet-rendelés tartozik.

**status** `string` *required*

Az otthoni tesztkészlet-rendelés aktuális állapota. A következő értékek egyike: `pending`, `dispatched`, `activated` vagy `cancelled`. Egy
újonnan létrehozott rendelés `pending` állapotban indul.

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

A cím, ahová a tesztkészletet postázzuk — két formátum egyike: vagy egy `{ location_id }`, amely egy ismert tesztelési helyszínre hivatkozik, vagy a beágyazott címmezők (`name`, `street`, `city`, `postal_code`, `country_code`; a `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` opcionális — ugyanaz a mezőkészlet, mint a helyszínek API-ban). Pontosan az egyiket add meg — vagy helyszínhivatkozást, vagy beágyazott címet, de ne mindkettőt.

**szállítási cím**

> [tab] Helyszínhivatkozás
>
> **location\_id** `string` *required*
>
> Annak a tesztelési helyszínnek az UUID-ja, ahová a készletet szállítjuk.

> [tab] Beágyazott cím
>
> **name** `string` *required*
>
> A címzett, a cég vagy a helyszín neve.
>
> **company\_name** `string`
>
> A csomagot a címzett helyett átvevő cég — `c/o` fél vagy részleg.
>
> **street** `string` *required*
>
> Utcanév házszám nélkül (pl. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Házszám (pl. `118` vagy `12a`).
>
> **address\_line\_2** `string`
>
> Épület, lépcsőház vagy emelet.
>
> **city** `string` *required*
>
> **state** `string`
>
> Állam vagy tartomány. Opcionális.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2 kód (két betű, pl. `DE`).
>
> **phone** `string`
>
> **email** `string`

**metadata** `object` *required*

Az általad megadott kulcs-érték párok. Mindig szerepel – `{}` értékű, ha nem állítottál be egyet sem.

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

Az az otthoni tesztkészlet-rendelés, amelyet ez lecserél. Normál rendelés esetén `null`.

**replacement\_reason** `string`

Az általad megadott indoklás. Normál rendelés esetén `null`.

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

Címek, amelyek mindegyike egy-egy e-mailt kap, amint minden laboreredmény végleges, kisbetűvel. Kikapcsolva üres. Lásd:
[Eredmények elkészültéről szóló e-mailek](https://docs.anivahealth.com/hu/concepts/results.md#e-mailek-az-elkeszuelt-eredmenyekrol).

**lab\_code** `string`

A laboratóriumi mintakód, amely alatt az eredmények beérkeznek — a fizikai készletre van nyomtatva, és ezt
olvassa le a páciens a dobozról aktiválási kódként. `null`, amíg a készletet nem csomagolták be.
Csak olvasható.

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

Az [Aktiválás](https://docs.anivahealth.com/hu/api/home-kit-orders/activate-home-kit.md) során jelentett mintavételi időbélyeg. `null`, amíg
a készletet nem aktiválják.

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

Az otthoni tesztkészlet-rendelés létrehozásának ISO 8601 időbélyege.

**updated\_at** `string`

Az utolsó frissítés ISO 8601 időbélyege. Lehet `null`.

**profile** `object` *required*

Az ehhez az otthoni tesztkészlet-rendeléshez tartozó páciensprofil.

**profil**

**id** `string`

A profil egyedi azonosítója (UUID).

**handle** `string`

Profilazonosító vagy felhasználónév. Lehet `null`.

**first\_name** `string`

Keresztnév. Lehet `null`.

**last\_name** `string`

Vezetéknév. Lehet `null`.

**email** `string`

E-mail-cím. Lehet `null`.

**phone** `string`

Telefonszám E.164 formátumban. Lehet `null`.

**sex** `integer`

Biológiai nem az ISO/IEC 5218 szerint. Lehet `null`.

**date\_of\_birth** `string`

Születési dátum `YYYY-MM-DD` formátumban. Lehet `null`.

**height** `number`

Magasság centiméterben. Lehet `null`.

**weight** `number`

Testsúly kilogrammban. Lehet `null`.

**language** `string`

Preferált nyelv: a [Profil létrehozása](https://docs.anivahealth.com/hu/api/profiles/create-profile.md) pontban szereplő 32 kód egyike.

**transactional\_emails\_enabled** `boolean`

Kap-e ez a profil tranzakciós (programozott) e-maileket. Lehet `null`.

**created\_at** `string`

A profil létrehozásának ISO 8601 időbélyege.

**updated\_at** `string`

A profil utolsó frissítésének ISO 8601 időbélyege. Lehet `null`.

**panels** `HomeKitOrderPanel[]` *required*

Ehhez az otthoni tesztkészlet-rendeléshez csatolt panel – az, amelyet `panel_id` értékként adtál meg, a
rendelés létrehozási idejével megjelölve. Mindig pontosan egy. A panel részleteit (név, biomarkerek) a
[Panelek listázása](https://docs.anivahealth.com/hu/api/panels/list-panels.md) segítségével keresheted meg.

**Panel-hozzárendelés mezői**

**panel\_id** `string`

A panel UUID-ja — összevethető a [Panelek listázása](https://docs.anivahealth.com/hu/api/panels/list-panels.md) végponttal.

**added\_at** `string`

ISO 8601 időbélyeg arról, amikor a panelt először hozzárendelték ehhez az otthoni tesztkészlet-rendeléshez.

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

A panelen kívül csatolt biomarkerek. Normál létrehozáskor üres – az otthoni tesztkészlet-rendeléseket
panel alapján adjuk le, és ennek a listának az utólagos módosításához a
`home_kit_orders_individual_biomarker_selection` capability scope szükséges. Csere esetén az általad küldött
`biomarker_ids` értékeket tartalmazza, amelyeket a laboratórium újrafuttat.

**Egyedi biomarker mezői**

**biomarker\_id** `integer`

Biomarker-azonosító — összevethető a
[Biomarkerek listázása](https://docs.anivahealth.com/hu/api/biomarkers/list-biomarkers.md) végponttal `home_kit=true` paraméterrel.

**added\_at** `string`

ISO 8601 időbélyeg arról, amikor a biomarkert először hozzárendelték ehhez az otthoni tesztkészlet-rendeléshez.

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

Ehhez az otthoni tesztkészlet-rendeléshez kapcsolt csomagok, a legrégebben kapcsolttól kezdve. Létrehozáskor mindig üres – a
teljes csomagadatokat a [Szállítmányok listázása](https://docs.anivahealth.com/hu/api/shipments/list-shipments.md) segítségével és a `?home_kit_order_id=` paraméterrel kérheted le.

**Szállítmánykapcsolat mezői**

**id** `string`

Szállítmány-hivatkozás — összevethető a [Szállítmány lekérése](https://docs.anivahealth.com/hu/api/shipments/get-shipment.md) végponttal.

**added\_at** `string`

ISO 8601 időbélyeg arról, amikor a szállítmányt ehhez az otthoni tesztkészlet-rendeléshez kapcsolták.

## Hibaválaszok

| Állapotkód | Leírás |
| - | - |
| `400` | Érvényesítési hiba – pl. a `delivery_address` mezőből hiányzik egy adat vagy a német irányítószám nem 5 számjegyű, a `panel_id` nem érvényes UUID, vagy csere esetén hiányzik a `replacement_reason`. |
| `403` | Tiltott – az API-kulcsod nem rendelkezik hozzáféréssel ehhez a művelethez, a profil kívül esik a jogosultsági körödön, vagy úgy állítottad be a `results_ready_emails` mezőt, hogy nincs `results_view` hozzáférésed a pácienshez. |
| `404` | A profil, a panel vagy a lecserélendő otthoni tesztkészlet-rendelés nem található. |
| `409` | Ütközés – az `Idempotency-Key` már szerepelt egy másik törzzsel, az eredeti kérése még nem fejeződött be, vagy a lecserélni kívánt készlethez már úton van egy csere. |
| `422` | A panel nem rendelhető otthoni tesztkészletként – nincs hozzá beállítva teljesítési készlettermék. Csere esetén: a lecserélt rendelés egy másik profilhoz tartozik, egy `biomarker_ids` elem nem szerepelt az eredeti rendelésben, vagy eltérő `panel_id` mellett küldtél markereket. |
| `500` | Belső szerverhiba. |

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