Hopp til hovedinnhold
POST
Opprett en ny pasientprofil og tilordne den til en profilgruppe. Profilen inneholder demografiske data som brukes på tvers av timer og labbestillinger. Krever scope-et create_user. Send en valgfri Idempotency-Key-header for å gjøre denne opprettelsen trygg å prøve på nytt — hvis samme nøkkel sendes igjen, returneres det opprinnelige svaret i stedet for å opprette en til. Se Idempotens.

Forespørsel

Body-parametere

string
påkrevd
Fornavnet til pasienten. Må bruke latinske tegn, mellom 1 og 100 tegn.
string
påkrevd
Etternavnet til pasienten. Må bruke latinske tegn, mellom 1 og 100 tegn. Laboratorier avviser bestillinger for en pasient uten etternavn, så en profil kan ikke opprettes uten.Tre verdier er reservert for å opprette testdata — se Testdata i sandkassen.
integer
påkrevd
Biologisk kjønn etter ISO/IEC 5218. Bruk 1 for mann, 2 for kvinne. Laboratoriet trenger det for referanseområdene, så 0 (ukjent) returnerer 400. Påkrevd, med mindre profilgruppen din lar pasienten oppgi det på siden for aktivering av testsettet. Utelat det i så fall. Se La pasienten oppgi fødselsdato og kjønn.
string
påkrevd
Fødselsdato i formatet YYYY-MM-DD. Må være i fortiden og ikke før 1900. Den beregnede alderen må være mellom 16 og 100 år. Andre verdier returnerer 400. Påkrevd, med mindre profilgruppen din lar pasienten oppgi det på siden for aktivering av testsettet. Utelat det i så fall.
string
påkrevd
Polymorf referanse (UUID eller slug) til profilgruppen denne profilen skal tilordnes. UUID-en er den uforanderlige identifikatoren og overlever navneendringer på slug-en; slug-en godtas fortsatt for markedsføring og partnerintegrasjoner som bygger på lesbare identifikatorer. UUID foretrekkes. Profilgruppen må ligge innenfor tilgangskonteksten til API-nøkkelen din. Påkrevd med mindre du sender den utdaterte profile_group_slug.
string
utdatert
Utdatert: bruk profile_group. Slug for profilgruppen. Kun små bokstaver, sifre, bindestreker og understreker.
string
E-postadresse for profilen. Hvis den utelates, genererer Aniva automatisk en e-postadresse.Å oppgi email gjør også opprettelsen trygg ved nye forsøk: en adresse kan bare ha én profil, så en gjentatt forespørsel returnerer 409 i stedet for en ny profil. Automatisk genererte adresser er unike per forespørsel. Send email eller en Idempotency-Key hvis integrasjonen din prøver på nytt.
string
Telefonnummer i E.164-format (f.eks. +14155552671).
number
Høyde i centimeter.
number
Vekt i kilogram.
string
standard:"en"
Foretrukket språk 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. Standardverdien er en.
boolean
Om denne profilen skal motta transaksjonelle (automatiske) e-poster — timebekreftelser, varsler om klare resultater osv. Overstyrer standarden for profilgruppen. Skilt fra samtykke til markedsføring. Utelat for å bruke standarden.
boolean
Om denne profilen samtykker til markedsførings-e-poster (nyhetsbrev, produktoppdateringer). Overstyrer standarden for profilgruppen. Skilt fra transaksjonelle e-poster. Utelat for å bruke standarden for profilgruppen. Kun skriving: returneres ikke i profilsvaret.

Testdata i sandkassen

Alle leseendepunkter som er verdt å teste — List opp timer, Hent resultater, Last ned dokument — er tomme helt til en faktisk blodprøvetaking skjer flere dager senere. Det gjør det upraktisk å skrive en automatisert integrasjonstest. Tre last_name-verdier er reservert for å løse dette. Opprett en profil med én av dem, så forhåndsutfyller Aniva tilstanden beskrevet nedenfor før det svarer, slik at neste kall allerede ser den: Samsvar skiller ikke mellom store og små bokstaver. Alle andre felter — inkludert date_of_birth og sex — lagres og brukes som normalt, så referanseområdene du får tilbake er de faktiske alders- og kjønnsspesifikke for profilen du opprettet. Timen bestilles på stedet Aniva Test, på et faktisk bestillbart tidspunkt minst fem dager fra nå (eller for fem dager siden for tidligere tilstander). Å opprette den sender ingen labbestilling og bestiller ikke bud.
Gi testprofiler en adresse du kontrollerer. Anivas timepåminnelser styres av scheduled_at, så testdataene for kommende time sender dem med mindre profilen er meldt av via transactional_emails_enabled: false.
Panelet velges tilfeldig blant dem API-nøkkelen din har tilgang til, så panel_id alltid kan slås opp mot din egen List opp paneler. Kliniske biomarkører får en verdi innenfor biomarkørens referanseområde; gener får en tilfeldig genotype fra Anivas referansedata, med tilhørende varianter, klinisk betydning og rs-ID-er som følger av den.
Panel og verdier genereres på nytt ved hver opprettelse, så verifiser struktur fremfor et bestemt panel eller eksakte tall.

Respons

Ved suksess returnerer API-et 201 Created med den nyopprettede profilen.
string
påkrevd
Unik profilidentifikator (UUID).
string
Profilnavn eller brukernavn. Kan være null.
string
Fornavn. Kan være null.
string
Etternavn. Kan være null.
string
E-postadresse. Kan være null.
string
Telefonnummer i E.164-format. Kan være null.
integer
Biologisk kjønn etter ISO/IEC 5218 (0 = ukjent, 1 = mann, 2 = kvinne). Kan være null.
string
Fødselsdato i formatet YYYY-MM-DD. Kan være null.
number
Høyde i centimeter. Kan være null.
number
Vekt i kilogram. Kan være null.
string
Foretrukket språk, en av de 32 kodene ovenfor.
boolean
Om denne profilen mottar transaksjonelle (programmatiske) e-poster. null når verdien aldri er satt.
string
ISO 8601-tidsstempel for når profilen ble opprettet.
string
ISO 8601-tidsstempel for siste oppdatering. null for nyopprettede profiler.

Feilresponser

En 409 ser slik ut – tolk den som at denne profilen allerede finnes, og slå den opp med List opp profiler (?email=) i stedet for å prøve å opprette den på nytt:
En person med samme fornavn, etternavn, kjønn og fødselsdato som en profil nøkkelen din har tilgang til, får 409 med error_name: "duplicate_profile_error". Bruk den returnerte profile_id i stedet for å opprette en ny profil:
Etternavnene i sandkassen som genererer testdata, er unntatt.