Profilgrupper
När du skapar en profil tilldelar du den en profilgrupp med parameternprofile_group. En profilgrupp organiserar profiler under ditt partnerkonto och avgränsar dem till ett visst program eller en viss integration.
Fältet profile_group accepterar antingen gruppens oföränderliga UUID eller dess läsbara slug. UUID:t är den beständiga referensen – det ändras aldrig och överlever namnbyten av sluggen. Sluggen är avsedd för läsbara URL:er och partnerintegrationer.
Ett profile_group-värde (UUID eller slug) krävs när profilen skapas. Det äldre fältet profile_group_slug accepteras fortfarande som ett utfasat alias.
Fält
UUID som genereras automatiskt av Aniva. Använd detta för att referera till profilen i andra
API-anrop.
Patientens efternamn. Endast latinska tecken, 1–100 tecken. Krävs när profilen skapas –
laboratorier nekar beställningar för en patient utan efternamn. Kan vara null för profiler som
skapades innan det blev obligatoriskt.
Patientens e-postadress. Om du inte anger någon när profilen skapas genererar Aniva automatiskt en
platshållaradress.
Telefonnummer i E.164-format (t.ex.
+14155552671). Kan
vara null.Biologiskt kön enligt ISO/IEC 5218:
1 = man, 2 =
kvinna. Krävs när profilen skapas, om inte din profilgrupp låter patienten ange det själv (se
nedan). Laboratoriet behöver det för referensintervallen, så om du skapar eller uppdaterar med 0
(okänt) returneras 400. Profiler som skapades före 30 september 2026 kan fortfarande returnera
0.Födelsedatum i formatet
YYYY-MM-DD. Krävs när profilen skapas, om inte din profilgrupp låter
patienten ange det själv (se nedan). Måste ligga i det förflutna, inte före 1900, och motsvara en
ålder mellan 16 och 100; orimliga värden nekas med 400. Födelsedatumet skickas till laboratoriet
med beställningen och kan inte ändras när beställningen väl är lagd.Om profilen tar emot transaktionsmejl, som bokningsbekräftelser och aviseringar när resultat är
klara. Skilt från samtycke till marknadsföring. Null om det aldrig har angetts.
Fälten
first_name, last_name, sex, date_of_birth och profile_group krävs när du skapar
en profil. Alla andra fält är valfria. Det äldre fältet profile_group_slug accepteras
fortfarande som ett utfasat alias för profile_group.Låt patienten ange födelsedatum och kön
Vi kan aktivera en inställning för din profilgrupp. Då kan du skapa en profil utandate_of_birth
och sex. Be oss aktivera den. Utan den returnerar ett anrop som utelämnar något av fälten 400.
Patienten anger båda på sidan för kitaktivering (anivahealth.com/activate) tillsammans med
kitkoden. Sidan frågar efter födelsedatumet två gånger, eftersom laboratoriet inte kan ändra det
senare. Därefter kan kitet bara öppnas med det födelsedatumet. Tills patienten har angett båda
håller vi tillbaka laboratoriebeställningen. Använd bara den här inställningen för hemtestkit.
Livscykel
Profiler följer en enkel livscykel:- Skapa — registrera profilen med obligatoriska demografiska fält och en
profile_group(UUID eller slug). - Uppdatera (valfritt) — lägg till eller ändra fält som
phone,heightellerweight. - Koppla — koppla profilen till bokningar genom att använda dess
idsomprofile_id.
profile.*-webhook meddelar dig när en profil tillkommer, ändras eller tas bort.