<!--
{
  "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/HKQuantitySeriesSampleQuery/includeSample",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Property",
  "symbol" : {
    "kind" : "Instance Property",
    "modules" : [
      "HealthKit"
    ],
    "preciseIdentifier" : "c:objc(cs)HKQuantitySeriesSampleQuery(py)includeSample"
  },
  "title" : "includeSample"
}
-->

# includeSample

A Boolean value that determines whether the query should return the series sample.

```
var includeSample: Bool { get set }
```

## Discussion

By default, a quantity series sample only returns the individual quantity objects that make up the series—not the [`HKQuantitySample`](/documentation/HealthKit/HKQuantitySample) object that represents the entire series. Set this parameter to <doc://com.apple.documentation/documentation/Foundation/NSExpression/true> to have the query also return the quantity sample object for the series.

> Note:
> This may introduce a performance cost for the query.

---

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)