Pāriet uz galveno saturu
POST
Izveido jaunu pacienta profilu un piešķir to profilu grupai. Profilā glabājas demogrāfiskie dati, ko izmanto pierakstos un laboratorijas pasūtījumos. Nepieciešams create_user tvērums. Nosūti neobligātu Idempotency-Key galveni, lai šo izveides pieprasījumu varētu droši atkārtot — atkārtojot to pašu atslēgu, tiek atgriezta sākotnējā atbilde, nevis izveidots otrs pieraksts. Skati Idempotence.

Pieprasījums

Pieprasījuma satura parametri

string
obligāts
Pacienta vārds. Jāizmanto latīņu alfabēta rakstzīmes, no 1 līdz 100 rakstzīmēm.
string
obligāts
Pacienta uzvārds. Jāizmanto latīņu alfabēta rakstzīmes, no 1 līdz 100 rakstzīmēm. Laboratorijas noraida pasūtījumus pacientam bez uzvārda, tāpēc profilu bez tā nevar izveidot.Trīs vērtības ir rezervētas testa datu izveidei — skati Sandbox testa dati.
integer
obligāts
Bioloģiskais dzimums atbilstoši ISO/IEC 5218. Izmanto 1 vīrietim, 2 sievietei. Tas laboratorijai ir nepieciešams references intervāliem, tāpēc 0 (nezināms) atgriež 400. Obligāts, ja vien tava profilu grupa neļauj pacientam to ievadīt komplekta aktivizēšanas lapā. Tad to izlaid. Skati Ļaut pacientam ievadīt dzimšanas datumu un dzimumu.
string
obligāts
Dzimšanas datums formātā YYYY-MM-DD. Jābūt pagātnē un ne agrāk par 1900. gadu. Aprēķinātajam vecumam jābūt no 16 līdz 100 gadiem. Citas vērtības atgriež 400. Obligāts, ja vien tava profilu grupa neļauj pacientam to ievadīt komplekta aktivizēšanas lapā. Tad to izlaid.
string
obligāts
Polimorfa atsauce (UUID vai slug) uz profilu grupu, kurai piešķirt šo profilu. UUID ir nemainīgs identifikators un saglabājas arī pēc slug pārdēvēšanas; slug joprojām tiek pieņemts mārketinga un partneru integrācijām, kas balstītas uz salasāmiem identifikatoriem. Ieteicams izmantot UUID. Profilu grupai ir jābūt tavas API atslēgas piekļuves kontekstā. Obligāts, ja vien nenosūti novecojušo profile_group_slug.
string
novecojis
Novecojis: izmanto profile_group. Profilu grupas slug. Tikai mazie burti, cipari, defises un pasvītras.
string
Profila e-pasta adrese. Ja to izlaid, Aniva automātiski izveido e-pasta adresi.Norādot email, izveide kļūst droša pret atkārtotiem mēģinājumiem: vienai adresei var būt tikai viens profils, tāpēc atkārtots pieprasījums atgriež 409, nevis izveido otru profilu. Automātiski izveidotās adreses ir unikālas katram pieprasījumam. Nosūti email vai Idempotency-Key, ja tava integrācija atkārto pieprasījumus.
string
Tālruņa numurs E.164 formātā (piemēram, +14155552671).
number
Augums centimetros.
number
Svars kilogramos.
string
noklusējums:"en"
Vēlamā profila valoda: 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 vai uk. Noklusējuma vērtība ir en.
boolean
Vai šim profilam jāsaņem transakciju (automātiskie) e-pasti — pierakstu apstiprinājumi, paziņojumi par gataviem rezultātiem u. c. Pārraksta profilu grupas noklusējumu. Nav saistīts ar piekrišanu mārketingam. Izlaid, lai izmantotu noklusējumu.
boolean
Vai šis profils piekrīt saņemt mārketinga e-pastus (jaunumus, produktu atjauninājumus). Pārraksta profilu grupas noklusējumu. Nav saistīts ar transakciju e-pastiem. Izlaid, lai izmantotu profilu grupas noklusējumu. Tikai rakstīšanai: netiek atgriezts profila atbildē.

