Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/kingstinct/react-native-healthkit/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Category samples in HealthKit represent data that fits into a predefined set of values. This page lists all 67 available category type identifiers.

​
Read-Only Categories

These category types are automatically tracked by Apple Watch or iOS and cannot be written by third-party apps.
Tracks whether the user stood during a particular hour.Values: CategoryValueAppleStandHour
  • stood (0)
  • idle (1)
Read-only: Yes
Records events when the user’s heart rate exceeds a specified threshold.Values: CategoryValueNotApplicable.notApplicableRead-only: Yes
Records events when the user’s heart rate falls below a specified threshold.Values: CategoryValueNotApplicable.notApplicableRead-only: Yes
Tracks when headphone audio exposure exceeds safe listening levels.Values: CategoryValueNotApplicable.notApplicableRead-only: Yes

​
Sleep & Activity

Represents sleep stages and in-bed time.Values: CategoryValueSleepAnalysis
  • inBed (0)
  • asleepUnspecified (1)
  • awake (2)
  • asleepCore (3)
  • asleepDeep (4)
  • asleepREM (5)
Writeable: Yes
Records sleep apnea events.Values: numberWriteable: YesAvailable: iOS 18+
Tracks mindfulness or meditation sessions.Values: CategoryValueNotApplicable.notApplicableWriteable: Yes
Records toothbrushing events.Values: numberWriteable: Yes
Tracks handwashing events.Values: numberWriteable: Yes

​
Reproductive Health

Tracks cervical mucus quality.Values: CategoryValueCervicalMucusQuality
  • dry (1)
  • sticky (2)
  • creamy (3)
  • watery (4)
  • eggWhite (5)
Writeable: Yes
Records ovulation test results.Values: CategoryValueOvulationTestResult
  • negative (1)
  • luteinizingHormoneSurge (2)
  • indeterminate (3)
  • estrogenSurge (4)
Writeable: Yes
Tracks menstrual flow.Values: CategoryValueMenstrualFlow
  • unspecified (1)
  • none (5)
  • light (2)
  • medium (3)
  • heavy (4)
Writeable: YesDeprecated: In iOS 18 betaMetadata: Supports HKMenstrualCycleStart boolean
Records spotting or bleeding between periods.Values: CategoryValueNotApplicable.notApplicableWriteable: Yes
Tracks infrequent menstrual cycles.Values: numberWriteable: YesAvailable: iOS 16+
Records irregular menstrual cycles.Values: numberWriteable: YesAvailable: iOS 16+
Tracks persistent intermenstrual bleeding.Values: numberWriteable: YesAvailable: iOS 16+
Records prolonged menstrual periods.Values: numberWriteable: YesAvailable: iOS 16+
Tracks sexual activity.Values: CategoryValueNotApplicable.notApplicableWriteable: YesMetadata: Supports HKSexualActivityProtectionUsed boolean
Records contraceptive use.Values: numberWriteable: Yes
Tracks lactation periods.Values: numberWriteable: Yes
Records pregnancy.Values: numberWriteable: Yes
Records pregnancy test results.Values: CategoryValuePregnancyTestResult
  • positive (2)
  • negative (1)
  • indeterminate (3)
Writeable: Yes
Records progesterone test results.Values: numberWriteable: Yes
Tracks bleeding after pregnancy.Values: numberWriteable: YesAvailable: iOS 18+
Records bleeding during pregnancy.Values: numberWriteable: YesAvailable: iOS 18+

​
Heart Health

Records irregular heart rhythm events.Values: numberWriteable: Yes
Tracks low cardio fitness events.Values: CategoryValueLowCardioFitnessEvent
  • lowFitness (1)
Writeable: Yes

​
Environmental & Safety

Records audio exposure events.Values: numberWriteable: YesDeprecated: Use HKCategoryTypeIdentifierEnvironmentalAudioExposureEvent instead
Tracks environmental audio exposure events.Values: numberWriteable: Yes
Records walking steadiness events.Values: numberWriteable: Yes

​
Symptoms

All symptom identifiers use severity-based values unless otherwise noted.

​
Digestive Symptoms

Values: CategoryValueSeverity (notPresent, mild, moderate, severe, unspecified)
Values: CategoryValueAppetiteChanges
  • decreased (2)
  • increased (3)
  • noChange (1)
  • unspecified (0)
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity

​
Respiratory Symptoms

Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity

​
Cardiovascular Symptoms

Values: CategoryValueSeverity
Values: CategoryValueSeverity

​
Pain Symptoms

Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity

​
Neurological Symptoms

Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity

​
General Symptoms

Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueSeverity
Values: CategoryValueAppetiteChanges (same enum, different context)
Values: CategoryValueSeverity

​
Type Reference

​
CategoryValueSeverity

enum CategoryValueSeverity {
  notPresent = 1,
  mild = 2,
  moderate = 3,
  severe = 4,
  unspecified = 0,
}

​
CategoryValuePresence

enum CategoryValuePresence {
  notPresent = 1,
  present = 0,
}

​
CategoryValueNotApplicable

enum CategoryValueNotApplicable {
  notApplicable = 0,
}
See the Apple HealthKit Documentation for detailed information about each category type.

Build docs developers (and LLMs) love

Get started for freeTalk to us