Passer au contenu principal
POST
Créer un nouveau profil patient et l’assigner à un groupe de profils. Le profil contient les données démographiques utilisées pour les rendez-vous et les commandes de laboratoire. Nécessite le scope create_user. Envoie un en-tête facultatif Idempotency-Key pour pouvoir relancer cette création sans risque — répéter la même clé renvoie la réponse d’origine au lieu d’en créer un second. Voir Idempotence.

Requête

Paramètres du corps

string
requis
Prénom du patient. Doit utiliser des caractères latins, entre 1 et 100 caractères.
string
requis
Nom de famille du patient. Doit utiliser des caractères latins, entre 1 et 100 caractères. Les laboratoires rejettent les commandes pour un patient sans nom de famille, un profil ne peut donc pas être créé sans nom de famille.Trois valeurs sont réservées pour initialiser des jeux de test — voir Jeux de test sandbox.
integer
requis
Sexe biologique selon la norme ISO/IEC 5218. Utilise 1 pour masculin, 2 pour féminin. Le laboratoire en a besoin pour les intervalles de référence, donc 0 (inconnu) renvoie 400. Obligatoire, sauf si ton groupe de profils laisse le patient le saisir sur la page d’activation du kit. Dans ce cas, omets-le. Voir Laisser le patient saisir sa date de naissance et son sexe.
string
requis
Date de naissance au format YYYY-MM-DD. Doit être dans le passé et pas avant 1900. L’âge correspondant doit être compris entre 16 et 100 ans. Les autres valeurs renvoient 400. Obligatoire, sauf si ton groupe de profils laisse le patient la saisir sur la page d’activation du kit. Dans ce cas, omets-la.
string
requis
Référence polymorphe (UUID ou slug) vers le groupe de profils auquel assigner ce profil. L’UUID est l’identifiant immuable et survit aux renommages de slug ; le slug reste accepté pour les intégrations marketing et partenaires basées sur des identifiants lisibles. L’UUID est recommandé. Le groupe de profils doit faire partie du contexte d’accès de ta clé API. Obligatoire, sauf si tu envoies le champ obsolète profile_group_slug.
string
obsolète
Obsolète : utilise profile_group. Slug du groupe de profils. Lettres minuscules, chiffres, tirets et tirets bas uniquement.
string
Adresse e-mail du profil. Si elle est omise, Aniva génère automatiquement une adresse e-mail.Fournir email rend aussi la création sûre en cas de nouvelle tentative : une adresse ne peut jamais avoir qu’un seul profil, donc une requête répétée renvoie 409 au lieu d’un second profil. Les adresses générées automatiquement sont uniques pour chaque requête. Envoie email ou un Idempotency-Key si ton intégration réessaie.
string
Numéro de téléphone au format E.164 (par ex., +14155552671).
number
Taille en centimètres.
number
Poids en kilogrammes.
string
défaut:"en"
Langue préférée du profil : 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 ou uk. Par défaut : en.
boolean
Indique si ce profil doit recevoir les e-mails transactionnels (programmatiques) — confirmations de rendez-vous, notifications de résultats disponibles, etc. Remplace la valeur par défaut du groupe de profils. Distinct du consentement marketing. Omets ce champ pour utiliser la valeur par défaut.
boolean
Indique si ce profil accepte les e-mails marketing (newsletters, actualités produit). Remplace la valeur par défaut du groupe de profils. Distinct des e-mails transactionnels. Omets ce champ pour utiliser la valeur par défaut du groupe de profils. Écriture seule : non renvoyé dans la réponse du profil.

Jeux de test sandbox

Chaque chemin de lecture utile à tester — Lister les rendez-vous, Obtenir les résultats, Télécharger un document — reste vide tant qu’une vraie prise de sang n’a pas eu lieu plusieurs jours plus tard. Cela rend un test d’intégration automatisé peu pratique à écrire. Trois valeurs de last_name sont réservées pour régler cela. Crée un profil avec l’une d’elles et Aniva préremplit l’état décrit ci-dessous avant de répondre, afin que ton appel suivant le voie déjà : La correspondance ne tient pas compte de la casse. Tous les autres champs — y compris date_of_birth et sex — sont enregistrés et utilisés normalement, de sorte que les intervalles de référence renvoyés correspondent bien à l’âge et au sexe du profil que tu as créé. Le rendez-vous est réservé sur le site Aniva Test, sur un vrai créneau disponible dans au moins cinq jours (ou il y a cinq jours, pour les états passés). Son initialisation ne passe aucune commande au laboratoire et ne réserve aucun coursier.
Donne aux profils de test une adresse que tu contrôles. Les rappels de rendez-vous d’Aniva s’appuient sur scheduled_at, donc la fixture à venir les enverra sauf si le profil est désinscrit via transactional_emails_enabled: false.
Le panel est choisi au hasard parmi ceux que ta clé API peut voir, donc son panel_id correspond toujours à un résultat de ton propre Lister les panels. Les biomarqueurs cliniques reçoivent une valeur comprise dans leur intervalle de référence ; les gènes reçoivent un génotype aléatoire issu des données de référence d’Aniva, avec les variants, la signification clinique et les identifiants rs correspondants qui en découlent.
Le panel et les valeurs sont régénérés à chaque création, vérifie donc la structure plutôt qu’un panel précis ou des nombres exacts.

Réponse

En cas de succès, l’API renvoie 201 Created avec le profil nouvellement créé.
string
requis
Identifiant unique du profil (UUID).
string
Pseudonyme ou nom d’utilisateur du profil. Peut être null.
string
Prénom. Peut être null.
string
Nom de famille. Peut être null.
string
Adresse e-mail. Peut être null.
string
Numéro de téléphone au format E.164. Peut être null.
integer
Sexe biologique selon la norme ISO/IEC 5218 (0 = inconnu, 1 = masculin, 2 = féminin). Peut être null.
string
Date de naissance au format YYYY-MM-DD. Peut être null.
number
Taille en centimètres. Peut être null.
number
Poids en kilogrammes. Peut être null.
string
Langue préférée, parmi les 32 codes ci-dessus.
boolean
Indique si ce profil reçoit des e-mails transactionnels (automatiques). null si jamais défini.
string
Horodatage ISO 8601 de création du profil.
string
Horodatage ISO 8601 de la dernière mise à jour. null pour les profils nouvellement créés.

Réponses d’erreur

Une réponse 409 ressemble à ceci — traite-la comme « ce profil existe déjà » et recherche le profil avec Lister les profils (?email=) plutôt que de relancer la création :
Une personne ayant les mêmes prénom, nom de famille, sexe et date de naissance qu’un profil visible par ta clé reçoit une réponse 409 avec error_name: "duplicate_profile_error". Utilise le profile_id renvoyé au lieu de créer un second profil :
Les noms de famille de la sandbox qui initialisent les données de test sont exemptés.