patient.create

Patient Created. Sent when a patient is added to a business, whether through the dashboard, the booking flow or the API.

Example

{
  "id": "ckq7v1w1k0008zqxk7g3l5n2q",
  "name": "patient.create",
  "createdAt": "2026-02-04T09:01:12.000Z",
  "business": {
    "id": "ckq7v1w1k0001zqxk3f8a9d4t"
  },
  "data": {
    "id": "ckq7v1w1k0004zqxk9j4h2g6r",
    "businessId": "ckq7v1w1k0001zqxk3f8a9d4t",
    "createdAt": "2026-01-30T11:00:00.000Z",
    "updatedAt": "2026-01-30T11:00:00.000Z",
    "archivedAt": null,
    "archivedReason": null,
    "name": "Jane Doe",
    "email": "[email protected]",
    "phoneMobile": "+15550100",
    "timezone": "America/New_York",
    "preferredLanguage": "en",
    "dob": "1988-04-12",
    "gender": "female",
    "biologicalSex": "FEMALE",
    "race": null,
    "height": 168,
    "weight": 64,
    "waistCircumference": null,
    "neckCircumference": null,
    "hipCircumference": null,
    "activityLevel": "exercise20to60Mins",
    "smokingStatus": "never",
    "diabetesStatus": "none",
    "chronicMedicationStatus": null,
    "hypertensionTreatment": null,
    "familyDiabetesHistory": null,
    "parentalHypertensionHistory": null,
    "historyOfHighGlucose": false,
    "historyOfHypertension": false,
    "vegetableFruitDiet": true,
    "cholesterol": null,
    "cholesterolHdl": null,
    "cholesterolLdl": null,
    "fastingGlucose": null,
    "triglyceride": null
  }
}

Data fields

Field	Type	Description
id	string	Unique identifier across the Upvio platform.
businessId	string	The business this patient belongs to.
createdAt	string	ISO 8601 timestamp.
updatedAt	string	ISO 8601 timestamp.
archivedAt	string | null | undefined	ISO 8601 timestamp.
archivedReason	string | null | undefined
name	string
email	string
phoneMobile	string | null | undefined
timezone	string | null | undefined
preferredLanguage	string | null | undefined	One of en, es.
dob	string | null | undefined	Date of birth in YYYY-MM-DD format.
gender	string | null | undefined
biologicalSex	string | null | undefined	One of FEMALE, MALE, OTHER.
race	string | null | undefined
height	number | null | undefined	Height in cm.
weight	number | null | undefined	Weight in kg.
waistCircumference	number | null | undefined
neckCircumference	number | null | undefined
hipCircumference	number | null | undefined
activityLevel	string | null | undefined	One of exercise10Mins, exercise1to3Hours, exercise20to60Mins, exerciseOver3Hours, inactive.
smokingStatus	string | null | undefined	One of current, former, never.
diabetesStatus	string | null | undefined	One of diabetes, none, preDiabetes.
chronicMedicationStatus	string | null | undefined	One of none, oneOrTwoDiseases, threeOrMoreDiseases.
hypertensionTreatment	string | null | undefined	One of no, notNeeded, yes.
familyDiabetesHistory	string | null | undefined	One of firstDegree, none, noneFirstDegree.
parentalHypertensionHistory	string | null | undefined	One of both, none, one.
historyOfHighGlucose	boolean | null | undefined
historyOfHypertension	boolean | null | undefined
vegetableFruitDiet	boolean | null | undefined
cholesterol	number | null | undefined
cholesterolHdl	number | null | undefined
cholesterolLdl	number | null | undefined
fastingGlucose	number | null | undefined
triglyceride	number | null | undefined