Přejít na hlavní obsah
POST
Vytvoř nový profil pacienta a přiřaď ho do skupiny profilů. Profil obsahuje demografické údaje používané u termínů a laboratorních objednávek. Vyžaduje oprávnění create_user. Odešli volitelnou hlavičku Idempotency-Key, aby šlo toto vytvoření bezpečně zopakovat — opakované použití stejného klíče vrátí původní odpověď místo vytvoření dalšího záznamu. Viz Idempotence.

Požadavek

Parametry těla

string
povinné
Křestní jméno pacienta. Musí obsahovat znaky latinky, délka 1 až 100 znaků.
string
povinné
Příjmení pacienta. Musí obsahovat znaky latinky, délka 1 až 100 znaků. Laboratoře odmítají objednávky pro pacienta bez příjmení, takže bez něj nelze profil vytvořit.Tři hodnoty jsou vyhrazeny pro předvyplnění testovacích dat — viz Testovací data pro sandbox.
integer
povinné
Biologické pohlaví podle ISO/IEC 5218. Použij 1 pro muže, 2 pro ženu. Laboratoř ho potřebuje pro referenční rozmezí, takže 0 (neznámé) vrátí 400. Povinné, pokud tvá skupina profilů neumožňuje pacientovi zadat ho na stránce pro aktivaci sady. V takovém případě pole vynech. Viz Nechat pacienta zadat datum narození a pohlaví.
string
povinné
Datum narození ve formátu YYYY-MM-DD. Musí být v minulosti a ne před rokem 1900. Výsledný věk musí být mezi 16 a 100 lety. Jiné hodnoty vrátí 400. Povinné, pokud tvá skupina profilů neumožňuje pacientovi zadat ho na stránce pro aktivaci sady. V takovém případě pole vynech.
string
povinné
Polymorfní odkaz (UUID nebo slug) na skupinu profilů, do které se tento profil přiřadí. UUID je neměnný identifikátor a přežije přejmenování slugu; slug zůstává podporovaný pro marketingové a partnerské integrace postavené na čitelných identifikátorech. Preferováno je UUID. Skupina profilů musí spadat do přístupového kontextu tvého API klíče. Povinné, pokud neposíláš zastaralé pole profile_group_slug.
string
zastaralé
Zastaralé: použij profile_group. Slug skupiny profilů. Pouze malá písmena, číslice, pomlčky a podtržítka.
string
E-mailová adresa profilu. Pokud ji vynecháš, Aniva ji automaticky vygeneruje.Zadání pole email také zajistí, že vytvoření je bezpečné při opakování: jedna adresa může mít vždy jen jeden profil, takže opakovaný požadavek vrátí 409 místo druhého profilu. Automaticky generované adresy jsou pro každý požadavek jedinečné. Pokud tvá integrace požadavky opakuje, pošli email nebo Idempotency-Key.
string
Telefonní číslo ve formátu E.164 (např. +14155552671).
number
Výška v centimetrech.
number
Hmotnost v kilogramech.
string
výchozí:"en"
Preferovaný jazyk profilu: en, bg, ca, cs, da, de, el, es, et, fi, fr, ga, hr, hu, is, it, lb, lt, lv, mt, nl, no, pl, pt, ro, ru, sk, sl, sr, sv, tr nebo uk. Výchozí hodnota je en.
boolean
Zda má tento profil dostávat transakční (systémové) e-maily — potvrzení termínů, oznámení o připravených výsledcích apod. Přepisuje výchozí nastavení skupiny profilů. Nezávisí na souhlasu s marketingem. Vynech, pokud chceš použít výchozí nastavení.
boolean
Zda tento profil souhlasí s marketingovými e-maily (newslettery, produktové novinky). Přepisuje výchozí nastavení skupiny profilů. Nezávisí na transakčních e-mailech. Vynech, pokud chceš použít výchozí nastavení skupiny profilů. Pouze pro zápis: v odpovědi profilu se nevrací.

Testovací data pro sandbox

Každá cesta pro čtení, kterou stojí za to otestovat — Vypsat termíny, Získat výsledky, Stáhnout dokument — je prázdná, dokud o několik dní později neproběhne skutečný odběr krve. Psát automatizované integrační testy je pak nepraktické. Pro vyřešení tohoto problému jsou vyhrazeny tři hodnoty last_name. Vytvoř profil s jednou z nich a Aniva ještě před odesláním odpovědi předvyplní stav popsaný níže, takže ho tvé další volání už uvidí: Porovnání nerozlišuje velikost písmen. Každé další pole — včetně date_of_birth a sex — se ukládá a používá běžným způsobem, takže vrácená referenční rozmezí odpovídají skutečnému věku a pohlaví vytvořeného profilu. Termín se rezervuje na pobočce Aniva Test, ve skutečném rezervovatelném slotu nejméně za pět dní od teď (nebo před pěti dny u minulých stavů). Jeho vygenerování nezadá laboratorní objednávku ani neobjedná kurýra.
Testovacím profilům dej adresu, kterou máš pod kontrolou. Připomínky termínů Aniva se řídí podle scheduled_at, takže nadcházející fixture je odešle, pokud profil není odhlášený přes transactional_emails_enabled: false.
Panel se vybere náhodně z těch, které tvůj API klíč vidí, takže jeho panel_id vždy najdeš ve svém Seznamu panelů. Klinické biomarkery dostanou hodnotu v rámci referenčního rozmezí biomarkeru; geny dostanou náhodný genotyp z referenčních dat Aniva, z něhož vycházejí odpovídající varianty, klinický význam a rs ID.
Panel a hodnoty se při každém vytvoření generují znovu, takže ověřuj spíš strukturu než konkrétní panel nebo přesná čísla.

Odpověď

Při úspěchu vrátí API 201 Created s nově vytvořeným profilem.
string
povinné
Jedinečný identifikátor profilu (UUID).
string
Handle nebo uživatelské jméno profilu. Může být null.
string
Křestní jméno. Může být null.
string
Příjmení. Může být null.
string
E-mailová adresa. Může být null.
string
Telefonní číslo ve formátu E.164. Může být null.
integer
Biologické pohlaví podle ISO/IEC 5218 (0 = neznámé, 1 = muž, 2 = žena). Může být null.
string
Datum narození ve formátu YYYY-MM-DD. Může být null.
number
Výška v centimetrech. Může být null.
number
Hmotnost v kilogramech. Může být null.
string
Preferovaný jazyk, jeden z 32 kódů výše.
boolean
Zda tento profil přijímá transakční (automatické) e-maily. null, pokud nebylo nikdy nastaveno.
string
Časové razítko ISO 8601 vytvoření profilu.
string
Časové razítko ISO 8601 poslední aktualizace. null u nově vytvořených profilů.

Chybové odpovědi

Odpověď 409 vypadá takto — ber ji jako „tento profil už existuje“ a místo opakování vytvoření ho vyhledej přes Seznam profilů (?email=):
Osoba se stejným křestním jménem, příjmením, pohlavím a datem narození jako profil, který tvůj klíč vidí, dostane 409 s error_name: "duplicate_profile_error". Použij vrácené profile_id místo vytváření druhého profilu:
Příjmení v sandboxu, která generují testovací data, mají výjimku.