> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Profils

> Fonctionnement des profils patients dans l'API partenaire Aniva : créer, mettre à jour et associer les personnes pour qui tu réserves des bilans sanguins et des kits à domicile.

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

**id** `string` *required*

UUID généré automatiquement par Aniva. Utilise-le pour référencer le profil dans d'autres appels
API.

**handle** `string`

Un nom d'utilisateur ou identifiant facultatif pour le profil. Peut être null.

**first\_name** `string`

Prénom du patient. Caractères latins uniquement, 1 à 100 caractères. Obligatoire à la création.

**last\_name** `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.

**email** `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.

**phone** `string`

Numéro de téléphone au [format E.164](https://www.itu.int/rec/T-REC-E.164/en) (par ex.
`+14155552671`). Peut être null.

**sex** `integer`

Sexe biologique selon la norme [ISO/IEC 5218](https://www.iso.org/standard/36266.html) : `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`.

**date\_of\_birth** `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.

**height** `number`

Taille en centimètres. Peut être null.

**weight** `number`

Poids en kilogrammes. Peut être null.

**language** `string`

Langue préférée pour les communications destinées au patient. Valeurs acceptées : `en`, `de`,
`fi`.

**transactional\_emails\_enabled** `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.

**created\_at** `string` *required*

Horodatage ISO 8601 de la création du profil.

**updated\_at** `string`

Horodatage ISO 8601 de la dernière mise à jour. Null si le profil n'a jamais été mis à jour.

> [!NOTE]
>
> 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](https://docs.anivahealth.com/fr/concepts/webhooks.md) `profile.*` t'indique quand un profil apparaît, change ou est supprimé.

## Exemple de profil

```json theme={null}
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "handle": "jdoe42",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane.doe@example.com",
  "phone": "+14155552671",
  "sex": 2,
  "date_of_birth": "1990-06-15",
  "height": 168.0,
  "weight": 65.0,
  "language": "en",
  "transactional_emails_enabled": true,
  "created_at": "2026-03-01T09:00:00Z",
  "updated_at": "2026-03-10T14:32:00Z"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.