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.HKCategoryTypeIdentifierAppleStandHour
HKCategoryTypeIdentifierAppleStandHour
CategoryValueAppleStandHourstood(0)idle(1)
HKCategoryTypeIdentifierHighHeartRateEvent
HKCategoryTypeIdentifierHighHeartRateEvent
CategoryValueNotApplicable.notApplicableRead-only: YesHKCategoryTypeIdentifierLowHeartRateEvent
HKCategoryTypeIdentifierLowHeartRateEvent
CategoryValueNotApplicable.notApplicableRead-only: YesHKCategoryTypeIdentifierHeadphoneAudioExposureEvent
HKCategoryTypeIdentifierHeadphoneAudioExposureEvent
CategoryValueNotApplicable.notApplicableRead-only: YesSleep & Activity
HKCategoryTypeIdentifierSleepAnalysis
HKCategoryTypeIdentifierSleepAnalysis
CategoryValueSleepAnalysisinBed(0)asleepUnspecified(1)awake(2)asleepCore(3)asleepDeep(4)asleepREM(5)
HKCategoryTypeIdentifierSleepApneaEvent
HKCategoryTypeIdentifierSleepApneaEvent
numberWriteable: YesAvailable: iOS 18+HKCategoryTypeIdentifierMindfulSession
HKCategoryTypeIdentifierMindfulSession
CategoryValueNotApplicable.notApplicableWriteable: YesHKCategoryTypeIdentifierToothbrushingEvent
HKCategoryTypeIdentifierToothbrushingEvent
numberWriteable: YesHKCategoryTypeIdentifierHandwashingEvent
HKCategoryTypeIdentifierHandwashingEvent
numberWriteable: YesReproductive Health
HKCategoryTypeIdentifierCervicalMucusQuality
HKCategoryTypeIdentifierCervicalMucusQuality
CategoryValueCervicalMucusQualitydry(1)sticky(2)creamy(3)watery(4)eggWhite(5)
HKCategoryTypeIdentifierOvulationTestResult
HKCategoryTypeIdentifierOvulationTestResult
CategoryValueOvulationTestResultnegative(1)luteinizingHormoneSurge(2)indeterminate(3)estrogenSurge(4)
HKCategoryTypeIdentifierMenstrualFlow
HKCategoryTypeIdentifierMenstrualFlow
CategoryValueMenstrualFlowunspecified(1)none(5)light(2)medium(3)heavy(4)
HKMenstrualCycleStart booleanHKCategoryTypeIdentifierIntermenstrualBleeding
HKCategoryTypeIdentifierIntermenstrualBleeding
CategoryValueNotApplicable.notApplicableWriteable: YesHKCategoryTypeIdentifierInfrequentMenstrualCycles
HKCategoryTypeIdentifierInfrequentMenstrualCycles
numberWriteable: YesAvailable: iOS 16+HKCategoryTypeIdentifierIrregularMenstrualCycles
HKCategoryTypeIdentifierIrregularMenstrualCycles
numberWriteable: YesAvailable: iOS 16+HKCategoryTypeIdentifierPersistentIntermenstrualBleeding
HKCategoryTypeIdentifierPersistentIntermenstrualBleeding
numberWriteable: YesAvailable: iOS 16+HKCategoryTypeIdentifierProlongedMenstrualPeriods
HKCategoryTypeIdentifierProlongedMenstrualPeriods
numberWriteable: YesAvailable: iOS 16+HKCategoryTypeIdentifierSexualActivity
HKCategoryTypeIdentifierSexualActivity
CategoryValueNotApplicable.notApplicableWriteable: YesMetadata: Supports HKSexualActivityProtectionUsed booleanHKCategoryTypeIdentifierContraceptive
HKCategoryTypeIdentifierContraceptive
numberWriteable: YesHKCategoryTypeIdentifierLactation
HKCategoryTypeIdentifierLactation
numberWriteable: YesHKCategoryTypeIdentifierPregnancy
HKCategoryTypeIdentifierPregnancy
numberWriteable: YesHKCategoryTypeIdentifierPregnancyTestResult
HKCategoryTypeIdentifierPregnancyTestResult
CategoryValuePregnancyTestResultpositive(2)negative(1)indeterminate(3)
HKCategoryTypeIdentifierProgesteroneTestResult
HKCategoryTypeIdentifierProgesteroneTestResult
numberWriteable: YesHKCategoryTypeIdentifierBleedingAfterPregnancy
HKCategoryTypeIdentifierBleedingAfterPregnancy
numberWriteable: YesAvailable: iOS 18+HKCategoryTypeIdentifierBleedingDuringPregnancy
HKCategoryTypeIdentifierBleedingDuringPregnancy
numberWriteable: YesAvailable: iOS 18+Heart Health
HKCategoryTypeIdentifierIrregularHeartRhythmEvent
HKCategoryTypeIdentifierIrregularHeartRhythmEvent
numberWriteable: YesHKCategoryTypeIdentifierLowCardioFitnessEvent
HKCategoryTypeIdentifierLowCardioFitnessEvent
CategoryValueLowCardioFitnessEventlowFitness(1)
Environmental & Safety
HKCategoryTypeIdentifierAudioExposureEvent
HKCategoryTypeIdentifierAudioExposureEvent
numberWriteable: YesDeprecated: Use HKCategoryTypeIdentifierEnvironmentalAudioExposureEvent insteadHKCategoryTypeIdentifierEnvironmentalAudioExposureEvent
HKCategoryTypeIdentifierEnvironmentalAudioExposureEvent
numberWriteable: YesHKCategoryTypeIdentifierAppleWalkingSteadinessEvent
HKCategoryTypeIdentifierAppleWalkingSteadinessEvent
numberWriteable: YesSymptoms
All symptom identifiers use severity-based values unless otherwise noted.Digestive Symptoms
HKCategoryTypeIdentifierAbdominalCramps
HKCategoryTypeIdentifierAbdominalCramps
CategoryValueSeverity (notPresent, mild, moderate, severe, unspecified)HKCategoryTypeIdentifierAppetiteChanges
HKCategoryTypeIdentifierAppetiteChanges
CategoryValueAppetiteChangesdecreased(2)increased(3)noChange(1)unspecified(0)
HKCategoryTypeIdentifierBloating
HKCategoryTypeIdentifierBloating
CategoryValueSeverityHKCategoryTypeIdentifierConstipation
HKCategoryTypeIdentifierConstipation
CategoryValueSeverityHKCategoryTypeIdentifierDiarrhea
HKCategoryTypeIdentifierDiarrhea
CategoryValueSeverityHKCategoryTypeIdentifierHeartburn
HKCategoryTypeIdentifierHeartburn
CategoryValueSeverityHKCategoryTypeIdentifierNausea
HKCategoryTypeIdentifierNausea
CategoryValueSeverityHKCategoryTypeIdentifierVomiting
HKCategoryTypeIdentifierVomiting
CategoryValueSeverityRespiratory Symptoms
HKCategoryTypeIdentifierChestTightnessOrPain
HKCategoryTypeIdentifierChestTightnessOrPain
CategoryValueSeverityHKCategoryTypeIdentifierCoughing
HKCategoryTypeIdentifierCoughing
CategoryValueSeverityHKCategoryTypeIdentifierRunnyNose
HKCategoryTypeIdentifierRunnyNose
CategoryValueSeverityHKCategoryTypeIdentifierShortnessOfBreath
HKCategoryTypeIdentifierShortnessOfBreath
CategoryValueSeverityHKCategoryTypeIdentifierSinusCongestion
HKCategoryTypeIdentifierSinusCongestion
CategoryValueSeverityHKCategoryTypeIdentifierSoreThroat
HKCategoryTypeIdentifierSoreThroat
CategoryValueSeverityHKCategoryTypeIdentifierWheezing
HKCategoryTypeIdentifierWheezing
CategoryValueSeverityCardiovascular Symptoms
HKCategoryTypeIdentifierRapidPoundingOrFlutteringHeartbeat
HKCategoryTypeIdentifierRapidPoundingOrFlutteringHeartbeat
CategoryValueSeverityHKCategoryTypeIdentifierSkippedHeartbeat
HKCategoryTypeIdentifierSkippedHeartbeat
CategoryValueSeverityPain Symptoms
HKCategoryTypeIdentifierBreastPain
HKCategoryTypeIdentifierBreastPain
CategoryValueSeverityHKCategoryTypeIdentifierGeneralizedBodyAche
HKCategoryTypeIdentifierGeneralizedBodyAche
CategoryValueSeverityHKCategoryTypeIdentifierHeadache
HKCategoryTypeIdentifierHeadache
CategoryValueSeverityHKCategoryTypeIdentifierLowerBackPain
HKCategoryTypeIdentifierLowerBackPain
CategoryValueSeverityHKCategoryTypeIdentifierPelvicPain
HKCategoryTypeIdentifierPelvicPain
CategoryValueSeverityNeurological Symptoms
HKCategoryTypeIdentifierDizziness
HKCategoryTypeIdentifierDizziness
CategoryValueSeverityHKCategoryTypeIdentifierFainting
HKCategoryTypeIdentifierFainting
CategoryValueSeverityHKCategoryTypeIdentifierMemoryLapse
HKCategoryTypeIdentifierMemoryLapse
CategoryValueSeverityGeneral Symptoms
HKCategoryTypeIdentifierAcne
HKCategoryTypeIdentifierAcne
CategoryValueSeverityHKCategoryTypeIdentifierBladderIncontinence
HKCategoryTypeIdentifierBladderIncontinence
CategoryValueSeverityHKCategoryTypeIdentifierChills
HKCategoryTypeIdentifierChills
CategoryValueSeverityHKCategoryTypeIdentifierDrySkin
HKCategoryTypeIdentifierDrySkin
CategoryValueSeverityHKCategoryTypeIdentifierFatigue
HKCategoryTypeIdentifierFatigue
CategoryValueSeverityHKCategoryTypeIdentifierFever
HKCategoryTypeIdentifierFever
CategoryValueSeverityHKCategoryTypeIdentifierHairLoss
HKCategoryTypeIdentifierHairLoss
CategoryValueSeverityHKCategoryTypeIdentifierHotFlashes
HKCategoryTypeIdentifierHotFlashes
CategoryValueSeverityHKCategoryTypeIdentifierLossOfSmell
HKCategoryTypeIdentifierLossOfSmell
CategoryValueSeverityHKCategoryTypeIdentifierLossOfTaste
HKCategoryTypeIdentifierLossOfTaste
CategoryValueSeverityHKCategoryTypeIdentifierMoodChanges
HKCategoryTypeIdentifierMoodChanges
CategoryValueSeverityHKCategoryTypeIdentifierNightSweats
HKCategoryTypeIdentifierNightSweats
CategoryValueSeverityHKCategoryTypeIdentifierSleepChanges
HKCategoryTypeIdentifierSleepChanges
CategoryValueAppetiteChanges (same enum, different context)HKCategoryTypeIdentifierVaginalDryness
HKCategoryTypeIdentifierVaginalDryness
CategoryValueSeverity