Mājas testa komplektu pasūtījumi
Aktivizēt mājas testa komplekta pasūtījumu
Ziņot, kad pacients paņēma paraugu
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"
}
Ziņo, ka pacients ir paņēmis paraugu. Šis ir mājas testa komplekta ekvivalents galapunktam
Apstiprināt asins paņemšanu — bez svītrkoda, jo komplekta
kods tiek uzlikts pakošanas laikā. Tu nosūti tikai parauga paņemšanas laika zīmogu.
Laika zīmogam ir klīniska nozīme: tas ir parauga paņemšanas laiks, kas būs norādīts laboratorijas
pārskatā. Nosūti brīdi, kad pacients faktiski paņēma paraugu, nevis brīdi, kad tava sistēma to
apstrādāja.
Atkārtoti nosūtot to pašu
activated_at, tiek atgriezts 200 ar aktivizēto pasūtījumu; cits laiks atgriež 409. Skati Idempotence.
Aktivizēšana pārvieto pasūtījumu uz activated — galīgo statusu. Aktivizētu pasūtījumu vairs nevar
atcelt, un tā sastāvs un piegādes adrese tiek bloķēti. Aktivizēšana tiek pieņemta, kamēr
pasūtījumam ir statuss pending vai dispatched, ja vien tam ir lab_code — komplekts var būt
pacienta rokās, pirms mūsu ierakstā parādās nosūtīšana, un faktiskajam paņemšanas laikam vienmēr ir
priekšroka pār mūsu uzskaiti. Pasūtījums bez lab_code atgriež 409: bez koda paraugu laboratorijā
nevar piesaistīt pacientam.
Aktivizēšana arī iesniedz laboratorijas pasūtījumu komplekta panelim ar pasūtījuma lab_code, lai
laboratorijā paraugs tiktu gaidīts un rezultāti varētu pievienoties uzreiz, kad tie tiek paziņoti. Tas notiek
asinhroni pēc atbildes nosūtīšanas — laboratorijas problēma nekad neizraisa tava pieprasījuma kļūmi.
No šī brīža Iegūt rezultātus rāda marķierus kā planned, līdz
laboratorija tos paziņo. Par izmaiņām tevi informē home_kit_order.results.updated tīmekļa āķis.
Ja paraugs nonāk laboratorijā, pirms tu aktivizē komplektu, to aktivizē Aniva.
activated_at ir atgriešanas sūtījuma pirmā izsekošanas notikuma rīts vai rīts, kad
paraugs nonāca laboratorijā, ja izsekošanas nav. Vēlāks izsaukums ar citu
activated_at tad atgriež 409.
Nepieciešams home_kit_orders_manage tiesību tvērums vai šaurākais home_kit_orders_activate tiesību tvērums.
Pieprasījums
Ceļa parametri
Pieprasījuma satura parametri
Brīdis, kad pacients paņēma paraugu, kā UTC laiks (ISO 8601 ar
Z sufiksu, piem.,
2026-08-28T07:30:00Z). Nedrīkst būt nākotnē vai senāk par 30 dienām.Atbilde
Veiksmīgas izpildes gadījumā API atgriež200 OK ar atjaunināto mājas testa komplekta pasūtījumu — status ir activated, un
activated_at satur laikspiedolu, ko nosūtīji.
Kļūdu atbildes
| Statuss | Apraksts |
|---|---|
400 | Validācijas kļūda — nederīgs activated_at formāts, nākotnes laikspiedols vai laikspiedols, kas vecāks par 30 dienām. |
403 | Aizliegts — tavai API atslēgai nav piekļuves šai darbībai vai mājas testa komplekta pasūtījums ir ārpus tava atļauju tvēruma. |
404 | Mājas testa komplekta pasūtījums nav atrasts. |
409 | Konflikts — jau aktivizēts ar citu parauga paņemšanas laiku, atcelts vai tam vēl nav lab_code. |
500 | Iekšēja servera kļūda. |
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"
}