Vitals Scan Created

POST

Sent when a vitals scan is created, before the patient has taken it. The scan is PENDING and has no results yet.

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: vitalsScan.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 vitals scan and, once complete, its measured results.

object

id

required

Unique identifier across the Upvio platform.

string

businessId

required

The business this scan belongs to.

string

createdAt

required

ISO 8601 timestamp.

string format: date-time

updatedAt

required

ISO 8601 timestamp.

string format: date-time

startedAt

Any of:

string

ISO 8601 timestamp.

string format: date-time

null

null

statusUpdatedAt

Any of:

string

ISO 8601 timestamp.

string format: date-time

null

null

status

required

string

Allowed values: ABORTED FAILED PENDING STARTED SUCCEEDED

verificationMethod

Any of:

string

string

Allowed values: API EMAIL NONE

null

null

patientId

Any of:

string

Unique identifier across the Upvio platform.

string

null

null

vitalsLinkId

Any of:

string

Unique identifier across the Upvio platform.

string

null

null

includedMetrics

required

Array<string>

default:

results

Any of:

object

Measured metrics. Only the metrics listed in includedMetrics are populated.

object

metrics

required

object

heartRate

number | null

heartRateVariability

number | null

breathingRate

number | null

stressIndex

number | null

parasympatheticActivity

number | null

cardiacWorkload

number | null

bloodPressure

Any of:

object

object

diastolic

number | null

systolic

number | null

null

null

bloodPressureDiastolic

number | null

bloodPressureSystolic

number | null

bmiClassification

number | null

wellnessScore

number | null

vascularAge

number | null

atheroscleroticCvdRisk

number | null

cardiovascularEventRisk

number | null

cardiovascularRiskScore

number | null

hypertensionRisk

number | null

diabetesRisk

number | null

fattyLiverDiseaseRisk

number | null

waistToHeightRatio

number | null

bodyFatPercentage

number | null

bodyRoundnessIndex

number | null

aBodyShapeIndex

number | null

conicityIndex

number | null

basalMetabolicRate

number | null

totalDailyEnergyExpenditure

number | null

null

null

failureInfo

Any of:

object

object

key

additional properties

null

null

metadata

Any of:

object

object

key

additional properties

null

null

Responses

200

Return any 2xx status code to acknowledge the delivery.