Přejít na hlavní obsah
Profil je záznam představující pacienta nebo uživatele v systému Aniva. Každý termín, laboratorní objednávka a výsledek se váže k profilu.

Skupiny profilů

Když vytváříš profil, přiřadíš ho ke skupině profilů pomocí parametru profile_group. Skupina profilů organizuje profily pod tvým partnerským účtem a vymezuje je pro konkrétní program nebo integraci. Pole profile_group přijímá buď neměnné UUID skupiny, nebo její čitelný slug. UUID je trvalý odkaz — nikdy se nemění a přežije i přejmenování slugu. Slug slouží pro čitelné URL a partnerské integrace. Hodnota profile_group (UUID nebo slug) je povinná při vytvoření. Starší pole profile_group_slug se stále přijímá jako zastaralý alias.

Pole

string
povinné
UUID automaticky vygenerované systémem Aniva. Použij ho k odkázání na profil v dalších voláních API.
string
Volitelné uživatelské jméno nebo handle profilu. Může být null.
string
Křestní jméno pacienta. Pouze znaky latinky, 1–100 znaků. Povinné při vytvoření.
string
Příjmení pacienta. Pouze znaky latinky, 1–100 znaků. Povinné při vytvoření — laboratoře zamítají objednávky pro pacienta bez příjmení. U profilů vytvořených před zavedením povinnosti může být null.
string
E-mailová adresa pacienta. Pokud ji při vytvoření neuvedeš, Aniva automaticky vygeneruje zástupný e-mail.
string
Telefonní číslo ve formátu E.164 (např. +14155552671). Může být null.
integer
Biologické pohlaví podle ISO/IEC 5218: 1 = muž, 2 = žena. Povinné při vytvoření, pokud tvoje skupina profilů nenechává zadání na pacientovi (viz níže). Laboratoř ho potřebuje pro referenční rozmezí, takže vytvoření nebo aktualizace s hodnotou 0 (neznámé) vrátí 400. Profily vytvořené před 30. zářím 2026 mohou stále vracet 0.
string
Datum narození ve formátu YYYY-MM-DD. Povinné při vytvoření, pokud tvoje skupina profilů nenechává zadání na pacientovi (viz níže). Musí být v minulosti, ne před rokem 1900, a odpovídat věku mezi 16 a 100 lety; nepravděpodobné hodnoty se zamítnou kódem 400. Datum narození se posílá laboratoři na objednávce a po jejím zadání už ho nelze změnit.
number
Výška v centimetrech. Může být null.
number
Hmotnost v kilogramech. Může být null.
string
Preferovaný jazyk pro komunikaci s pacientem. Přijímané hodnoty: en, de, fi.
boolean
Určuje, zda profil dostává transakční e-maily, například potvrzení termínu a upozornění na připravené výsledky. Oddělené od souhlasu s marketingem. Null, pokud nebylo nikdy nastaveno.
string
povinné
Časové razítko ISO 8601 vytvoření profilu.
string
Časové razítko ISO 8601 poslední aktualizace. Null, pokud profil nebyl nikdy aktualizován.
Pole first_name, last_name, sex, date_of_birth a profile_group jsou při vytváření profilu povinná. Všechna ostatní pole jsou volitelná. Starší pole profile_group_slug se stále přijímá jako zastaralý alias pro profile_group.

Nechat pacienta zadat datum narození a pohlaví

Pro tvoji skupinu profilů můžeme zapnout jedno nastavení. Pak můžeš vytvořit profil bez date_of_birth a sex. Požádej nás o jeho zapnutí. Bez něj vrátí vytvoření bez některého z těchto polí 400. Pacient zadá oba údaje na stránce pro aktivaci sady (anivahealth.com/activate) spolu s kódem sady. Stránka se na datum narození zeptá dvakrát, protože ho laboratoř později nemůže změnit. Poté se sada otevře jen s tímto datem narození. Dokud pacient nezadá oba údaje, laboratorní objednávku pozdržíme. Toto nastavení používej pouze pro domácí testovací sady.

Životní cyklus

Profily mají jednoduchý životní cyklus:
  1. Vytvoření — zaregistruj profil s povinnými demografickými poli a profile_group (UUID nebo slug).
  2. Aktualizace (volitelné) — přidej nebo změň pole jako phone, height nebo weight.
  3. Propojení — propoj profil s termíny pomocí jeho id jako profile_id.
Webhook profile.* ti dá vědět, když profil vznikne, změní se nebo se smaže.

Příklad profilu