Siirry pääsisältöön
Profiili on tietue, joka edustaa potilasta tai käyttäjää Anivan järjestelmässä. Jokainen ajanvaraus, laboratoriotilaus ja tulos liittyy profiiliin.

Profiiliryhmät

Kun luot profiilin, liität sen profiiliryhmään profile_group-parametrilla. Profiiliryhmä jäsentää profiilit kumppanitilisi alle ja rajaa ne tiettyyn ohjelmaan tai integraatioon. profile_group-kenttä hyväksyy joko ryhmän muuttumattoman UUID-tunnisteen tai sen ihmisen luettavan slugin. UUID on pysyvä viite — se ei koskaan muutu ja säilyy ennallaan, vaikka slug nimettäisiin uudelleen. Slug on tarkoitettu luettaviin URL-osoitteisiin ja kumppani-integraatioihin. profile_group-arvo (UUID tai slug) on pakollinen luonnin yhteydessä. Vanha profile_group_slug-kenttä hyväksytään edelleen vanhentuneena aliaksena.

Kentät

string
vaadittu
Anivan automaattisesti luoma UUID. Käytä tätä viitataksesi profiiliin muissa API-kutsuissa.
string
Valinnainen käyttäjänimi tai tunnus profiilille. Voi olla null.
string
Potilaan etunimi. Vain latinalaisia merkkejä, 1–100 merkkiä. Pakollinen luonnin yhteydessä.
string
Potilaan sukunimi. Vain latinalaisia merkkejä, 1–100 merkkiä. Pakollinen luonnin yhteydessä — laboratoriot hylkäävät tilaukset potilaille, joilla ei ole sukunimeä. Voi olla null profiileissa, jotka on luotu ennen kuin kenttä tuli pakolliseksi.
string
Potilaan sähköpostiosoite. Jos et anna sitä luonnin yhteydessä, Aniva luo automaattisesti korvaavan sähköpostiosoitteen.
string
Puhelinnumero E.164-muodossa (esim. +14155552671). Voi olla null.
integer
Biologinen sukupuoli standardin ISO/IEC 5218 mukaan: 1 = mies, 2 = nainen. Pakollinen luonnin yhteydessä, ellei profiiliryhmäsi anna potilaan syöttää sitä itse (katso alla). Laboratorio tarvitsee sen viitealueita varten, joten luonti tai päivitys arvolla 0 (tuntematon) palauttaa 400. Ennen 30. syyskuuta 2026 luodut profiilit voivat edelleen palauttaa arvon 0.
string
Syntymäaika muodossa YYYY-MM-DD. Pakollinen luonnin yhteydessä, ellei profiiliryhmäsi anna potilaan syöttää sitä itse (katso alla). Päivämäärän on oltava menneisyydessä, ei ennen vuotta 1900, ja sen on vastattava 16–100 vuoden ikää; epäuskottavat arvot hylätään koodilla 400. Syntymäaika lähetetään laboratoriolle tilauksen mukana, eikä sitä voi muuttaa tilauksen tekemisen jälkeen.
number
Pituus senttimetreinä. Voi olla null.
number
Paino kilogrammoina. Voi olla null.
string
Ensisijainen kieli potilasviestintään. Hyväksytyt arvot: en, de, fi.
boolean
Vastaanottaako profiili tapahtumapohjaisia sähköposteja, kuten ajanvarausvahvistuksia ja ilmoituksia valmistuneista tuloksista. Erillinen markkinointiluvasta. Null, jos arvoa ei ole koskaan asetettu.
string
vaadittu
ISO 8601 -aikaleima profiilin luontihetkestä.
string
ISO 8601 -aikaleima viimeisimmästä päivityksestä. Null, jos profiilia ei ole koskaan päivitetty.
Kentät first_name, last_name, sex, date_of_birth ja profile_group ovat pakollisia profiilia luotaessa. Kaikki muut kentät ovat valinnaisia. Vanha profile_group_slug-kenttä hyväksytään edelleen vanhentuneena aliaksena kentälle profile_group.

Anna potilaan syöttää syntymäaika ja sukupuoli

Voimme ottaa käyttöön yhden asetuksen profiiliryhmällesi. Silloin voit luoda profiilin ilman kenttiä date_of_birth ja sex. Pyydä meitä ottamaan se käyttöön. Ilman sitä luonti, josta puuttuu jompikumpi kenttä, palauttaa 400. Potilas syöttää molemmat testipakkauksen aktivointisivulla (anivahealth.com/activate) pakkauskoodin kanssa. Sivu kysyy syntymäajan kahdesti, koska laboratorio ei voi muuttaa sitä myöhemmin. Sen jälkeen testipakkaus avautuu vain kyseisellä syntymäajalla. Pidämme laboratoriotilauksen odottamassa, kunnes potilas syöttää molemmat tiedot. Käytä tätä asetusta vain kotitestipakkauksille.

Elinkaari

Profiilit noudattavat yksinkertaista elinkaarta:
  1. Luo — rekisteröi profiili vaadituilla demografisilla kentillä ja profile_group-arvolla (UUID tai slug).
  2. Päivitä (valinnainen) — lisää tai muuta kenttiä, kuten phone, height tai weight.
  3. Yhdistä — liitä profiili ajanvarauksiin käyttämällä sen id-arvoa profile_id-kenttänä.
profile.*-webhook kertoo, kun profiili lisätään, muuttuu tai poistetaan.

Esimerkkiprofiili