<!--
{
  "availability" : [
    "iOS: 12.2.0 -",
    "iPadOS: 12.2.0 -",
    "macCatalyst: 13.0.0 -",
    "macOS: 13.0.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 5.2.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "HealthKit",
  "identifier" : "/documentation/HealthKit/HKCategoryTypeIdentifier/highHeartRateEvent",
  "metadataVersion" : "0.1.0",
  "role" : "Type Property",
  "symbol" : {
    "kind" : "Type Property",
    "modules" : [
      "HealthKit"
    ],
    "preciseIdentifier" : "c:@HKCategoryTypeIdentifierHighHeartRateEvent"
  },
  "title" : "highHeartRateEvent"
}
-->

# highHeartRateEvent

A category sample type for high heart rate events.

```
static let highHeartRateEvent: HKCategoryTypeIdentifier
```

## Discussion

The system creates [`highHeartRateEvent`](/documentation/HealthKit/HKCategoryTypeIdentifier/highHeartRateEvent) samples whenever Apple Watch produces a high heart rate notification. For more information, see [Heart rate notifications on your Apple Watch](https://support.apple.com/en-us/HT208931).

The high heart rate samples are read-only. You can request permission to read the samples using this identifier, but you can’t request authorization to share them. This means you can’t save new high heart rate events to the HealthKit store. To add test data in iOS Simulator, open the Health app and select Browse > Heart > High Heart Rate Notifications > Add Data.

These samples have a value of [`HKCategoryValue.notApplicable`](/documentation/HealthKit/HKCategoryValue/notApplicable) and include [`HKMetadataKeyHeartRateEventThreshold`](/documentation/HealthKit/HKMetadataKeyHeartRateEventThreshold) metadata.

## Topics

### Metadata Keys

[`let HKMetadataKeyHeartRateEventThreshold: String`](/documentation/HealthKit/HKMetadataKeyHeartRateEventThreshold)

A key that records the threshold of high or low heart rate events in beats per minute.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)