Siirry pääsisältöön
POST
Luo uusi potilasprofiili ja liitä se profiiliryhmään. Profiili sisältää demografiset tiedot, joita käytetään ajanvarauksissa ja laboratoriotilauksissa. Vaatii create_user-oikeuden. Lähetä valinnainen Idempotency-Key-otsikko, jotta luontipyynnön voi yrittää turvallisesti uudelleen — saman avaimen toistaminen palauttaa alkuperäisen vastauksen toisen luomisen sijaan. Katso Idempotenssi.

Pyyntö

Runkoparametrit

string
vaadittu
Potilaan etunimi. On käytettävä latinalaisia merkkejä, 1–100 merkkiä.
string
vaadittu
Potilaan sukunimi. On käytettävä latinalaisia merkkejä, 1–100 merkkiä. Laboratoriot hylkäävät tilaukset potilailta, joilla ei ole sukunimeä, joten profiilia ei voi luoda ilman sitä.Kolme arvoa on varattu testiaineiston alustamiseen — katso Sandbox-testiaineistot.
integer
vaadittu
Biologinen sukupuoli standardin ISO/IEC 5218 mukaisesti. Käytä arvoa 1 miehelle ja 2 naiselle. Laboratorio tarvitsee sen viitealueita varten, joten 0 (tuntematon) palauttaa 400. Pakollinen, ellei profiiliryhmäsi anna potilaan syöttää sitä pakkauksen aktivointisivulla. Jätä se silloin pois. Katso Anna potilaan syöttää syntymäaika ja sukupuoli.
string
vaadittu
Syntymäaika muodossa YYYY-MM-DD. Täytyy olla menneisyydessä eikä ennen vuotta 1900. Lasketun iän on oltava 16–100 vuotta. Muut arvot palauttavat 400. Pakollinen, ellei profiiliryhmäsi anna potilaan syöttää sitä pakkauksen aktivointisivulla. Jätä se silloin pois.
string
vaadittu
Polymorfinen viittaus (UUID tai slug) profiiliryhmään, johon tämä profiili liitetään. UUID on muuttumaton tunniste, joka säilyy slugin uudelleennimeämisistä huolimatta; slug hyväksytään edelleen markkinointi- ja kumppani-integraatioissa, jotka perustuvat luettaviin tunnisteisiin. UUID on suositeltavampi. Profiiliryhmän on oltava API-avaimesi käyttöoikeusalueella. Pakollinen, ellet lähetä vanhentunutta kenttää profile_group_slug.
string
vanhentunut
Vanhentunut: käytä kenttää profile_group. Profiiliryhmän slug. Vain pieniä kirjaimia, numeroita, yhdysmerkkejä ja alaviivoja.
string
Profiilin sähköpostiosoite. Jos jätetään pois, Aniva luo sähköpostiosoitteen automaattisesti.Kentän email antaminen tekee luonnista myös uudelleenyrityksille turvallisen: yhdellä osoitteella voi olla vain yksi profiili, joten toistuva pyyntö palauttaa 409 toisen profiilin sijaan. Automaattisesti luodut osoitteet ovat yksilöllisiä pyyntöä kohden. Lähetä email tai Idempotency-Key, jos integraatiosi tekee uudelleenyrityksiä.
string
Puhelinnumero E.164-muodossa (esim. +14155552671).
number
Pituus senttimetreinä.
number
Paino kilogrammoina.
string
oletus:"en"
Profiilin ensisijainen kieli: 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 tai uk. Oletusarvo on en.
boolean
Saako tämä profiili tapahtumapohjaisia (ohjelmallisia) sähköposteja — ajanvarausvahvistuksia, ilmoituksia valmistuneista tuloksista jne. Ohittaa profiiliryhmän oletuksen. Erillinen markkinointiluvasta. Jätä pois käyttääksesi oletusta.
boolean
Suostuuko tämä profiili markkinointisähköposteihin (uutiskirjeet, tuotepäivitykset). Ohittaa profiiliryhmän oletuksen. Erillinen tapahtumapohjaisista sähköposteista. Jätä pois käyttääksesi profiiliryhmän oletusta. Vain kirjoitettava: ei palauteta profiilivastauksessa.

