Passer au contenu principal
Un profil est un enregistrement représentant un patient ou un utilisateur dans le système Aniva. Chaque rendez-vous, commande de laboratoire et résultat est associé à un profil.

Groupes de profils

Lorsque tu crées un profil, tu l’affectes à un groupe de profils à l’aide du paramètre profile_group. Un groupe de profils organise les profils sous ton compte partenaire, en les rattachant à un programme ou à une intégration spécifique. Le champ profile_group accepte soit l’UUID immuable du groupe, soit son slug lisible. L’UUID est la référence durable — il ne change jamais et survit aux renommages de slug. Le slug est conçu pour des URL lisibles et les intégrations partenaires. Une valeur profile_group (UUID ou slug) est obligatoire à la création. L’ancien champ profile_group_slug reste accepté comme alias obsolète.

Champs

string
requis
UUID généré automatiquement par Aniva. Utilise-le pour référencer le profil dans d’autres appels API.
string
Un nom d’utilisateur ou identifiant facultatif pour le profil. Peut être null.
string
Prénom du patient. Caractères latins uniquement, 1 à 100 caractères. Obligatoire à la création.
string
Nom de famille du patient. Caractères latins uniquement, 1 à 100 caractères. Obligatoire à la création — les laboratoires rejettent les commandes pour un patient sans nom de famille. Peut être null sur les profils créés avant que ce champ ne devienne obligatoire.
string
Adresse e-mail du patient. Si tu n’en fournis pas à la création, Aniva génère automatiquement une adresse e-mail de substitution.
string
Numéro de téléphone au format E.164 (par ex. +14155552671). Peut être null.
integer
Sexe biologique selon la norme ISO/IEC 5218 : 1 = masculin, 2 = féminin. Obligatoire à la création, sauf si ton groupe de profils laisse le patient le saisir (voir ci-dessous). Le laboratoire en a besoin pour les intervalles de référence, une création ou mise à jour avec 0 (inconnu) renvoie donc 400. Les profils créés avant le 30 septembre 2026 peuvent encore renvoyer 0.
string
Date de naissance au format YYYY-MM-DD. Obligatoire à la création, sauf si ton groupe de profils laisse le patient la saisir (voir ci-dessous). Doit être dans le passé, pas avant 1900, et correspondre à un âge compris entre 16 et 100 ans ; les valeurs invraisemblables sont rejetées avec 400. La date de naissance est transmise au laboratoire avec la commande et ne peut plus être modifiée une fois la commande passée.
number
Taille en centimètres. Peut être null.
number
Poids en kilogrammes. Peut être null.
string
Langue préférée pour les communications destinées au patient. Valeurs acceptées : en, de, fi.
boolean
Indique si le profil reçoit les e-mails transactionnels, comme les confirmations de rendez-vous et les notifications de résultats disponibles. Distinct du consentement marketing. Null si jamais défini.
string
requis
Horodatage ISO 8601 de la création du profil.
string
Horodatage ISO 8601 de la dernière mise à jour. Null si le profil n’a jamais été mis à jour.
Les champs first_name, last_name, sex, date_of_birth et profile_group sont obligatoires lors de la création d’un profil. Tous les autres champs sont facultatifs. L’ancien champ profile_group_slug reste accepté comme alias obsolète de profile_group.

Laisser le patient saisir sa date de naissance et son sexe

Nous pouvons activer un paramètre pour ton groupe de profils. Tu peux alors créer un profil sans date_of_birth ni sex. Demande-nous de l’activer. Sans ce paramètre, une création qui omet l’un ou l’autre champ renvoie 400. Le patient saisit les deux sur la page d’activation du kit (anivahealth.com/activate), avec le code du kit. La page demande la date de naissance deux fois, car le laboratoire ne peut pas la modifier par la suite. Après cela, le kit ne s’ouvre qu’avec cette date de naissance. Tant que le patient n’a pas saisi les deux, nous retenons la commande de laboratoire. Utilise ce paramètre uniquement pour les kits à domicile.

Cycle de vie

Les profils suivent un cycle de vie simple :
  1. Créer — enregistrer le profil avec les champs démographiques requis et un profile_group (UUID ou slug).
  2. Mettre à jour (facultatif) — ajouter ou modifier des champs comme phone, height ou weight.
  3. Associer — lier le profil aux rendez-vous en utilisant son id comme profile_id.
Un webhook profile.* t’indique quand un profil apparaît, change ou est supprimé.

Exemple de profil