HealthBox

View Metrics

Validation

This is a description of each validation rule supported by HealthBox.

Metrics

This is a comprehensive list of all metrics supported by this HealthBox instance.

physical

steps

  • Description: The number of steps taken over a given interval
  • Keys: 3
    • steps_count: int (required)
    • start_time: start_time (required)
    • end_time: end_time (required)

active_calories

  • Description: Calories burned above the resting baseline over a given interval
  • Keys: 3
    • calories: float (required)
    • start_time: start_time (required)
    • end_time: end_time (required)

resting_calories

  • Description: How much energy is burned while resting over a given interval
  • Keys: 3
    • calories: float (required)
    • start_time: start_time (required)
    • end_time: end_time (required)

distance_pedestrian

  • Description: Kilometers traveled through walking, running, or otherwise on foot
  • Keys: 3
    • distance: float (required)
    • start_time: start_time (required)
    • end_time: end_time (required)

distance_wheelchair

  • Description: Kilometers traveled by manual wheel chair movement
  • Keys: 4
    • distance: float (required)
    • start_time: start_time (required)
    • end_time: end_time (required)
    • vehicleid: short_string

distance_cycling_manual

  • Description: Kilometers traveled by manual bicycle pedaling
  • Keys: 4
    • distance: float (required)
    • start_time: start_time (required)
    • end_time: end_time (required)
    • vehicleid: short_string

distance_cycling_assisted

  • Description: Kilometers traveled by bicycle with powered assistance
  • Keys: 5
    • distance: float (required)
    • start_time: start_time (required)
    • end_time: end_time (required)
    • assistance_level: short_string
    • vehicleid: short_string

distance_vehicle

  • Description: Kilometers traveled by motor vehicle
  • Keys: 4
    • distance: float (required)
    • start_time: start_time (required)
    • end_time: end_time (required)
    • vehicleid: short_string

minutes_active

  • Description: Minutes that are spent moving around, being active
  • Keys: 2
    • start_time: start_time (required)
    • end_time: end_time (required)

minutes_resting

  • Description: Minutes that are spent dormant, not being active
  • Keys: 2
    • start_time: start_time (required)
    • end_time: end_time (required)

minutes_standing

  • Description: Minutes spent standing
  • Keys: 2
    • start_time: start_time (required)
    • end_time: end_time (required)

minutes_sitting

  • Description: Minutes spent sitting
  • Keys: 2
    • start_time: start_time (required)
    • end_time: end_time (required)

wheelchair_pushes

  • Description: How many times the wheels on a wheelchair are pushed
  • Keys: 3
    • pushes: int (required)
    • start_time: start_time (required)
    • end_time: end_time (required)

food

  • Description: Consuming an amount of a given food
  • Keys: 4
    • servings: float (required)
    • time: datetime
    • mealid: mealid (required)
    • foodid: foodid (required)

sport

  • Description: A physical sport played, usually competitively
  • Keys: 3
    • sport_name: short_string (required)
    • start_time: start_time (required)
    • end_time: end_time (required)

mental

phq9

  • Description: PHQ-9 scores can be an indicator of depression, and its severity
  • Keys: 2
    • score: int (required)
    • time: datetime (required)

ybocs

  • Description: Y-BOCS scores can be an indicator of obessive-compulsive disorder, and its severity
  • Keys: 2
    • score: int (required)
    • time: datetime (required)

gad7

  • Description: GAD-7 scores can be an indicator of anxiety, and its severity
  • Keys: 2
    • score: int (required)
    • time: datetime (required)

mdq

  • Description: MDQ scores can be an indicator of bipolar disorder, and its severity
  • Keys: 2
    • score: int (required)
    • time: datetime (required)

asrs

  • Description: ASRS scores can be an indicator of ADHD, and its severity
  • Keys: 2
    • score: int (required)
    • time: datetime (required)

mindful_minutes

  • Description: Minutes spent being mindful of thoughts, emotions, and feelings
  • Keys: 3
    • type_of_mindfulness: short_string (required)
    • start_time: start_time (required)
    • end_time: end_time (required)

addictive_behavior

  • Description: Harmful behavior performed compulsively
  • Keys: 2
    • name: short_string (required)
    • severity: float

mood

  • Description: The current mood at a point in time, quantified as a whole number between -5 and 5, ranging from negative to positive emotional state
  • Keys: 2
    • mood: mood (required)
    • time: datetime (required)

emotion

  • Description: An emotion experienced at a point in time
  • Keys: 2
    • emotion: short_string (required)
    • time: datetime (required)

