KHRecord

Types

data class ActiveCaloriesBurned(val unit: KHUnit.Energy, val value: Double, val startTime: Instant, val endTime: Instant) : KHRecord

Captures the estimated active energy burned by the user, excluding basal metabolic rate (BMR). Each record represents the total energy burned over a time interval, so both the start and end times should be set.

BasalMetabolicRate

data class BasalMetabolicRate(val unit: KHEither<KHUnit.Power, KHUnit.Energy>, val value: Double, val time: Instant) : KHRecord

Captures the BMR of a user. Each record represents the energy a user would burn if at rest all day, based on their height and weight.

BloodGlucose

data class BloodGlucose(val unit: KHUnit.BloodGlucose, val value: Double, val time: Instant) : KHRecord

Captures the concentration of glucose in the blood. Each record represents a single instantaneous blood glucose reading.

BloodPressure

data class BloodPressure(val unit: KHUnit.Pressure, val systolicValue: Double, val diastolicValue: Double, val time: Instant) : KHRecord

Captures the blood pressure of a user. Each record represents a single instantaneous blood pressure reading.

BodyFat

data class BodyFat(val percentage: Double, val time: Instant) : KHRecord

Captures the body fat percentage of a user. Each record represents a person's total body fat as a percentage of their total body mass.

BodyTemperature

data class BodyTemperature(val unit: KHUnit.Temperature, val value: Double, val time: Instant) : KHRecord

Captures the body temperature of a user. Each record represents a single instantaneous body temperature measurement.

BodyWaterMass

data class BodyWaterMass(val unit: KHUnit.Mass, val value: Double, val time: Instant) : KHRecord

Body water mass is the total amount of water in a person's body, typically comprising about 60% of their total body weight.

BoneMass

data class BoneMass(val unit: KHUnit.Mass, val value: Double, val time: Instant) : KHRecord

Bone mass is the total weight of bones in the body, reflecting the amount of bone tissue and its density.

CervicalMucus

data class CervicalMucus(val appearance: KHCervicalMucusAppearance, val time: Instant) : KHRecord

Cervical mucus is a fluid produced by the cervix that changes in consistency throughout the menstrual cycle, aiding in fertility and sperm transport.

CyclingPedalingCadence

data class CyclingPedalingCadence(val samples: List<KHCyclingPedalingCadenceSample>, val startTime: Instant, val endTime: Instant) : KHRecord

In cycling, cadence is a measure of rotational speed of the crank, expressed in revolutions per minute. In other words, it is the pedalling rate at which a cyclist is turning the pedals.

CyclingSpeed

data class CyclingSpeed(val samples: List<KHSpeedSample>) : KHRecord

Cycling speed is the rate at which a cyclist travels, usually measured in kilometers per hour (km/h) or miles per hour (mph).

Distance

data class Distance(val unit: KHUnit.Length, val value: Double, val startTime: Instant, val endTime: Instant) : KHRecord

Captures distance travelled by the user since the last reading. The total distance over an interval can be calculated by adding together all the values during the interval. The start time of each record should represent the start of the interval in which the distance was covered.

ElevationGained

data class ElevationGained(val unit: KHUnit.Length, val value: Double, val startTime: Instant, val endTime: Instant) : KHRecord

Captures the elevation gained by the user since the last reading.

FloorsClimbed

data class FloorsClimbed(val floors: Double, val startTime: Instant, val endTime: Instant) : KHRecord

Captures the number of floors climbed by the user since the last reading.

HeartRate

data class HeartRate(val samples: List<KHHeartRateSample>) : KHRecord

Captures the user's heart rate. Each record represents a series of measurements.

HeartRateVariability

data class HeartRateVariability(val heartRateVariabilityMillis: Double, val time: Instant) : KHRecord

Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences RMSSD on Android and Standard Deviation of NN intervals SDNN on Apple between normal heartbeats.

Height

data class Height(val unit: KHUnit.Length, val value: Double, val time: Instant) : KHRecord

Captures the user's height.

Hydration

data class Hydration(val unit: KHUnit.Volume, val value: Double, val startTime: Instant, val endTime: Instant) : KHRecord

Captures how much water a user drank in a single drink.

IntermenstrualBleeding

data class IntermenstrualBleeding(val time: Instant) : KHRecord

Captures an instance of user's intermenstrual bleeding, also known as spotting.

LeanBodyMass

data class LeanBodyMass(val unit: KHUnit.Mass, val value: Double, val time: Instant) : KHRecord

Captures the user's lean body mass. Each record represents a single instantaneous measurement.

MenstruationFlow

data class MenstruationFlow(val type: KHMenstruationFlowType, val time: Instant, val isStartOfCycle: Boolean = false) : KHRecord

