Health Connect stores and structures both health and fitness data and medical records data. It's important to understand first what data types and permissions Health Connect offers so that you can plan your app's requirements.
After development, when you prepare to publish your app to the Play Store, you must declare your app's data use as well as declare access to the Health Connect data types that your app uses. Otherwise, users might be prompted with an error message where your app can't access the Health Connect data types because they require special approval.
See Complete the health apps declaration in the Play Console for more information.
Data type categories
Health Connect supports data types that are used across most health and fitness apps to provide as much variety as possible. Health Connect aims to offer a comprehensive view and storage of health and fitness data. These data types fall into the following categories:
| Category | Description | |
|---|---|---|
| directions_run | Activity | This captures any activity that a user does. It can include health and fitness activities like running and swimming. |
| straighten | Body Measurement | This captures common data related to the body, such as a user's weight and their basal metabolic rate. |
| fertile | Cycle Tracking | This captures menstrual cycles and related data points, such as the binary result of an ovulation test. |
| grocery | Nutrition | This captures hydration and nutrition data types. The former represents how much water a user consume in a single drink. The latter includes optional fields such as calories, sugar, and magnesium. |
| sleep_auto | Sleep | This captures interval data related to a user's length and type of sleep. |
| vital_signs | Vitals | This captures essential information about the user's general health. It includes data such as body temperature, blood glucose, blood pressure, and blood oxygen saturation. |
| mindfulness | Wellness | This captures data related to a user's mental health and well-being. |
Health and fitness data types
Before requesting any permissions, your app must declare them in the manifest. See the Declare permissions section of the Quick start guide for more information.
To read data while your app is in the background, or to read historical data, an additional set of read permissions must be declared separately from data type permissions:
| Additional read permission | Permission declaration |
|---|---|
|
Read data in background
Background read example guide |
android.permission.health.READ_HEALTH_DATA_IN_BACKGROUND |
|
Read historical data
Read data older than 30 days guide |
android.permission.health.READ_HEALTH_DATA_HISTORY |
1. Select a Jetpack version
Permission declarations differ between Jetpack versions, make sure to the select the Jetpack version range your app uses.
2. Filter the data types table
The following table contains the full list of data types, each with category, feature flags and guides, and permission declarations.
| Data type Feature guides |
Category | Record type Permission declarations Feature flag |
|---|---|---|
| Active calories burned |
Activity |
ActiveCaloriesBurnedRecordandroid.permission.health.READ_ACTIVE_CALORIES_BURNED android.permission.health.WRITE_ACTIVE_CALORIES_BURNED |
| Activity intensity |
Activity |
ActivityIntensityRecordandroid.permission.health.READ_ACTIVITY_INTENSITY android.permission.health.WRITE_ACTIVITY_INTENSITY FEATURE_ACTIVITY_INTENSITY |
| Basal body temperature |
Cycle Tracking |
BasalBodyTemperatureRecordandroid.permission.health.READ_BASAL_BODY_TEMPERATURE android.permission.health.WRITE_BASAL_BODY_TEMPERATURE |
| Basal metabolic rate |
Body Measurement |
BasalMetabolicRateRecordandroid.permission.health.READ_BASAL_METABOLIC_RATE android.permission.health.WRITE_BASAL_METABOLIC_RATE |
| Blood glucose |
Vitals |
BloodGlucoseRecordandroid.permission.health.READ_BLOOD_GLUCOSE android.permission.health.WRITE_BLOOD_GLUCOSE |
| Blood pressure |
Vitals |
BloodPressureRecordandroid.permission.health.READ_BLOOD_PRESSURE android.permission.health.WRITE_BLOOD_PRESSURE |
| Body fat |
Body Measurement |
BodyFatRecordandroid.permission.health.READ_BODY_FAT android.permission.health.WRITE_BODY_FAT |
| Body temperature |
Vitals |
BodyTemperatureRecordandroid.permission.health.READ_BODY_TEMPERATURE android.permission.health.WRITE_BODY_TEMPERATURE |
| Body water mass |
Body Measurement |
BodyWaterMassRecordandroid.permission.health.READ_BODY_WATER_MASS android.permission.health.WRITE_BODY_WATER_MASS |
| Bone mass |
Body Measurement |
BoneMassRecordandroid.permission.health.READ_BONE_MASS android.permission.health.WRITE_BONE_MASS |
| Cervical mucus |
Cycle Tracking |
CervicalMucusRecordandroid.permission.health.READ_CERVICAL_MUCUS android.permission.health.WRITE_CERVICAL_MUCUS |
| Cycling pedaling cadence |
Activity |
CyclingPedalingCadenceRecordandroid.permission.health.READ_EXERCISE android.permission.health.WRITE_EXERCISE |
| Distance |
Activity |
DistanceRecordandroid.permission.health.READ_DISTANCE android.permission.health.WRITE_DISTANCE |
| Elevation gained |
Activity |
ElevationGainedRecordandroid.permission.health.READ_ELEVATION_GAINED android.permission.health.WRITE_ELEVATION_GAINED |
| Exercise Add exercise routes guide |
Activity |
ExerciseSessionRecordandroid.permission.health.READ_EXERCISE android.permission.health.READ_EXERCISE_ROUTE android.permission.health.WRITE_EXERCISE android.permission.health.WRITE_EXERCISE_ROUTE Exercise typesView all exercise typesEXERCISE_TYPE_UNKNOWNEXERCISE_TYPE_BADMINTONEXERCISE_TYPE_BASEBALLEXERCISE_TYPE_BASKETBALLEXERCISE_TYPE_BIKINGEXERCISE_TYPE_BIKING_STATIONARYEXERCISE_TYPE_BOOT_CAMPEXERCISE_TYPE_BOXINGEXERCISE_TYPE_CALISTHENICSEXERCISE_TYPE_CRICKETEXERCISE_TYPE_DANCINGEXERCISE_TYPE_ELLIPTICALEXERCISE_TYPE_EXERCISE_CLASSEXERCISE_TYPE_FENCINGEXERCISE_TYPE_FOOTBALL_AMERICANEXERCISE_TYPE_FOOTBALL_AUSTRALIANEXERCISE_TYPE_FRISBEE_DISCEXERCISE_TYPE_GOLFEXERCISE_TYPE_GUIDED_BREATHINGEXERCISE_TYPE_GYMNASTICSEXERCISE_TYPE_HANDBALLEXERCISE_TYPE_HIGH_INTENSITY_INTERVAL_TRAININGEXERCISE_TYPE_HIKINGEXERCISE_TYPE_ICE_HOCKEYEXERCISE_TYPE_ICE_SKATINGEXERCISE_TYPE_MARTIAL_ARTSEXERCISE_TYPE_PADDLINGEXERCISE_TYPE_PARAGLIDINGEXERCISE_TYPE_PILATESEXERCISE_TYPE_RACQUETBALLEXERCISE_TYPE_ROCK_CLIMBINGEXERCISE_TYPE_ROLLER_HOCKEYEXERCISE_TYPE_ROWINGEXERCISE_TYPE_ROWING_MACHINEEXERCISE_TYPE_RUGBYEXERCISE_TYPE_RUNNINGEXERCISE_TYPE_RUNNING_TREADMILLEXERCISE_TYPE_SAILINGEXERCISE_TYPE_SCUBA_DIVINGEXERCISE_TYPE_SKATINGEXERCISE_TYPE_SKIINGEXERCISE_TYPE_SNOWBOARDINGEXERCISE_TYPE_SNOWSHOEINGEXERCISE_TYPE_SOCCEREXERCISE_TYPE_SOFTBALLEXERCISE_TYPE_SQUASHEXERCISE_TYPE_STAIR_CLIMBINGEXERCISE_TYPE_STAIR_CLIMBING_MACHINEEXERCISE_TYPE_STRENGTH_TRAININGEXERCISE_TYPE_STRETCHINGEXERCISE_TYPE_SURFINGEXERCISE_TYPE_SWIMMING_OPEN_WATEREXERCISE_TYPE_SWIMMING_POOLEXERCISE_TYPE_TABLE_TENNISEXERCISE_TYPE_TENNISEXERCISE_TYPE_VOLLEYBALLEXERCISE_TYPE_WALKINGEXERCISE_TYPE_WATER_POLOEXERCISE_TYPE_WEIGHTLIFTINGEXERCISE_TYPE_WHEELCHAIREXERCISE_TYPE_OTHER_WORKOUTEXERCISE_TYPE_YOGA |
| Floors climbed |
Activity |
FloorsClimbedRecordandroid.permission.health.READ_FLOORS_CLIMBED android.permission.health.WRITE_FLOORS_CLIMBED |
| Heart rate |
Vitals |
HeartRateRecordandroid.permission.health.READ_HEART_RATE android.permission.health.WRITE_HEART_RATE |
| Heart rate variability |
Vitals |
HeartRateVariabilityRmssdRecordandroid.permission.health.READ_HEART_RATE_VARIABILITY android.permission.health.WRITE_HEART_RATE_VARIABILITY |
| Height |
Body Measurement |
HeightRecordandroid.permission.health.READ_HEIGHT android.permission.health.WRITE_HEIGHT |
| Hydration |
Nutrition |
HydrationRecordandroid.permission.health.READ_HYDRATION android.permission.health.WRITE_HYDRATION |
| Intermenstrual bleeding |
Cycle Tracking |
IntermenstrualBleedingRecordandroid.permission.health.READ_INTERMENSTRUAL_BLEEDING android.permission.health.WRITE_INTERMENSTRUAL_BLEEDING |
| Lean body mass |
Body Measurement |
LeanBodyMassRecordandroid.permission.health.READ_LEAN_BODY_MASS android.permission.health.WRITE_LEAN_BODY_MASS |
| Menstruation |
Cycle Tracking |
MenstruationFlowRecordMenstruationPeriodRecordandroid.permission.health.READ_MENSTRUATION android.permission.health.WRITE_MENSTRUATION |
| Mindfulness Track mindfulness guide |
Wellness |
MindfulnessSessionRecordandroid.permission.health.READ_MINDFULNESS android.permission.health.WRITE_MINDFULNESS FEATURE_MINDFULNESS_SESSION |
| Nutrition |
Nutrition |
NutritionRecordandroid.permission.health.READ_NUTRITION android.permission.health.WRITE_NUTRITION |
| Ovulation test |
Cycle Tracking |
OvulationTestRecordandroid.permission.health.READ_OVULATION_TEST android.permission.health.WRITE_OVULATION_TEST |
| Oxygen saturation |
Vitals |
OxygenSaturationRecordandroid.permission.health.READ_OXYGEN_SATURATION android.permission.health.WRITE_OXYGEN_SATURATION |
| Planned exercise Training plans guide |
Activity |
PlannedExerciseSessionRecordandroid.permission.health.READ_PLANNED_EXERCISE android.permission.health.WRITE_PLANNED_EXERCISE FEATURE_PLANNED_EXERCISE |
| Power |
Activity |
PowerRecordandroid.permission.health.READ_POWER android.permission.health.WRITE_POWER |
| Respiratory rate |
Vitals |
RespiratoryRateRecordandroid.permission.health.READ_RESPIRATORY_RATE android.permission.health.WRITE_RESPIRATORY_RATE |
| Resting heart rate |
Vitals |
RestingHeartRateRecordandroid.permission.health.READ_RESTING_HEART_RATE android.permission.health.WRITE_RESTING_HEART_RATE |
| Sexual activity |
Activity |
SexualActivityRecordandroid.permission.health.READ_SEXUAL_ACTIVITY android.permission.health.WRITE_SEXUAL_ACTIVITY |
| Skin temperature Measure skin temperature guide |
Vitals |
SkinTemperatureRecordandroid.permission.health.READ_SKIN_TEMPERATURE android.permission.health.WRITE_SKIN_TEMPERATURE FEATURE_SKIN_TEMPERATURE |
| Sleep session Track sleep sessions guide |
Sleep |
SleepSessionRecordandroid.permission.health.READ_SLEEP android.permission.health.WRITE_SLEEP |
| Speed |
Activity |
SpeedRecordandroid.permission.health.READ_SPEED android.permission.health.WRITE_SPEED |
| Steps |
Activity |
StepsRecordStepsCadenceRecordandroid.permission.health.READ_STEPS android.permission.health.WRITE_STEPS |
| Total calories burned |
Activity |
TotalCaloriesBurnedRecordandroid.permission.health.READ_TOTAL_CALORIES_BURNED android.permission.health.WRITE_TOTAL_CALORIES_BURNED |
| VO2 max |
Activity |
Vo2MaxRecordandroid.permission.health.READ_VO2_MAX android.permission.health.WRITE_VO2_MAX |
| Weight |
Body Measurement |
WeightRecordandroid.permission.health.READ_WEIGHT android.permission.health.WRITE_WEIGHT |
| Wheelchair pushes |
Activity |
WheelchairPushesRecordandroid.permission.health.READ_WHEELCHAIR_PUSHES android.permission.health.WRITE_WHEELCHAIR_PUSHES |