Sandbox-testiaineistot

Jokainen testaamisen arvoinen lukupolku — Listaa ajanvaraukset, Hae tulokset, Lataa asiakirja — on tyhjä, kunnes varsinainen verinäytteenotto tapahtuu päiviä myöhemmin. Se tekee automatisoidun integraatiotestin kirjoittamisesta hankalaa. Kolme last_name-arvoa on varattu tämän ratkaisemiseksi. Luo profiili jollakin niistä, niin Aniva esitäyttää alla kuvatun tilan ennen vastaamista, jolloin seuraava kutsusi näkee sen jo: Vertailu ei huomioi kirjainkokoa. Kaikki muut kentät — mukaan lukien date_of_birth ja sex — tallennetaan ja käytetään normaalisti, joten saamasi viitealueet ovat luomasi profiilin todelliset ikä- ja sukupuolikohtaiset viitealueet. Ajanvaraus tehdään Aniva Test -toimipisteeseen todelliselle varattavalle ajalle vähintään viiden päivän päähän (tai viisi päivää taaksepäin menneissä tiloissa). Sen alustaminen ei tee laboratoriotilausta eikä varaa kuriiria.
Anna testiprofiileille hallinnoimasi osoite. Anivan ajanvarausmuistutukset perustuvat scheduled_at-arvoon, joten tuleva testiaineisto lähettää niitä, ellei profiilin asetuksena ole transactional_emails_enabled: false.
Paneeli valitaan satunnaisesti niistä, jotka API-avaimesi näkee, joten sen panel_id löytyy aina Listaa paneelit -päätepisteestäsi. Kliiniset biomarkkerit saavat arvon biomarkkerin viitealueelta; geenit saavat satunnaisen genotyypin Anivan viitedatasta, ja vastaavat variantit, kliininen merkitys sekä rs-tunnisteet määräytyvät sen perusteella.
Paneeli ja arvot luodaan uudelleen jokaisella kerralla, joten tarkista rakenne tietyn paneelin tai tarkkojen lukujen sijaan.

Vastaus

Onnistuessaan API palauttaa tilan 201 Created ja juuri luodun profiilin.
string
vaadittu
Profiilin yksilöllinen tunniste (UUID).
string
Profiilin nimimerkki tai käyttäjätunnus. Voi olla null.
string
Etunimi. Voi olla null.
string
Sukunimi. Voi olla null.
string
Sähköpostiosoite. Voi olla null.
string
Puhelinnumero E.164-muodossa. Voi olla null.
integer
Biologinen sukupuoli ISO/IEC 5218 -standardin mukaan (0 = tuntematon, 1 = mies, 2 = nainen). Voi olla null.
string
Syntymäaika YYYY-MM-DD-muodossa. Voi olla null.
number
Pituus senttimetreinä. Voi olla null.
number
Paino kilogrammoina. Voi olla null.
string
Ensisijainen kieli, yksi yllä olevista 32 koodista.
boolean
Vastaanottaako profiili tapahtumapohjaisia (ohjelmallisia) sähköposteja. null, jos arvoa ei ole koskaan asetettu.
string
ISO 8601 -aikaleima profiilin luontihetkestä.
string
ISO 8601 -aikaleima viimeisimmästä päivityksestä. null vasta luoduilla profiileilla.

Virhevastaukset

Tilakoodi 409 näyttää tältä — käsittele se merkkinä siitä, että profiili on jo olemassa, ja hae se Listaa profiilit -päätepisteellä (?email=) sen sijaan, että yrittäisit luontia uudelleen:
Henkilö, jolla on sama etunimi, sukunimi, sukupuoli ja syntymäaika kuin avaimellesi näkyvällä profiililla, saa vastauksen 409 ja arvon error_name: "duplicate_profile_error". Käytä palautettua profile_id-arvoa toisen profiilin luomisen sijaan:
Testidataa alustavat sandbox-sukunimet ovat tästä poikkeus.