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

# Izveidot mājas testa komplekta pasūtījumu

> Pieprasīt profilam paštesta komplektu ar piegādi uz mājām

Pieprasi mājas testa komplekta pasūtījumu pacienta profilam. Mājas testa komplekta pasūtījums nosūta pa pastu piegādājamu pašveicamu testa komplektu — Aniva nosūta komplektu uz piegādes adresi, pacients mājās pats paņem paraugu un nosūta to atpakaļ pa pastu. Tas atšķiras no [pieraksta](https://docs.anivahealth.com/lv/api/appointments/create-appointment.md), kas ir venoza asins paņemšana testēšanas vietā.

**Nepieciešams tieši viens panelis.** Mājas testa komplekts atbilst fiziskam komplekta produktam attiecībā 1:1 — panelis ir komplekts —, un pasūtījums nonāk pakošanas rindā uzreiz pēc izveides, tāpēc sastāvam jābūt galīgam jau sākotnēji. Tu joprojām vari nomainīt paneli, izmantojot [Atjaunināt mājas testa komplekta pasūtījumu](https://docs.anivahealth.com/lv/api/home-kit-orders/update-home-kit.md), kamēr pasūtījums ir statusā `pending`.

## Aizvietošanas komplekti

Ja ar komplektu nevar iegūt rezultātus — pacients nevarēja piepildīt stobriņu, paraugs pienāca ar pārāk maz materiāla, laboratorija nevarēja to analizēt —, pasūti **aizvietojumu**, nosūtot `replaces_home_kit_order_id`.

Aizvietojums ir jauns pasūtījums ar jaunu laboratorijas kodu, arī tad, ja pirmais komplekts nekad netika aktivizēts: laboratorijai nepieciešams jauns nosūtījums, un divus paraugus ar vienu kodu nevar atšķirt. Pasūtījums, ko aizvieto, netiek skarts — tas saglabā savu statusu, savu laboratorijas kodu un visus tam jau pievienotos rezultātus.

No tā izriet divas lietas:

* **Panelis tiek mantots.** Nenorādi `panel_id`, un aizvietojums pārņems aizvietojamā pasūtījuma paneli, ko pacients iegādājās un kam atbilst kastes noformējums.
* **Tu izvēlies, ko analizēt atkārtoti.** Nosūti `biomarker_ids` ar marķieriem, kas neizdevās, un laboratorija atkārtoti analizēs tikai tos, tāpēc komplektā tiks nosūtīti tikai tiem nepieciešamie stobriņi. Nenorādi to, lai atkārtoti analizētu visu paneli.

Marķieri tiek atkārtoti analizēti pa paneļa grupām, nevis pa vienam. Norādot vienu grupas marķieri, tiek atkārtoti analizēta visa grupa, jo nevar veikt laboratorijas pasūtījumu, kas ziņo vairāk, nekā pieprasīts. Tāpēc viena marķiera aizvietojums var pienākt ar vairāk nekā vienu rezultātu, un tā stobriņu skaits var būt lielāks, nekā liek domāt marķieru saraksts.

Vienlaikus ceļā var būt tikai viens aizvietojums vienam komplektam.

> [!NOTE]
>
> Ja integrēji pirms šo lauku ieviešanas, Aniva izveides brīdī nolasa arī `metadata.original_kit_id` un
> `metadata.replacement_reason` un apstrādā pasūtījumu kā aizvietojumu. Šī ir vienīgā
> vieta, kur metadati tiek interpretēti, tā pastāv tikai šīs agrākās integrācijas uzturēšanai, un iepriekš minētie lauki
> vienmēr ir prioritāri. Sūti laukus.

`201` nozīmē, ka pasūtījums ir apstiprināts un tiks nodots izpildei — tev nekas cits nav jādara, lai komplekts tiktu sapakots un nosūtīts.

Nepieciešams `home_kit_orders_manage` tvērums.

Nosūti neobligātu `Idempotency-Key` galveni, lai šo izveides pieprasījumu varētu droši atkārtot — atkārtojot to pašu atslēgu, tiek atgriezta sākotnējā atbilde, nevis izveidots otrs pieraksts. Skati [Idempotence](https://docs.anivahealth.com/lv/concepts/idempotency.md).

## Pieprasījums

### Pieprasījuma satura parametri

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

Pacienta profila UUID, kuram izveidot mājas testa komplekta pasūtījumu.

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

Pasūtāmā kataloga paneļa UUID. Tieši viens — mājas testa komplekts atbilst fiziskam komplekta produktam attiecībā 1:1,
tāpēc panelis ir komplekts. Paneļu ID tavam partnera kontam piešķir Aniva; skati [Paneļu
sarakstu](https://docs.anivahealth.com/lv/api/panels/list-panels.md). Nav obligāts aizvietojumam, kur pēc noklusējuma tiek izmantots
aizvietojamā pasūtījuma panelis.

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

Tā mājas testa komplekta pasūtījuma UUID, kuru šis aizvieto. Tā nosūtīšana padara šo par aizvietošanas komplektu — skati
[Aizvietošanas komplekti](#aizvietosanas-komplekti) iepriekš. Pasūtījumam jāpieder tam pašam profilam, un tam
nedrīkst jau būt ceļā aizvietojums.

**replacement\_reason** `string`

Kāpēc nepieciešams aizvietojums, vienā teikumā (piemēram, `Zu wenig Material, HbA1c nicht
    auswertbar`). Obligāts, ja nosūti `replaces_home_kit_order_id`, citādi tiek ignorēts. Ne vairāk kā
500 rakstzīmju.

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

Aizvietojumam — marķieri, kurus laboratorija analizēs atkārtoti, parasti tie, kurus ar pirmo komplektu nevarēja
iegūt. Katram jābūt daļai no tā, kas tika pieprasīts aizvietojamajā pasūtījumā; salīdzini ar [Biomarķieru
sarakstu](https://docs.anivahealth.com/lv/api/biomarkers/list-biomarkers.md) ar `home_kit=true`. Nenorādi to, lai atkārtoti analizētu visu paneli. Tiek
pieņemts tikai kopā ar `replaces_home_kit_order_id` un ne kopā ar citu `panel_id`.
Tam nav nepieciešams papildu tvērums: tādu marķieru atkārtota analīze, par kuriem pacients jau samaksāja, nav individuāla
izvēle.

**metadata** `object`

Tavi atslēgu/vērtību pāri, kas katrā nolasīšanā tiek atgriezti bez izmaiņām un ko Aniva nekad neinterpretē. Izmanto
tos, lai pievienotu savu pasūtījuma atsauci un varētu tos sasaistīt, neglabājot mūsu ID. Ne vairāk kā 20 atslēgu;
atslēgas atbilst `[A-Za-z0-9_-]` un ir ne garākas par 40 rakstzīmēm; vērtības ir virkne, skaitlis vai būla vērtība,
turklāt virknes ir ne garākas par 500 rakstzīmēm; kopā serializētā veidā 16 384 baiti. Atslēgas, kas sākas ar `aniva_`, ir
rezervētas. Nekad neievieto personas vai klīniskos datus laukā `metadata` — tie netiek apstrādāti kā pacienta dati.

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

Līdz 5 adresēm, no kurām katra saņem vienu e-pastu, kad visi laboratorijas rezultāti ir galīgi.
E-pastā ir saite uz rezultātu lapu Aniva administrēšanas panelī. Tavai atslēgai nepieciešama
`results_view` piekļuve pacientam, pretējā gadījumā tiks atgriezts `403`. Izlaid šo lauku, lai
izmantotu pacienta grupai iestatītās noklusējuma adreses. Tukšs saraksts izslēdz šos e-pastus.
Skati [E-pasti par gataviem rezultātiem](https://docs.anivahealth.com/lv/concepts/results.md#e-pasti-par-gataviem-rezultatiem).

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

Adrese, uz kuru nosūtīt komplektu — viena no divām formām: vai nu `{ location_id }`, kas norāda uz zināmu testēšanas vietu, vai tiešie adreses lauki (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` nav obligāti — tā pati terminoloģija kā vietu API). Norādi tieši vienu — atsauci uz vietu vai tiešo adresi, nevis abas.

**piegādes adrese**

> [tab] Atsauce uz vietu
>
> **location\_id** `string` *required*
>
> Zināmas testēšanas vietas UUID, uz kuru nosūtīt komplektu. Sasaisti ar [Vietu
> sarakstu](https://docs.anivahealth.com/lv/api/locations/list-locations.md).

> [tab] Tiešā adrese
>
> **name** `string` *required*
>
> Saņēmēja, uzņēmuma vai vietas nosaukums.
>
> **company\_name** `string`
>
> Uzņēmums, kas glabā sūtījumu saņēmējam — `c/o` puse vai nodaļa.
>
> **street** `string` *required*
>
> Ielas nosaukums bez mājas numura (piem., `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Mājas numurs (piem., `118` vai `12a`).
>
> **address\_line\_2** `string`
>
> Ēka, ieeja vai stāvs.
>
> **city** `string` *required*
>
> **state** `string`
>
> Štats vai province. Nav obligāts.
>
> **postal\_code** `string` *required*
>
> Pasta indekss. Vācijas adresei (`country_code` `DE`) nepieciešami tieši 5 cipari, piem., `10117`.
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2 kods (divi burti, piem., `DE`). Tiek pieņemti mazie burti, un tie tiek saglabāti ar lielajiem
> burtiem.
>
> **phone** `string`
>
> Saņēmēja tālruņa numurs ar valsts kodu (piem., `+4791234567`). Pārvadātājs to izmanto, lai
> informētu saņēmēju par sūtījumu, piemēram, ka tas gaida saņemšanas punktā. Nenorādi
> to, un pārvadātājs nesaņems tālruņa numuru.
>
> **email** `string`
>
> Saņēmēja e-pasts. Pārvadātājs to izmanto tāpat kā `phone`. Nenorādi to, un pārvadātājs nesaņems
> e-pastu.

> [!NOTE]
>
> **Packstation vai Postfiliale (tikai Vācijā):** iestati `street` uz `Packstation` vai `Postfiliale`,
> `house_number` uz trīsciparu stacijas numuru un `address_line_2` uz saņēmēja DHL
> Postnummer (6–10 cipari, atstarpes atļautas). Bez Postnummer sūtījumu nevar noformēt.
> Postfach netiek atbalstīts.

## Atbilde

Veiksmīgas izpildes gadījumā API atgriež `201 Created` ar jauno mājas testa komplekta pasūtījumu.

**id** `string` *required*

Unikālais mājas testa komplekta pasūtījuma identifikators (UUID).

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

Tā profila UUID, kuram pieder šis mājas testa komplekta pasūtījums.

**status** `string` *required*

Pašreizējais mājas testa komplekta pasūtījuma statuss. Viens no `pending`, `dispatched`, `activated` vai `cancelled`.
Tikko izveidots pasūtījums sākas statusā `pending`.

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

Adrese, uz kuru nosūtīt komplektu — vienā no divām formām: vai nu `{ location_id }`, kas atsaucas uz zināmu testēšanas vietu, vai tiešās adreses lauki (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` nav obligāti — tie paši lauki kā atrašanās vietu API). Norādi tieši vienu — atsauci uz vietu vai tiešo adresi, ne abas.

**piegādes adrese**

> [tab] Atsauce uz vietu
>
> **location\_id** `string` *required*
>
> Tās testēšanas vietas UUID, uz kuru tiek nosūtīts komplekts.

> [tab] Tiešā adrese
>
> **name** `string` *required*
>
> Saņēmēja, uzņēmuma vai vietas nosaukums.
>
> **company\_name** `string`
>
> Uzņēmums, kas pieņem sūtījumu saņēmēja vietā — `c/o` puse vai nodaļa.
>
> **street** `string` *required*
>
> Ielas nosaukums bez mājas numura (piem., `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Mājas numurs (piem., `118` vai `12a`).
>
> **address\_line\_2** `string`
>
> Ēka, ieeja vai stāvs.
>
> **city** `string` *required*
>
> **state** `string`
>
> Štats vai province. Nav obligāts.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2 kods (divi burti, piem., `DE`).
>
> **phone** `string`
>
> **email** `string`

**metadata** `object` *required*

Tavi norādītie atslēgu/vērtību pāri. Vienmēr iekļauts — `{}`, ja neesi nevienu norādījis.

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

Mājas testa komplekta pasūtījums, kuru šis aizvieto. Parastam pasūtījumam `null`.

**replacement\_reason** `string`

Tavs norādītais iemesls. Parastam pasūtījumam `null`.

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

Adreses mazajiem burtiem, no kurām katra saņem vienu e-pastu, tiklīdz visi laboratorijas rezultāti ir galīgi. Tukšs, kad izslēgts. Skatīt
[E-pasti par gataviem rezultātiem](https://docs.anivahealth.com/lv/concepts/results.md#e-pasti-par-gataviem-rezultatiem).

**lab\_code** `string`

Laboratorijas parauga kods, zem kura tiek ziņoti rezultāti — uzdrukāts uz fiziskā komplekta, un tas ir kods, ko
pacients nolasa no kastītes kā aktivizācijas kodu. `null`, līdz komplekts ir iepakots.
Tikai lasīšanai.

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

Parauga paņemšanas laikspiedols, kas ziņots ar [Aktivizēt](https://docs.anivahealth.com/lv/api/home-kit-orders/activate-home-kit.md). `null`, līdz
komplekts tiek aktivizēts.

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

ISO 8601 laikspiedols, kad tika izveidots mājas testa komplekta pasūtījums.

**updated\_at** `string`

Pēdējā atjauninājuma ISO 8601 laikspiedols. Var būt `null`.

**profile** `object` *required*

Pacienta profils, kas saistīts ar šo mājas testa komplekta pasūtījumu.

**profils**

**id** `string`

Unikāls profila identifikators (UUID).

**handle** `string`

Profila segvārds vai lietotājvārds. Var būt `null`.

**first\_name** `string`

Vārds. Var būt `null`.

**last\_name** `string`

Uzvārds. Var būt `null`.

**email** `string`

E-pasta adrese. Var būt `null`.

**phone** `string`

Tālruņa numurs E.164 formātā. Var būt `null`.

**sex** `integer`

Bioloģiskais dzimums saskaņā ar ISO/IEC 5218. Var būt `null`.

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

Dzimšanas datums formātā `YYYY-MM-DD`. Var būt `null`.

**height** `number`

Augums centimetros. Var būt `null`.

**weight** `number`

Svars kilogramos. Var būt `null`.

**language** `string`

Vēlamā valoda: viens no 32 kodiem sadaļā [Izveidot profilu](https://docs.anivahealth.com/lv/api/profiles/create-profile.md).

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

Vai šis profils saņem darījumu (programmatiskos) e-pastus. Var būt `null`.

**created\_at** `string`

ISO 8601 laikspiedols, kad profils tika izveidots.

**updated\_at** `string`

Pēdējā profila atjauninājuma ISO 8601 laikspiedols. Var būt `null`.

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

Šim mājas testa komplekta pasūtījumam pievienotais panelis — tas, ko norādīji kā `panel_id`, ar
pasūtījuma izveides laiku. Vienmēr tieši viens. Paneļa informāciju (nosaukumu, biomarķierus) skati
[Paneļu sarakstā](https://docs.anivahealth.com/lv/api/panels/list-panels.md).

**Paneļa pievienošanas lauki**

**panel\_id** `string`

Paneļa UUID — salīdzini ar [Uzskaitīt paneļus](https://docs.anivahealth.com/lv/api/panels/list-panels.md).

**added\_at** `string`

ISO 8601 laikspiedols, kad panelis pirmo reizi tika pievienots šim mājas testa komplekta pasūtījumam.

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

Biomarķieri, kas pievienoti ārpus paneļa. Parastā izveidē tukšs — mājas testa komplektus pasūta pa
paneļiem, un šī saraksta mainīšanai vēlāk nepieciešams iespēju tvērums
`home_kit_orders_individual_biomarker_selection`. Aizvietojumā tas satur
tavus nosūtītos `biomarker_ids`, ko laboratorija analizēs atkārtoti.

**Atsevišķa biomarķiera lauki**

**biomarker\_id** `integer`

Biomarķiera identifikators — salīdzini ar
[Uzskaitīt biomarķierus](https://docs.anivahealth.com/lv/api/biomarkers/list-biomarkers.md) ar `home_kit=true`.

**added\_at** `string`

ISO 8601 laikspiedols, kad biomarķieris pirmo reizi tika pievienots šim mājas testa komplekta pasūtījumam.

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

Šim mājas testa komplekta pasūtījumam piesaistītie sūtījumi, sākot ar vecāko piesaisti. Izveides brīdī vienmēr tukšs — pilnu
sūtījumu informāciju skati [Sūtījumu sarakstā](https://docs.anivahealth.com/lv/api/shipments/list-shipments.md) ar `?home_kit_order_id=`.

**Sūtījuma saites lauki**

**id** `string`

Sūtījuma atsauce — salīdzini ar [Iegūt sūtījumu](https://docs.anivahealth.com/lv/api/shipments/get-shipment.md).

**added\_at** `string`

ISO 8601 laikspiedols, kad sūtījums tika piesaistīts šim mājas testa komplekta pasūtījumam.

## Kļūdu atbildes

| Statuss | Apraksts |
| - | - |
| `400` | Validācijas kļūda — piem., `delivery_address` trūkst lauka vai Vācijas pasta indekss nesastāv no 5 cipariem, `panel_id` nav derīgs UUID vai aizvietojumam trūkst `replacement_reason`. |
| `403` | Aizliegts — tavai API atslēgai nav piekļuves šai darbībai, profils ir ārpus tava atļauju tvēruma vai esi iestatījis `results_ready_emails` bez `results_view` piekļuves pacientam. |
| `404` | Profils, panelis vai aizvietojamais mājas testa komplekta pasūtījums nav atrasts. |
| `409` | Konflikts — `Idempotency-Key` jau tika izmantots ar citu saturu, tā sākotnējais pieprasījums vēl nav pabeigts vai aizvietojamajam komplektam jau ir ceļā aizvietojums. |
| `422` | Paneli nevar pasūtīt kā mājas testa komplektu — tam nav konfigurēts izpildes komplekta produkts. Aizvietojumam: aizvietojamais pasūtījums pieder citam profilam, kāds `biomarker_ids` ieraksts nebija tajā pieprasīts vai nosūtīji marķierus kopā ar citu `panel_id`. |
| `500` | Iekšēja servera kļūda. |

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