Ugrás a fő tartalomhoz
POST
Hozz létre egy új páciensprofilt, és rendeld hozzá egy profilcsoporthoz. A profil tárolja az időpontokhoz és laborrendelésekhez használt demográfiai adatokat. A create_user scope szükséges hozzá. Küldj opcionális Idempotency-Key fejlécet, hogy a létrehozás biztonságosan újrapróbálható legyen — ugyanazzal a kulccsal megismételve az eredeti válasz érkezik vissza egy újabb létrehozása helyett. Lásd: Idempotencia.

Kérés

Törzsparaméterek

string
kötelező
A páciens keresztneve. Latin karaktereket kell tartalmaznia, 1 és 100 karakter között.
string
kötelező
A páciens vezetékneve. Latin karaktereket kell tartalmaznia, 1 és 100 karakter között. A laboratóriumok elutasítják a vezetéknév nélküli páciensek rendeléseit, ezért enélkül nem hozható létre profil.Három érték fenntartott a tesztadatok előkészítésére – lásd: Sandbox tesztadatok.
integer
kötelező
Biológiai nem az ISO/IEC 5218 szabvány szerint. Férfi esetén 1, nő esetén 2. A laboratóriumnak a referenciatartományokhoz szüksége van rá, ezért a 0 (ismeretlen) 400-at ad vissza. Kötelező, hacsak a profilcsoportod nem engedi, hogy a páciens a tesztkészlet aktiválási oldalán adja meg. Ebben az esetben hagyd el. Lásd: Születési dátum és nem megadása a páciens által.
string
kötelező
Születési dátum YYYY-MM-DD formátumban. Múltbeli dátumnak kell lennie, 1900-nál nem korábbinak. Az ebből számított életkornak 16 és 100 év között kell lennie. Más értékek 400-at adnak vissza. Kötelező, hacsak a profilcsoportod nem engedi, hogy a páciens a tesztkészlet aktiválási oldalán adja meg. Ebben az esetben hagyd el.
string
kötelező
Polimorf hivatkozás (UUID vagy slug) arra a profilcsoportra, amelyhez ezt a profilt hozzá szeretnéd rendelni. Az UUID megváltoztathatatlan azonosító, és a slug átnevezése után is érvényes marad; a slug továbbra is elfogadott az olvasható azonosítókra épülő marketing- és partnerintegrációkhoz. Az UUID használata ajánlott. A profilcsoportnak az API-kulcsod hozzáférési körén belül kell lennie. Kötelező, hacsak nem az elavult profile_group_slug mezőt küldöd el.
string
elavult
Elavult: használd a profile_group mezőt. A profilcsoport slugja. Csak kisbetűk, számjegyek, kötőjelek és aláhúzások szerepelhetnek benne.
string
A profil e-mail-címe. Ha elhagyod, az Aniva automatikusan generál egy e-mail-címet.Az email megadása biztonságosan megismételhetővé is teszi a létrehozást: egy címhez csak egy profil tartozhat, így egy megismételt kérés újabb profil helyett 409-et ad vissza. Az automatikusan generált címek kérésenként egyediek. Küldj email mezőt vagy Idempotency-Key fejlécet, ha az integrációd újrapróbálkozik.
string
Telefonszám E.164 formátumban (pl. +14155552671).
number
Magasság centiméterben.
number
Testsúly kilogrammban.
string
alapértelmezett:"en"
A profil preferált nyelve: 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 vagy uk. Alapértelmezés szerint en.
boolean
Kapjon-e ez a profil tranzakciós (automatikus) e-maileket – időpont-visszaigazolásokat, az eredmények elkészültéről szóló értesítéseket stb. Felülírja a profilcsoport alapértelmezését. Független a marketing-hozzájárulástól. Hagyd el az alapértelmezett érték használatához.
boolean
Hozzájárul-e ez a profil a marketing e-mailekhez (hírlevelek, termékújdonságok). Felülírja a profilcsoport alapértelmezését. Független a tranzakciós e-mailektől. Hagyd el a profilcsoport alapértelmezett értékének használatához. Csak írható: a profil válaszában nem szerepel.