sexual_activity

  • Description: Sexual activity with a partner
  • Keys: 2
    • safe: boolean
    • time: datetime (required)

measurements

weight

  • Description: Total body weight in kilograms
  • Keys: 2
    • measurement: float (required)
    • time: datetime (required)

height

  • Description: Total height when standing straight upright in centimeters
  • Keys: 2
    • measurement: float (required)
    • time: datetime (required)

sex

  • Description: Genetic sex as identified at birth
  • Keys: 1
    • sex: sex (required)

gender

  • Description: Gender as defined by which gender one identifies with
  • Keys: 1
    • gender: short_string (required)

sexuality

  • Description: Sexual orientation
  • Keys: 1
    • sexuality: sexuality (required)

body_temperature

  • Description: Measure of the temperature of the body in celcius
  • Keys: 2
    • temperature: measurement (required)
    • time: datetime (required)

electrodermal_activity

  • Description: Electrodermal activity serves as an indicator of how much sweat is on the skin
  • Keys: 2
    • measurement: float (required)
    • time: datetime (required)

circumference_bust

  • Description: The measurement of the circumference of the chest at the widest point in centimeters
  • Keys: 2
    • measurement: float (required)
    • time: datetime (required)

circumference_waist

  • Description: The measurement of the circumference of the waist at the narrowest point in centimeters
  • Keys: 2
    • measurement: float (required)
    • time: datetime (required)

circumference_hips

  • Description: The measurement of the circumference of the hips at the widest point in centimeters
  • Keys: 2
    • measurement: float (required)
    • time: datetime (required)

breathing_rate

  • Description: Rate of breathing measured in breaths per second
  • Keys: 2
    • measurement: float (required)
    • time: datetime (required)

lung_capacity

  • Description: How much air the lungs are capable of holding in liters
  • Keys: 2
    • measurement: float (required)
    • time: datetime (required)

oxygen_saturation

  • Description: Percentage of oxygen in present in the blood
  • Keys: 2
    • measurement: percentage (required)
    • time: datetime (required)

heartrate

  • Description: How many times per minute the heart beats
  • Keys: 2
    • measurement: int (required)
    • time: datetime (required)

heartrate_resting

  • Description: Heart rate, measured while sitting, and inactive
  • Keys: 2
    • measurement: int (required)
    • time: datetime (required)

heartrate_walking

  • Description: Heart rate, measured at a steady walking pace
  • Keys: 2
    • measurement: int (required)
    • time: datetime (required)

heartrate_running

  • Description: Heart race, measured at a steady run
  • Keys: 2
    • measurement: int (required)
    • time: datetime (required)

heartrate_variability

  • Description: Variation in the time interval between heart beats in milliseconds
  • Keys: 2
    • measurement: int (required)
    • time: datetime (required)

vo2_max

  • Description: The maximum amount of oxygen burned while exercising, measured in mL/(kg*min)
  • Keys: 2
    • measurement: float (required)
    • time: datetime (required)

ailments

  • Description: A record of injuries and illnesses, both mental and physical
  • Keys: 3
    • ailment: long_string (required)
    • start_time: start_time (required)
    • end_time: end_time (required)

blood_pressure

  • Description: The pressure at which blood pushes against the walls of the arteries
  • Keys: 3
    • systolic: int
    • diastolic: int
    • time: datetime (required)

blood_sugar

  • Description: The amount of glucose in the blood
  • Keys: 2
    • measurement: int (required)
    • time: datetime (required)

blood_alcohol_content

  • Description: The amount of alcohol in the blood
  • Keys: 2
    • measurement: float (required)
    • time: datetime (required)

sound_exposure

  • Description: Periods of time exposed to sounds of a certain volume
  • Keys: 3
    • decibles: int (required)
    • start_time: start_time (required)
    • end_time: end_time (required)

sleep

  • Description: Record of periods of sleep in its various stages
  • Keys: 3
    • sleep_stage: short_string
    • start_time: start_time (required)
    • end_time: end_time (required)

times_fallen

  • Description: Times unintentionally fallen, with or without injury
  • Keys: 1
    • time: datetime (required)

atypical_pulse

  • Description: A record of occasions on which heart rate was atypically fast or slow
  • Keys: 2
    • measurement: float (required)
    • time: datetime (required)

audiogram

  • Description: A test used to determine how loud a sound has to be to be heard
  • Keys: 3
    • decibles: int (required)
    • side: side (required)
    • time: datetime (required)