<!--
{
  "availability" : [
    "iOS: 13.0.0 -",
    "iPadOS: 13.0.0 -",
    "macCatalyst: 13.0.0 -",
    "macOS: 13.0.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 6.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "HealthKit",
  "identifier" : "/documentation/HealthKit/HKHeartbeatSeriesBuilder",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "HealthKit"
    ],
    "preciseIdentifier" : "c:objc(cs)HKHeartbeatSeriesBuilder"
  },
  "title" : "HKHeartbeatSeriesBuilder"
}
-->

# HKHeartbeatSeriesBuilder

A builder object for incrementally building a heartbeat series.

```
class HKHeartbeatSeriesBuilder
```

## Topics

### Creating a Heartbeat Series Builder

[`init(healthStore:device:start:)`](/documentation/HealthKit/HKHeartbeatSeriesBuilder/init(healthStore:device:start:))

Creates a new heartbeat series builder.

[`maximumCount`](/documentation/HealthKit/HKHeartbeatSeriesBuilder/maximumCount)

The maximum number of heartbeats you can add to the sample.

### Adding Data

[`addHeartbeatWithTimeInterval(sinceSeriesStartDate:precededByGap:completion:)`](/documentation/HealthKit/HKHeartbeatSeriesBuilder/addHeartbeatWithTimeInterval(sinceSeriesStartDate:precededByGap:completion:))

Adds a heartbeat to the series.

[`addMetadata(_:completion:)`](/documentation/HealthKit/HKHeartbeatSeriesBuilder/addMetadata(_:completion:))

Adds metadata to the sample.

### Ending the Collection

[`finishSeries(completion:)`](/documentation/HealthKit/HKHeartbeatSeriesBuilder/finishSeries(completion:))

Finalizes the series and returns the resulting heartbeat series sample.


---

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)