Sandbox testa dati

Katrs testēšanas vērts lasīšanas ceļš — Iegūt pierakstu sarakstu, Iegūt rezultātus, Lejupielādēt dokumentu — ir tukšs, līdz dažas dienas vēlāk notiek reāla asins paņemšana. Tāpēc automātisku integrācijas testu ir neērti uzrakstīt. Lai to atrisinātu, ir rezervētas trīs last_name vērtības. Izveido profilu ar vienu no tām, un Aniva pirms atbildes nosūtīšanas sagatavos tālāk aprakstīto stāvokli, lai tavs nākamais pieprasījums to jau redzētu: Atbilstība nav reģistrjutīga. Katrs cits lauks — tostarp date_of_birth un sex — tiek saglabāts un izmantots kā parasti, tāpēc atgrieztie references intervāli atbilst tevis izveidotā profila reālajam vecumam un dzimumam. Pieraksts tiek rezervēts Aniva Test vietā reālā pieejamā laikā vismaz pēc piecām dienām no šodienas (vai pirms piecām dienām pagātnes stāvokļiem). Tā izveide neveido laboratorijas pasūtījumu un nepiesaka kurjeru.
Norādi testa profiliem adresi, kuru kontrolē. Aniva pierakstu atgādinājumus nosaka scheduled_at, tāpēc gaidāmie testa dati tos nosūtīs, ja vien profilam nav izslēgta saņemšana ar transactional_emails_enabled: false.
Panelis tiek izvēlēts nejauši no tiem, kurus redz tava API atslēga, tāpēc tā panel_id vienmēr ir atrodams tavā Paneļu sarakstā. Klīniskie biomarķieri saņem vērtību biomarķiera references intervālā; gēni saņem nejaušu genotipu no Aniva references datiem, no kā izriet atbilstošie varianti, klīniskā nozīme un rs ID.
Panelis un vērtības tiek ģenerēti no jauna katrā izveides reizē, tāpēc pārbaudi struktūru, nevis konkrētu paneli vai precīzus skaitļus.

Atbilde

Veiksmes gadījumā API atgriež 201 Created ar jaunizveidoto profilu.
string
obligāts
Unikāls profila identifikators (UUID).
string
Profila segvārds vai lietotājvārds. Var būt null.
string
Vārds. Var būt null.
string
Uzvārds. Var būt null.
string
E-pasta adrese. Var būt null.
string
Tālruņa numurs E.164 formātā. Var būt null.
integer
Bioloģiskais dzimums pēc ISO/IEC 5218 (0 = nezināms, 1 = vīrietis, 2 = sieviete). Var būt null.
string
Dzimšanas datums YYYY-MM-DD formātā. Var būt null.
number
Augums centimetros. Var būt null.
number
Svars kilogramos. Var būt null.
string
Vēlamā valoda, viens no 32 iepriekš minētajiem kodiem.
boolean
Vai šis profils saņem transakciju (programmatiskos) e-pastus. null, ja nekad nav iestatīts.
string
Profila izveides laika zīmogs ISO 8601 formātā.
string
Pēdējā atjauninājuma laika zīmogs ISO 8601 formātā. null jaunizveidotiem profiliem.

Kļūdu atbildes

409 atbilde izskatās šādi — uztver to kā “šis profils jau eksistē” un sameklē profilu ar Profilu sarakstu (?email=), nevis atkārto izveidi:
Persona ar tādu pašu vārdu, uzvārdu, dzimumu un dzimšanas datumu kā profilam, kuru redz tava atslēga, saņem 409 ar error_name: "duplicate_profile_error". Izmanto atgriezto profile_id, nevis izveido otru profilu:
Sandbox uzvārdi, kas izveido testa datus, ir izņēmums.