Patient Created

POST

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

Authorizations

• apiKey

Request Body^required

Media typeapplication/json

object

id

required

Unique identifier for this event delivery.

string

name

required

The name of the event, in resource.action format.

string

Allowed value: patient.create

createdAt

required

When the event was recorded by Upvio.

string format: date-time

business

required

The business the event belongs to.

object

id

required

Unique identifier across the Upvio platform.

string

data

required

A patient record within a business.

object

id

required

Unique identifier across the Upvio platform.

string

businessId

required

The business this patient belongs to.

string

createdAt

required

ISO 8601 timestamp.

string format: date-time

updatedAt

required

ISO 8601 timestamp.

string format: date-time

archivedAt

Any of:

string

ISO 8601 timestamp.

string format: date-time

null

null

archivedReason

string | null

name

required

string

email

required

string

phoneMobile

string | null

timezone

string | null

preferredLanguage

Any of:

string

string

Allowed values: en es

null

null

dob

Date of birth in YYYY-MM-DD format.

string | null format: date

gender

string | null

biologicalSex

Any of:

string

string

Allowed values: FEMALE MALE OTHER

null

null

race

string | null

height

Height in cm.

number | null

weight

Weight in kg.

number | null

waistCircumference

number | null

neckCircumference

number | null

hipCircumference

number | null

activityLevel

Any of:

string

string

Allowed values: exercise10Mins exercise1to3Hours exercise20to60Mins exerciseOver3Hours inactive

null

null

smokingStatus

Any of:

string

string

Allowed values: current former never

null

null

diabetesStatus

Any of:

string

string

Allowed values: diabetes none preDiabetes

null

null

chronicMedicationStatus

Any of:

string

string

Allowed values: none oneOrTwoDiseases threeOrMoreDiseases

null

null

hypertensionTreatment

Any of:

string

string

Allowed values: no notNeeded yes

null

null

familyDiabetesHistory

Any of:

string

string

Allowed values: firstDegree none noneFirstDegree

null

null

parentalHypertensionHistory

Any of:

string

string

Allowed values: both none one

null

null

historyOfHighGlucose

boolean | null

historyOfHypertension

boolean | null

vegetableFruitDiet

boolean | null

cholesterol

number | null

cholesterolHdl

number | null

cholesterolLdl

number | null

fastingGlucose

number | null

triglyceride

number | null

Responses

200

Return any 2xx status code to acknowledge the delivery.