Spring til hovedindhold
POST
Opret en ny patientprofil, og tildel den til en profilgruppe. Profilen indeholder demografiske data, der bruges på tværs af tider og laboratoriebestillinger. Kræver scopet create_user. Send en valgfri Idempotency-Key-header for at gøre denne oprettelse sikker at prøve igen — gentages den samme nøgle, returneres det oprindelige svar i stedet for at oprette endnu en. Se Idempotens.

Forespørgsel

Body-parametre

string
påkrævet
Patientens fornavn. Skal bruge latinske tegn, mellem 1 og 100 tegn.
string
påkrævet
Patientens efternavn. Skal bruge latinske tegn, mellem 1 og 100 tegn. Laboratorier afviser bestillinger for en patient uden efternavn, så en profil kan ikke oprettes uden.Tre værdier er reserveret til at oprette testdata – se Sandbox-testdata.
integer
påkrævet
Biologisk køn efter ISO/IEC 5218. Brug 1 for mand, 2 for kvinde. Laboratoriet skal bruge det til referenceintervallerne, så 0 (ukendt) returnerer 400. Påkrævet, medmindre din profilgruppe lader patienten indtaste det på aktiveringssiden for kittet. Udelad det i så fald. Se Lad patienten indtaste fødselsdato og køn.
string
påkrævet
Fødselsdato i formatet YYYY-MM-DD. Skal ligge i fortiden og ikke før 1900. Den beregnede alder skal være mellem 16 og 100 år. Andre værdier returnerer 400. Påkrævet, medmindre din profilgruppe lader patienten indtaste den på aktiveringssiden for kittet. Udelad den i så fald.
string
påkrævet
Polymorfisk reference (UUID eller slug) til den profilgruppe, profilen skal tildeles. UUID’et er det uforanderlige id og overlever omdøbning af slug; slug accepteres fortsat til marketing- og partnerintegrationer baseret på læsbare id’er. UUID foretrækkes. Profilgruppen skal ligge inden for din API-nøgles adgangskontekst. Påkrævet, medmindre du sender den udfasede profile_group_slug.
string
forældet
Udfaset: brug profile_group. Profilgruppens slug. Kun små bogstaver, cifre, bindestreger og understreger.
string
E-mailadresse for profilen. Hvis den udelades, genererer Aniva automatisk en e-mailadresse.At angive email gør også oprettelsen sikker ved genforsøg: en adresse kan kun have én profil, så en gentaget anmodning returnerer 409 i stedet for endnu en profil. Autogenererede adresser er unikke pr. anmodning. Send email eller en Idempotency-Key, hvis din integration forsøger igen.
string
Telefonnummer i E.164-format (f.eks. +14155552671).
number
Højde i centimeter.
number
Vægt i kilogram.
string
standard:"en"
Foretrukket sprog for profilen: 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 eller uk. Standard er en.
boolean
Om denne profil skal modtage transaktionelle (automatiske) e-mails – tidsbekræftelser, besked når resultaterne er klar osv. Tilsidesætter profilgruppens standard. Adskilt fra samtykke til markedsføring. Udelad for at bruge standarden.
boolean
Om denne profil tilmelder sig markedsføringsmails (nyhedsbreve, produktopdateringer). Tilsidesætter profilgruppens standard. Adskilt fra transaktionelle e-mails. Udelad for at bruge profilgruppens standard. Kun skrivning: returneres ikke i profilsvaret.

Sandbox-testdata

Alle læse-endpoints, der er værd at teste – Vis tider, Hent resultater, Download dokument – er tomme, indtil en rigtig blodprøvetagning finder sted dage senere. Det gør en automatiseret integrationstest besværlig at skrive. Tre last_name-værdier er reserveret til at løse det. Opret en profil med en af dem, så forudfylder Aniva den tilstand, der er beskrevet nedenfor, før svaret sendes, så dit næste kald allerede ser den: Matchningen skelner ikke mellem store og små bogstaver. Alle andre felter – inklusive date_of_birth og sex – gemmes og bruges som normalt, så de referenceintervaller, du får tilbage, er de rigtige alders- og kønsspecifikke for den profil, du har oprettet. Tiden bookes på lokationen Aniva Test i et reelt ledigt tidsrum mindst fem dage fra nu (eller fem dage siden for tidligere tilstande). Oprettelsen afgiver ingen laboratoriebestilling og booker ingen kurér.
Giv testprofiler en adresse, du selv kontrollerer. Anivas påmindelser om tider styres af scheduled_at, så testdataene for en kommende tid sender dem, medmindre profilen er frameldt via transactional_emails_enabled: false.
Panelet vælges tilfældigt blandt dem, din API-nøgle kan se, så dets panel_id altid kan slås op via dit eget Vis paneler. Kliniske biomarkører får en værdi inden for biomarkørens referenceinterval; gener får en tilfældig genotype fra Anivas referencedata, hvor de tilhørende varianter, den kliniske betydning og rs-id’er følger af den.
Panel og værdier genereres på ny ved hver oprettelse, så tjek strukturen frem for et bestemt panel eller nøjagtige tal.

Svar

Ved succes returnerer API’et 201 Created med den nyoprettede profil.
string
påkrævet
Unikt profil-id (UUID).
string
Profil-handle eller brugernavn. Kan være null.
string
Fornavn. Kan være null.
string
Efternavn. Kan være null.
string
E-mailadresse. Kan være null.
string
Telefonnummer i E.164-format. Kan være null.
integer
Biologisk køn efter ISO/IEC 5218 (0 = ukendt, 1 = mand, 2 = kvinde). Kan være null.
string
Fødselsdato i YYYY-MM-DD-format. Kan være null.
number
Højde i centimeter. Kan være null.
number
Vægt i kilogram. Kan være null.
string
Foretrukket sprog, en af de 32 koder ovenfor.
boolean
Om denne profil modtager transaktionelle (automatiske) e-mails. null, hvis den aldrig er angivet.
string
ISO 8601-tidsstempel for, hvornår profilen blev oprettet.
string
ISO 8601-tidsstempel for seneste opdatering. null for nyoprettede profiler.

Fejlsvar

En 409 ser sådan ud — betragt den som “denne profil findes allerede”, og slå den op med Vis profiler (?email=) i stedet for at forsøge oprettelsen igen:
En person med samme fornavn, efternavn, køn og fødselsdato som en profil, din nøgle kan se, får en 409 med error_name: "duplicate_profile_error". Brug det returnerede profile_id i stedet for at oprette en ny profil:
Efternavnene i sandkassen, der opretter testdata, er undtaget.