# init(type:start:end:objects:device:metadata:) Instantiates and returns a new correlation instance with the provided device and metadata. ``` convenience init(type correlationType: HKCorrelationType, start startDate: Date, end endDate: Date, objects: Set, device: HKDevice?, metadata: [String : Any]?) ``` ## Parameters `correlationType` The type for this correlation. For a complete list of correlation type identifiers, see [`HKCorrelationTypeIdentifier`](/documentation/HealthKit/HKCorrelationTypeIdentifier). `startDate` The start date for the sample. This date must be equal to or earlier than the end date; otherwise, this method throws an exception (). `endDate` The end date for the sample. This date must be equal to or later than the start date; otherwise, this method throws an exception (). `objects` A set of [`HKSample`](/documentation/HealthKit/HKSample) objects. Specifically, this set contains the quantity and category samples to be grouped into this correlation. `device` The device that generated the data for this sample. `metadata` The metadata dictionary containing extra information that describes this correlation. The dictionary’s keys are all objects . The values may be , , or objects. For a complete list of predefined metadata keys, see Metadata Keys. Using predefined keys helps facilitate sharing data between apps; however, you are also encouraged to create custom keys as needed to extend the HealthKit sample’s capabilities. When creating correlations representing food, always use the [`HKMetadataKeyFoodType`](/documentation/HealthKit/HKMetadataKeyFoodType) key to provide the food’s name. ## Return Value A new correlation instance. ## Discussion Use a correlation object to represent composite data—that is, a sample that requires more than a single value. To create a correlation sample, first create the quantity and category samples you intend to combine into the correlation. Next, create the correlation’s type. Finally, instantiate the correlation, passing in the type, start date, end date, samples, device, and metadata as shown below. Use this method when recording data using external hardware. If you do not need to include additional metadata, pass `nil` for the `metadata` parameter. ```objc NSDate *date = [NSDate date]; // Create systolic sample HKQuantityType *systolicType = [HKObjectType quantityTypeForIdentifier: HKQuantityTypeIdentifierBloodPressureSystolic]; HKQuantity *systolicQuantity = [HKQuantity quantityWithUnit:[HKUnit millimeterOfMercuryUnit] doubleValue:120.0]; HKQuantitySample *systolicSample = [HKQuantitySample quantitySampleWithType:systolicType quantity:systolicQuantity startDate:date endDate:date]; // Create diastolic sample HKQuantityType *diastolicType = [HKObjectType quantityTypeForIdentifier: HKQuantityTypeIdentifierBloodPressureDiastolic]; HKQuantity *diastolicQuantity = [HKQuantity quantityWithUnit:[HKUnit millimeterOfMercuryUnit] doubleValue:75.0]; HKQuantitySample *diastolicSample = [HKQuantitySample quantitySampleWithType:diastolicType quantity:diastolicQuantity startDate:date endDate:date]; // Create blood pressure sample HKCorrelationType *bloodPressureType = [HKObjectType correlationTypeForIdentifier: HKCorrelationTypeIdentifierBloodPressure]; NSSet *objects = [NSSet setWithObjects:systolicSample, diastolicSample, nil]; HKDevice *device = [[HKDevice alloc] initWithName:deviceName manufacturer:manufacturerName model:modelName hardwareVersion:hardwareVersionNumber firmwareVersion:firmwareVersionNumber softwareVersion:softwareVersionNumber localIdentifier:localIdentifier UDIDeviceIdentifier:deviceIdentifier]; NSDictionary *metadata = @{HKMetadataKeyDigitalSignature:digitalSignature, HKMetadataKeyTimeZone:timeZone}; HKCorrelation *bloodPressure = [HKCorrelation correlationWithType:bloodPressureType startDate:date endDate:date objects:objects device:device metadata:metadata]; ``` ## See Also [`objects`](/documentation/HealthKit/HKCorrelation/objects) The set of sample objects that make up the correlation. [`+ correlationTypeForIdentifier:`](/documentation/HealthKit/HKObjectType/correlationType(forIdentifier:)) Returns the shared correlation type for the provided identifier. [`endDate`](/documentation/HealthKit/HKSample/endDate) The sample’s end date. [`correlationType`](/documentation/HealthKit/HKCorrelation/correlationType) The type for this correlation. [`metadata`](/documentation/HealthKit/HKObject/metadata) The metadata for this HealthKit object. [`startDate`](/documentation/HealthKit/HKSample/startDate) The sample’s start date. --- Copyright © 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)