Hoppa till huvudinnehåll
POST
Skapa en ny patientprofil och koppla den till en profilgrupp. Profilen innehåller demografiska uppgifter som används för bokningar och labbeställningar. Kräver scopet create_user. Skicka med en valfri Idempotency-Key-header så att anropet säkert kan upprepas – om samma nyckel skickas igen returneras det ursprungliga svaret i stället för att en andra bokning skapas. Se Idempotens.

Förfrågan

Body-parametrar

string
obligatorisk
Patientens förnamn. Måste använda latinska tecken, mellan 1 och 100 tecken.
string
obligatorisk
Patientens efternamn. Måste använda latinska tecken, mellan 1 och 100 tecken. Laboratorier avvisar beställningar för en patient utan efternamn, så en profil kan inte skapas utan det.Tre värden är reserverade för att skapa testfixturer — se Testfixturer för sandbox.
integer
obligatorisk
Biologiskt kön enligt ISO/IEC 5218. Använd 1 för man, 2 för kvinna. Laboratoriet behöver det för referensintervallen, så 0 (okänt) returnerar 400. Obligatoriskt, om inte din profilgrupp låter patienten ange det på sidan för aktivering av kitet. Utelämna det då. Se Låt patienten ange födelsedatum och kön.
string
obligatorisk
Födelsedatum i formatet YYYY-MM-DD. Måste ligga i det förflutna och inte före 1900. Den beräknade åldern måste vara mellan 16 och 100. Andra värden returnerar 400. Obligatoriskt, om inte din profilgrupp låter patienten ange det på sidan för aktivering av kitet. Utelämna det då.
string
obligatorisk
Polymorfisk referens (UUID eller slug) till profilgruppen som den här profilen ska kopplas till. UUID är den oföränderliga identifieraren och överlever namnbyten på sluggen; sluggen accepteras fortfarande för marknadsförings- och partnerintegrationer byggda på läsbara identifierare. UUID rekommenderas. Profilgruppen måste ligga inom din API-nyckels åtkomstkontext. Obligatoriskt om du inte skickar det utfasade profile_group_slug.
string
föråldrad
Utfasat: använd profile_group. Profilgruppens slug. Bara gemener, siffror, bindestreck och understreck.
string
E-postadress för profilen. Om den utelämnas genererar Aniva automatiskt en e-postadress.Om du anger email blir skapandet också säkert vid nya försök: en adress kan bara ha en profil, så en upprepad förfrågan returnerar 409 i stället för en andra profil. Automatiskt genererade adresser är unika per förfrågan. Skicka email eller en Idempotency-Key om din integration gör nya försök.
string
Telefonnummer i E.164-format (t.ex. +14155552671).
number
Längd i centimeter.
number
Vikt i kilogram.
string
standard:"en"
Föredraget språk för 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. Standardvärdet är en.
boolean
Om den här profilen ska få transaktionella (automatiska) e-postmeddelanden — bokningsbekräftelser, aviseringar om klara resultat osv. Åsidosätter profilgruppens standardinställning. Skilt från samtycke till marknadsföring. Utelämna för att använda standardinställningen.
boolean
Om den här profilen samtycker till marknadsföringsmejl (nyhetsbrev, produktuppdateringar). Åsidosätter profilgruppens standardinställning. Skilt från transaktionella e-postmeddelanden. Utelämna för att använda profilgruppens standardinställning. Endast skrivbart: returneras inte i profilsvaret.

Testfixturer för sandbox

Varje läsväg som är värd att testa — Lista bokningar, Hämta resultat, Ladda ner dokument — är tom tills en riktig blodprovstagning sker några dagar senare. Det gör det krångligt att skriva ett automatiserat integrationstest. Tre värden för last_name är reserverade för att lösa detta. Skapa en profil med ett av dem så fyller Aniva i förväg i tillståndet som beskrivs nedan innan svaret skickas, så att ditt nästa anrop redan ser det: Matchningen är skiftlägesokänslig. Alla andra fält — inklusive date_of_birth och sex — lagras och används som vanligt, så referensintervallen du får tillbaka är de riktiga ålders- och könsspecifika för den profil du skapade. Bokningen görs på platsen Aniva Test, på en riktig bokningsbar tid minst fem dagar från nu (eller för fem dagar sedan för tidigare tillstånd). Att skapa den lägger ingen labbeställning och bokar ingen kurir.
Ge testprofiler en adress du kontrollerar. Anivas bokningspåminnelser styrs av scheduled_at, så det kommande testfallet skickar dem om inte profilen stängt av dem via transactional_emails_enabled: false.
Panelen väljs slumpmässigt bland dem din API-nyckel kan se, så dess panel_id går alltid att slå upp mot din egen Lista paneler. Kliniska biomarkörer får ett värde inom biomarkörens referensintervall; gener får en slumpmässig genotyp från Anivas referensdata, med matchande varianter, klinisk betydelse och rs-id:n som följer av den.
Panel och värden genereras på nytt varje gång en profil skapas, så verifiera strukturen snarare än en specifik panel eller exakta siffror.

Svar

Vid lyckat anrop returnerar API:et 201 Created med den nyskapade profilen.
string
obligatorisk
Unikt profil-ID (UUID).
string
Alias eller användarnamn. Kan vara null.
string
Förnamn. Kan vara null.
string
Efternamn. Kan vara null.
string
E-postadress. Kan vara null.
string
Telefonnummer i E.164-format. Kan vara null.
integer
Biologiskt kön enligt ISO/IEC 5218 (0 = okänt, 1 = man, 2 = kvinna). Kan vara null.
string
Födelsedatum i formatet YYYY-MM-DD. Kan vara null.
number
Längd i centimeter. Kan vara null.
number
Vikt i kilogram. Kan vara null.
string
Föredraget språk, en av de 32 koderna ovan.
boolean
Om den här profilen tar emot transaktionella (programmatiska) e-postmeddelanden. null om värdet aldrig angetts.
string
ISO 8601-tidsstämpel för när profilen skapades.
string
ISO 8601-tidsstämpel för den senaste uppdateringen. null för nyskapade profiler.

Felsvar

En 409 ser ut så här — tolka det som “den här profilen finns redan” och slå upp den med Lista profiler (?email=) i stället för att försöka skapa den igen:
En person med samma förnamn, efternamn, kön och födelsedatum som en profil din nyckel kan se får en 409 med error_name: "duplicate_profile_error". Använd det returnerade profile_id i stället för att skapa en andra profil:
De efternamn i sandbox som skapar testdata är undantagna.