Thuistestkitbestellingen
Thuistestkit-bestelling activeren
Melden wanneer de patiënt het monster heeft afgenomen
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"
}
Meld dat de patiënt het monster heeft afgenomen. Dit is de tegenhanger voor thuistestkits van
Bloedafname bevestigen — zonder barcode, omdat de code van
de kit bij het inpakken wordt aangebracht. Je geeft alleen het tijdstip van afname door.
Het tijdstip is klinisch van belang: het is het afnametijdstip dat op het labrapport komt te staan.
Stuur het daadwerkelijke afnamemoment van de patiënt, niet het moment waarop je systeem dit heeft
verwerkt.
Opnieuw dezelfde
activated_at sturen geeft 200 terug met de geactiveerde bestelling; een andere geeft 409 terug. Zie Idempotentie.
Activering zet de bestelling op activated — een eindstatus. Een geactiveerde bestelling kan niet
meer worden geannuleerd en de samenstelling en het bezorgadres staan vast. Activering wordt
geaccepteerd zolang de bestelling pending of dispatched is en een lab_code heeft — de
patiënt kan al een kit in handen hebben voordat onze registratie verzonden aangeeft, en het echte
afnametijdstip gaat altijd voor op onze administratie. Een bestelling zonder lab_code geeft 409
terug: zonder de code kan het monster in het laboratorium niet aan de patiënt worden gekoppeld.
Activering plaatst ook de laboratoriumaanvraag voor het panel van de kit onder de lab_code van
de bestelling, zodat het monster bij het laboratorium wordt verwacht en resultaten direct gekoppeld
kunnen worden zodra ze worden gemeld. Dit gebeurt asynchroon na het antwoord — een probleem bij het
laboratorium laat je verzoek nooit mislukken. Vanaf dat moment toont
Resultaten ophalen markers als planned totdat het
laboratorium ze rapporteert. Een home_kit_order.results.updated-webhook
meldt je wanneer ze veranderen.
Als het monster het laboratorium bereikt voordat je de kit activeert, activeert Aniva de kit.
activated_at is de ochtend van de eerste trackinggebeurtenis van het retourpakket, of de ochtend
waarop het monster bij het laboratorium aankwam als er geen tracking is. Een latere aanroep met een
andere activated_at geeft dan 409 terug.
Vereist de scope home_kit_orders_manage of de beperktere scope home_kit_orders_activate.
Verzoek
Padparameters
Bodyparameters
Wanneer de patiënt het monster heeft afgenomen, als UTC-tijdstip (ISO 8601 met
Z-achtervoegsel,
bijv. 2026-08-28T07:30:00Z). Mag niet in de toekomst liggen en niet meer dan 30 dagen in het
verleden.Respons
Bij succes retourneert de API200 OK met de bijgewerkte thuistestkitbestelling — status is activated en
activated_at bevat het tijdstempel dat je hebt verstuurd.
Foutresponsen
| Status | Beschrijving |
|---|---|
400 | Validatiefout — ongeldig opgemaakte activated_at, een toekomstig tijdstempel of een tijdstempel ouder dan 30 dagen. |
403 | Toegang geweigerd — je API-sleutel heeft geen toegang tot deze bewerking, of de thuistestkitbestelling valt buiten je machtigingsscope. |
404 | Thuistestkitbestelling niet gevonden. |
409 | Conflict — al geactiveerd met een ander afnametijdstip, geannuleerd, of nog geen lab_code. |
500 | Interne serverfout. |
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"
}