Sandbox tesztadatok

Minden tesztelésre érdemes lekérdezési útvonal – Időpontok listázása, Eredmények lekérése, Dokumentum letöltése – üres marad, amíg napokkal később meg nem történik egy valódi vérvétel. Ez megnehezíti az automatizált integrációs tesztek megírását. Ennek megoldására három last_name érték van fenntartva. Hozz létre egy profilt valamelyikkel, és az Aniva már a válasz előtt előre feltölti az alábbi állapotot, így a következő hívásod már látni fogja: Az egyezés nem érzékeny a kis- és nagybetűkre. Minden más mezőt – beleértve a date_of_birth és a sex mezőt is – a szokásos módon tárol és használ a rendszer, így a visszakapott referenciatartományok a létrehozott profil valódi, életkor- és nemspecifikus tartományai. Az időpontot az Aniva Test helyszínre foglaljuk egy valós, foglalható idősávba, legalább öt nappal későbbre (vagy öt nappal korábbra a múltbeli állapotoknál). A feltöltés nem ad le laborrendelést, és nem foglal futárt.
A tesztprofiloknak olyan címet adj meg, amelyet te kezelsz. Az Aniva időpont-emlékeztetőit a scheduled_at vezérli, így a közelgő tesztadat kiküldi őket, hacsak a profilnál nincs letiltva a transactional_emails_enabled: false beállítással.
A rendszer véletlenszerűen választ ki egy panelt az API-kulcsod számára látható panelek közül, így a panel_id mindig feloldható a saját Panelek listázása alapján. A klinikai biomarkerek a biomarker referenciatartományán belüli értéket kapnak; a gének véletlenszerű genotípust az Aniva referenciaadataiból, az ebből adódó megfelelő variánsokkal, klinikai jelentőséggel és rs-azonosítókkal.
A panel és az értékek minden létrehozáskor újragenerálódnak, ezért a struktúrát ellenőrizd, ne egy adott panelt vagy pontos számokat.

Válasz

Siker esetén az API 201 Created választ ad vissza az újonnan létrehozott profillal.
string
kötelező
Egyedi profilazonosító (UUID).
string
Profil handle vagy felhasználónév. Lehet null.
string
Keresztnév. Lehet null.
string
Vezetéknév. Lehet null.
string
E-mail-cím. Lehet null.
string
Telefonszám E.164 formátumban. Lehet null.
integer
Biológiai nem az ISO/IEC 5218 szerint (0 = ismeretlen, 1 = férfi, 2 = nő). Lehet null.
string
Születési dátum YYYY-MM-DD formátumban. Lehet null.
number
Magasság centiméterben. Lehet null.
number
Testsúly kilogrammban. Lehet null.
string
Preferált nyelv, a fenti 32 kód egyike.
boolean
Kap-e ez a profil tranzakciós (automatikus) e-maileket. null, ha még soha nem állították be.
string
A profil létrehozásának ISO 8601 időbélyege.
string
Az utolsó frissítés ISO 8601 időbélyege. Újonnan létrehozott profiloknál null.

Hibaválaszok

Egy 409 válasz így néz ki — kezeld úgy, hogy „ez a profil már létezik”, és keresd meg a Profilok listázása (?email=) segítségével a létrehozás újrapróbálása helyett:
Ha egy személynek ugyanaz a keresztneve, vezetékneve, neme és születési dátuma, mint egy olyan profilnak, amelyet a kulcsod lát, 409 választ kapsz error_name: "duplicate_profile_error" értékkel. Használd a visszaadott profile_id azonosítót egy második profil létrehozása helyett:
A tesztadatokat feltöltő sandbox vezetéknevek kivételt képeznek.