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 parameter. A profile group organizes profiles under your partner account, scoping them to a specific program or integration. The profile_group field accepts either the group’s immutable UUID or its human-readable slug. The UUID is the durable reference — it never changes and survives slug renames. The slug is intended for readable URLs and partner integrations. A profile_group value (UUID or slug) is required at creation. The legacy profile_group_slug field remains accepted as a deprecated alias.

​
Fields

​
string
required
UUID auto-generated by Aniva. Use this to reference the profile in other API calls.
​
string
An optional username or handle for the profile. May be null.
​
string
Patient’s first name. Latin characters only, 1–100 characters. Required at creation.
​
string
Patient’s last name. Latin characters only, 1–100 characters. May be null.
​
string
Patient’s email address. If you do not provide one at creation, Aniva auto-generates a placeholder email.
​
string
Phone number in E.164 format (e.g., +14155552671). May be null.
​
integer
Biological sex per ISO/IEC 5218: 0 = unknown, 1 = male, 2 = female. Required at creation.
​
string
Date of birth in YYYY-MM-DD format. Must be a date in the past. Required at creation.
​
number
Height in centimeters. May be null.
​
number
Weight in kilograms. May be null.
​
string
Preferred language for patient-facing communications. Accepted values: en, de, fi.
​
string
required
ISO 8601 timestamp of when the profile was created.
​
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 fields are required when creating a profile. All other fields are optional. The legacy profile_group_slug field is still accepted as a deprecated alias for profile_group.

​
Lifecycle

Profiles follow a simple lifecycle:
  1. Create — register the profile with required demographic fields and a profile_group (UUID or 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