---
title: Predicate format strings
framework: healthkit
role: collectionGroup
role_heading: API Collection
path: healthkit/predicate-format-strings
---

# Predicate format strings

Formatting strings for creating predicates.

## Topics

### Object keys

- [HKPredicateKeyPathUUID](healthkit/hkpredicatekeypathuuid.md)
- [HKPredicateKeyPathMetadata](healthkit/hkpredicatekeypathmetadata.md)
- [HKPredicateKeyPathSum](healthkit/hkpredicatekeypathsum.md)

### Quantity sample keys

- [HKPredicateKeyPathQuantity](healthkit/hkpredicatekeypathquantity.md)

### Category sample keys

- [HKPredicateKeyPathCategoryValue](healthkit/hkpredicatekeypathcategoryvalue.md)

### Correlation sample keys

- [HKPredicateKeyPathCorrelation](healthkit/hkpredicatekeypathcorrelation.md)

### Device and source keys

- [HKPredicateKeyPathDevice](healthkit/hkpredicatekeypathdevice.md)
- [HKPredicateKeyPathSource](healthkit/hkpredicatekeypathsource.md)
- [HKPredicateKeyPathSourceRevision](healthkit/hkpredicatekeypathsourcerevision.md)

### Start and end date keys

- [HKPredicateKeyPathStartDate](healthkit/hkpredicatekeypathstartdate.md)
- [HKPredicateKeyPathEndDate](healthkit/hkpredicatekeypathenddate.md)

### Activity summary keys

- [HKPredicateKeyPathDateComponents](healthkit/hkpredicatekeypathdatecomponents.md)

### Document keys

- [HKPredicateKeyPathCDAAuthorName](healthkit/hkpredicatekeypathcdaauthorname.md)
- [HKPredicateKeyPathCDACustodianName](healthkit/hkpredicatekeypathcdacustodianname.md)
- [HKPredicateKeyPathCDAPatientName](healthkit/hkpredicatekeypathcdapatientname.md)
- [HKPredicateKeyPathCDATitle](healthkit/hkpredicatekeypathcdatitle.md)

### Clinical record keys

- [HKPredicateKeyPathClinicalRecordFHIRResourceIdentifier](healthkit/hkpredicatekeypathclinicalrecordfhirresourceidentifier.md)
- [HKPredicateKeyPathClinicalRecordFHIRResourceType](healthkit/hkpredicatekeypathclinicalrecordfhirresourcetype.md)

### Workout keys

- [HKPredicateKeyPathWorkout](healthkit/hkpredicatekeypathworkout.md)
- [HKPredicateKeyPathWorkoutType](healthkit/hkpredicatekeypathworkouttype.md)
- [HKPredicateKeyPathWorkoutDuration](healthkit/hkpredicatekeypathworkoutduration.md)
- [HKPredicateKeyPathWorkoutAverageQuantity](healthkit/hkpredicatekeypathworkoutaveragequantity.md)
- [HKPredicateKeyPathWorkoutMaximumQuantity](healthkit/hkpredicatekeypathworkoutmaximumquantity.md)
- [HKPredicateKeyPathWorkoutMinimumQuantity](healthkit/hkpredicatekeypathworkoutminimumquantity.md)
- [HKPredicateKeyPathWorkoutSumQuantity](healthkit/hkpredicatekeypathworkoutsumquantity.md)
- [HKPredicateKeyPathWorkoutTotalDistance](healthkit/hkpredicatekeypathworkouttotaldistance.md)
- [HKPredicateKeyPathWorkoutTotalEnergyBurned](healthkit/hkpredicatekeypathworkouttotalenergyburned.md)
- [HKPredicateKeyPathWorkoutTotalFlightsClimbed](healthkit/hkpredicatekeypathworkouttotalflightsclimbed.md)
- [HKPredicateKeyPathWorkoutTotalSwimmingStrokeCount](healthkit/hkpredicatekeypathworkouttotalswimmingstrokecount.md)

### Workout activity keys

- [HKPredicateKeyPathWorkoutActivity](healthkit/hkpredicatekeypathworkoutactivity.md)
- [HKPredicateKeyPathWorkoutActivityType](healthkit/hkpredicatekeypathworkoutactivitytype.md)
- [HKPredicateKeyPathWorkoutActivityStartDate](healthkit/hkpredicatekeypathworkoutactivitystartdate.md)
- [HKPredicateKeyPathWorkoutActivityEndDate](healthkit/hkpredicatekeypathworkoutactivityenddate.md)
- [HKPredicateKeyPathWorkoutActivityDuration](healthkit/hkpredicatekeypathworkoutactivityduration.md)
- [HKPredicateKeyPathWorkoutActivityAverageQuantity](healthkit/hkpredicatekeypathworkoutactivityaveragequantity.md)
- [HKPredicateKeyPathWorkoutActivityMaximumQuantity](healthkit/hkpredicatekeypathworkoutactivitymaximumquantity.md)
- [HKPredicateKeyPathWorkoutActivityMinimumQuantity](healthkit/hkpredicatekeypathworkoutactivityminimumquantity.md)
- [HKPredicateKeyPathWorkoutActivitySumQuantity](healthkit/hkpredicatekeypathworkoutactivitysumquantity.md)