Captures a description of how heavy a user's menstrual flow was (light, medium, or heavy). Each record represents a description of how heavy the user's menstrual bleeding was.

MenstruationPeriod

data class MenstruationPeriod(val startTime: Instant, val endTime: Instant) : KHRecord

Captures user's menstruation periods.

Nutrition

data class Nutrition(val name: String? = null, val startTime: Instant, val endTime: Instant, val solidUnit: KHUnit.Mass = KHUnit.Mass.Gram, val energyUnit: KHUnit.Energy = KHUnit.Energy.KiloCalorie, val mealType: KHMealType, val biotin: Double? = null, val caffeine: Double? = null, val calcium: Double? = null, val chloride: Double? = null, val cholesterol: Double? = null, val chromium: Double? = null, val copper: Double? = null, val dietaryFiber: Double? = null, val energy: Double? = null, val folicAcid: Double? = null, val iodine: Double? = null, val iron: Double? = null, val magnesium: Double? = null, val manganese: Double? = null, val molybdenum: Double? = null, val monounsaturatedFat: Double? = null, val niacin: Double? = null, val pantothenicAcid: Double? = null, val phosphorus: Double? = null, val polyunsaturatedFat: Double? = null, val potassium: Double? = null, val protein: Double? = null, val riboflavin: Double? = null, val saturatedFat: Double? = null, val selenium: Double? = null, val sodium: Double? = null, val sugar: Double? = null, val thiamin: Double? = null, val totalCarbohydrate: Double? = null, val totalFat: Double? = null, val vitaminA: Double? = null, val vitaminB12: Double? = null, val vitaminB6: Double? = null, val vitaminC: Double? = null, val vitaminD: Double? = null, val vitaminE: Double? = null, val vitaminK: Double? = null, val zinc: Double? = null) : KHRecord

Captures what nutrients were consumed as part of a meal or a food item.

OvulationTest

data class OvulationTest(val result: KHOvulationTestResult, val time: Instant) : KHRecord

Each record represents the result of an ovulation test.

OxygenSaturation

data class OxygenSaturation(val percentage: Double, val time: Instant) : KHRecord

Captures the amount of oxygen circulating in the blood, measured as a percentage of oxygen-saturated hemoglobin. Each record represents a single blood oxygen saturation reading at the time of measurement.

Power

data class Power(val samples: List<KHPowerSample>) : KHRecord

Captures the power generated by the user, e. g. during cycling or rowing with a power meter. Each record represents a series of measurements.

RespiratoryRate

data class RespiratoryRate(val rate: Double, val time: Instant) : KHRecord

Captures the user's respiratory rate. Each record represents a single instantaneous measurement.

RestingHeartRate

data class RestingHeartRate(val beatsPerMinute: Long, val time: Instant) : KHRecord

Captures the user's resting heart rate. Each record represents a single instantaneous measurement. These are typically measured after waking up and before getting out of bed.

RunningSpeed

data class RunningSpeed(val samples: List<KHSpeedSample>) : KHRecord

Running speed is the rate at which a person moves while running, typically measured in meters per second or kilometers per hour.

SexualActivity

data class SexualActivity(val didUseProtection: Boolean, val time: Instant) : KHRecord

Captures an occurrence of sexual activity. Each record is a single occurrence.

SleepSession

data class SleepSession(val samples: List<KHSleepStageSample>) : KHRecord

Captures the user's sleep length and its stages. Each record represents a time interval for a full sleep session.

Speed

data class Speed(val samples: List<KHSpeedSample>) : KHRecord

Captures the user's speed, e. g. during running or cycling. Each record represents a series of measurements.

StepCount

data class StepCount(val count: Long, val startTime: Instant, val endTime: Instant) : KHRecord

Captures the number of steps taken since the last reading. Each step is only reported once so records shouldn't have overlapping time. The start time of each record should represent the start of the interval in which steps were taken.

Vo2Max

data class Vo2Max(val vo2MillilitersPerMinuteKilogram: Double, val time: Instant) : KHRecord

VO2 max is the maximum amount of oxygen the body can utilize during intense exercise, indicating cardiovascular fitness and endurance capacity.

Weight

data class Weight(val unit: KHUnit.Mass, val value: Double, val time: Instant) : KHRecord

Captures the user's weight.

WheelChairPushes

data class WheelChairPushes(val count: Long, val startTime: Instant, val endTime: Instant) : KHRecord

Captures the number of wheelchair pushes done since the last reading. Each push is only reported once so records shouldn't have overlapping time. The start time of each record should represent the start of the interval in which pushes were made.

KHRecord

Inheritors

Types