Kotitestipakkausten tilaukset
Aktivoi kotitestipakkauksen tilaus
Ilmoita, milloin potilas otti näytteensä
POST
/
api
/
v1
/
home-kit-orders
/
{id}
/
activate
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/activate \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"activated_at": "2026-08-28T07:30:00Z"
}'
{
"id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
"profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"status": "activated",
"lab_code": "7642200101",
"activated_at": "2026-08-28T07:30:00Z",
"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-08-20T09:45:00Z",
"updated_at": "2026-08-28T07:31:12Z",
"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-08-20T09:14:32Z",
"updated_at": null
},
"panels": [
{
"panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
"added_at": "2026-08-20T09:45:00Z"
}
],
"individual_biomarkers": [],
"metadata": { "your_order_ref": "ORD-10482" },
"replaces_home_kit_order_id": null,
"replacement_reason": null,
"results_ready_emails": [],
"shipments": [
{ "id": "K2608211FQ7", "added_at": "2026-08-21T08:00:00Z" },
{ "id": "K260821P3XD", "added_at": "2026-08-21T08:00:00Z" }
]
}
{
"error": "Home kit order is already activated"
}
Ilmoita, että potilas otti näytteensä. Tämä on kotitestipakkauksen vastine päätepisteelle
Vahvista verinäytteenotto — ilman viivakoodia, koska pakkauksen
koodi lisätään pakkaamisen yhteydessä. Välität vain näytteenoton aikaleiman.
Aikaleimalla on kliinistä merkitystä: se on näytteenottoaika, joka tulee laboratorioraporttiin. Lähetä
potilaan todellinen näytteenottohetki, älä hetkeä jolloin järjestelmäsi käsitteli sen.
Saman
activated_at-arvon lähettäminen uudelleen palauttaa 200 ja aktivoidun tilauksen; eri arvo palauttaa 409. Katso Idempotenssi.
Aktivointi siirtää tilauksen activated-tilaan, joka on lopullinen tila. Aktivoitua tilausta ei voi enää
peruuttaa, ja sen sisältö sekä toimitusosoite lukitaan. Aktivointi hyväksytään tilauksen ollessa
pending- tai dispatched-tilassa, kunhan sillä on lab_code — potilaalla voi olla pakkaus
kädessään jo ennen kuin kirjauksemme näyttää sen lähetetyksi, ja hänen todellinen näytteenottoaikansa
voittaa aina meidän kirjanpitomme. Tilaus ilman lab_code-koodia palauttaa 409: ilman koodia
näytettä ei voida yhdistää potilaaseen laboratoriossa.
Aktivointi tekee myös laboratoriotilauksen pakkauksen paneelille tilauksen lab_code-koodilla, jotta
laboratorio osaa odottaa näytettä ja tulokset voidaan liittää heti, kun ne raportoidaan. Tämä tapahtuu
asynkronisesti vastauksen jälkeen — laboratorion ongelma ei koskaan aiheuta pyyntösi epäonnistumista.
Tästä eteenpäin Hae tulokset näyttää merkkiaineet tilassa planned,
kunnes laboratorio raportoi ne. home_kit_order.results.updated-webhook ilmoittaa
sinulle, kun ne muuttuvat.
Jos näyte saapuu laboratorioon ennen kuin aktivoit pakkauksen, Aniva aktivoi sen.
activated_at on palautuspaketin ensimmäisen seurantatapahtuman aamu tai näytteen laboratorioon
saapumispäivän aamu, jos seurantaa ei ole. Myöhempi kutsu eri activated_at-arvolla palauttaa
silloin 409.
Vaatii home_kit_orders_manage-scopen tai rajatumman home_kit_orders_activate-scopen.
Pyyntö
Polkuparametrit
Runkoparametrit
Ajankohta, jolloin potilas otti näytteen, UTC-aikaleimana (ISO 8601
Z-päätteellä, esim.
2026-08-28T07:30:00Z). Ei saa olla tulevaisuudessa eikä yli 30 päivää menneisyydessä.Vastaus
Onnistuessaan API palauttaa tilakoodin200 OK sekä päivitetyn kotitestipakkauksen tilauksen — status on activated ja
activated_at sisältää lähettämäsi aikaleiman.
Virhevastaukset
| Tila | Kuvaus |
|---|---|
400 | Validointivirhe — virheellinen activated_at, tulevaisuudessa oleva aikaleima tai yli 30 päivää vanha aikaleima. |
403 | Pääsy estetty — API-avaimellasi ei ole oikeutta tähän toimintoon tai kotitestipakkauksen tilaus on käyttöoikeuslaajuutesi ulkopuolella. |
404 | Kotitestipakkauksen tilausta ei löytynyt. |
409 | Ristiriita — aktivoitu jo eri näytteenottoajalla, peruutettu tai ei vielä lab_code-koodia. |
500 | Sisäinen palvelinvirhe. |
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/activate \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"activated_at": "2026-08-28T07:30:00Z"
}'
{
"id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
"profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"status": "activated",
"lab_code": "7642200101",
"activated_at": "2026-08-28T07:30:00Z",
"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-08-20T09:45:00Z",
"updated_at": "2026-08-28T07:31:12Z",
"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-08-20T09:14:32Z",
"updated_at": null
},
"panels": [
{
"panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
"added_at": "2026-08-20T09:45:00Z"
}
],
"individual_biomarkers": [],
"metadata": { "your_order_ref": "ORD-10482" },
"replaces_home_kit_order_id": null,
"replacement_reason": null,
"results_ready_emails": [],
"shipments": [
{ "id": "K2608211FQ7", "added_at": "2026-08-21T08:00:00Z" },
{ "id": "K260821P3XD", "added_at": "2026-08-21T08:00:00Z" }
]
}
{
"error": "Home kit order is already activated"
}
⌘I
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/activate \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"activated_at": "2026-08-28T07:30:00Z"
}'
{
"id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
"profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"status": "activated",
"lab_code": "7642200101",
"activated_at": "2026-08-28T07:30:00Z",
"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-08-20T09:45:00Z",
"updated_at": "2026-08-28T07:31:12Z",
"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-08-20T09:14:32Z",
"updated_at": null
},
"panels": [
{
"panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
"added_at": "2026-08-20T09:45:00Z"
}
],
"individual_biomarkers": [],
"metadata": { "your_order_ref": "ORD-10482" },
"replaces_home_kit_order_id": null,
"replacement_reason": null,
"results_ready_emails": [],
"shipments": [
{ "id": "K2608211FQ7", "added_at": "2026-08-21T08:00:00Z" },
{ "id": "K260821P3XD", "added_at": "2026-08-21T08:00:00Z" }
]
}
{
"error": "Home kit order is already activated"
}