Skip to main content
A profile is a record representing a patient or user in the Aniva system. Every appointment, lab order, and result is associated with a profile.

​
Profile groups

When you create a profile, you assign it to a profile group using the profile_group_slug parameter. A profile group organizes profiles under your partner account, scoping them to a specific program or integration. The profile_group_slug is required at creation.

​
Fields

​
id
string
required
UUID auto-generated by Aniva. Use this to reference the profile in other API calls.
​
handle
string
An optional username or handle for the profile. May be null.
​
first_name
string
Patient’s first name. Latin characters only, 1–100 characters. Required at creation.
​
last_name
string
Patient’s last name. Latin characters only, 1–100 characters. May be null.
​
email
string
Patient’s email address. If you do not provide one at creation, Aniva auto-generates a placeholder email.
​
phone
string
Phone number in E.164 format (e.g., +14155552671). May be null.
​
sex
integer
Biological sex per ISO/IEC 5218: 1 = male, 2 = female. Required at creation.
​
date_of_birth
string
Date of birth in YYYY-MM-DD format. Must be a date in the past. Required at creation.
​
height
number
Height in centimeters. May be null.
​
weight
number
Weight in kilograms. May be null.
​
language
string
Preferred language for patient-facing communications. Accepted values: en, de, fi.
​
created_at
string
required
ISO 8601 timestamp of when the profile was created.
​
updated_at
string
ISO 8601 timestamp of the most recent update. Null if the profile has never been updated.
The first_name, sex, date_of_birth, and profile_group_slug fields are required when creating a profile. All other fields are optional.

​
Lifecycle

Profiles follow a simple lifecycle:
  1. Create — register the profile with required demographic fields and a profile_group_slug.
  2. Update (optional) — add or change fields such as phone, height, or weight.
  3. Associate — link the profile to appointments using its id as the profile_id.

​
Example profile

{
  "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",
  "created_at": "2026-03-01T09:00:00Z",
  "updated_at": "2026-03-10T14:32:00Z"
}