Skip to content
Contact us
  • There are no suggestions because the search field is empty.

Apple HealthKitV2 Samples Export Format

The HealthKit samples export encompasses most of the sample data generated by HealthKit (e.g., Heart Rate, Sleep Analysis, Steps, and any other data that is not a workout or activity summary).

Data Structure

One file will be created per type of data (e.g., "HeartRate" and "VO2Max"). The file name will correspond to the type of data (e.g., "HealthKitV2Samples_HeartRate_20211101-20211217" and "HealthKitV2Samples_VO2Max_20211101-20211217").

Your team will need to be mindful of the following samples, ensuring they are removed for analysis:

  • Duplicate Samples: You may see duplicate samples exported over time, typically occurring if a participant deletes and reinstalls MyDataHelps. HealthKit samples are immutable, so when doing data analysis, your team will need to remove any samples that have the same HealthKitSampleKey and ParticipantIdentifier as another sample.

  • Deleted Samples: Participants may delete their HealthKit samples from their device or, occasionally, Apple Health will combine historic samples to save space, creating deleted samples. For example, consecutive step samples of 30 and 70 steps might be combined into a single step sample of 100 steps. The new 100 step sample would be delivered in the "Steps" file while the 30 and 70 step samples would be in the deleted steps file.

Samples


Deleted Samples


CSV Exports

Samples CSV Export

HealthKitSampleKey,ParticipantIdentifier,StartDate,Date,Value,Units,SourceIdentifier,SourceName,SourceVersion,SourceOperatingSystemVersion,SourceProductType,DeviceName,DeviceModel,DeviceManufacturer,DeviceHardwareVersion,DeviceSoftwareVersion,DeviceFirmwareVersion,DeviceLocalIdentifier,DeviceFDAIdentifier,Metadata,InsertedDate
84aeb80c-c27f-5972-9514-192a7305f71d,e794c47e-438e-4d7b-9b24-99ce68c75300,2021-10-26T08:24:09-04:00,2021-10-26T08:24:09-04:00,49.53,ml/(kg*min),com.apple.health.FA902D86-1FDE-492D-B25A-3EB99A9BC6A6,Sample's Apple Watch S4,2663.1.1,8.0.1,"Watch4,4",,,,,,,,,"{""HKMetadataKeySyncVersion"":""1"",""HKVO2MaxTestType"":""2"",""HKMetadataKeySyncIdentifier"":""3B0C822F-1389-413F-B5EA-B93E0E9F2634""}",2021-11-05T14:20:39Z
1422059e-6dcd-5872-8621-7b822e5e3c69,e794c47e-438e-4d7b-9b24-99ce68c75300,2021-10-28T08:25:47-04:00,2021-10-28T08:25:47-04:00,49.68,ml/(kg*min),com.apple.health.FA902D86-1FDE-492D-B25A-3EB99A9BC6A6,Sample's Apple Watch S4,2664.0.8.1.1,8.1.0,"Watch4,4",,,,,,,,,"{""HKMetadataKeySyncVersion"":""1"",""HKVO2MaxTestType"":""2"",""HKMetadataKeySyncIdentifier"":""720FC6FE-B451-433C-90B8-8784595F980F""}",2021-11-05T14:20:39Z
0e866a66-1610-5493-acb5-b3448fe06ad2,e794c47e-438e-4d7b-9b24-99ce68c75300,2021-10-28T18:17:54-04:00,2021-10-28T18:17:54-04:00,49.7,ml/(kg*min),com.apple.health.FA902D86-1FDE-492D-B25A-3EB99A9BC6A6,Sample's Apple Watch S4,2664.0.8.1.1,8.1.0,"Watch4,4",,,,,,,,,"{""HKMetadataKeySyncVersion"":""1"",""HKVO2MaxTestType"":""2"",""HKMetadataKeySyncIdentifier"":""E50E9B87-E76B-4244-B7D6-FB51B652A786""}",2021-11-05T14:20:39Z

Deleted Samples CSV Export

HealthKitSampleKey,ParticipantIdentifier,DeletedDate
7f445386-e542-554d-8eed-0113e493bd71,e794c47e-438e-4d7b-9b24-99ce68c75300,2021-11-05T14:20:12Z
1669ad87-edae-5090-afb1-a70abf17db28,e794c47e-438e-4d7b-9b24-99ce68c75300,2021-11-05T14:20:12Z
b2df16d0-f5f3-521a-963e-36967009cf2f,e794c47e-438e-4d7b-9b24-99ce68c75300,2021-11-05T14:20:12Z

JSON Exports

Samples JSON Export

{
 "HealthKitSampleKey":"84aeb80c-c27f-5972-9514-192a7305f71d",
 "ParticipantIdentifier":"e794c47e-438e-4d7b-9b24-99ce68c75300",
 "StartDate":"2021-10-26T08:24:09-04:00",
 "Date":"2021-10-26T08:24:09-04:00",
 "Value":"49.530000000000001",
 "Units":"ml/(kg*min)",
 "Source":
  {
   "Name":"Sample’s Apple Watch S4",
   "Identifier":"com.apple.health.FA902D86-1FDE-492D-B25A-3EB99A9BC6A6",
   "Version":"2663.1.1",
   "OperatingSystemVersion":"8.0.1",
   "ProductType":"Watch4,4"
  },
 "Device":null,
 "Metadata":
  {
   "HKMetadataKeySyncVersion":"1",
   "HKVO2MaxTestType":"2",
   "HKMetadataKeySyncIdentifier":"3B0C822F-1389-413F-B5EA-B93E0E9F2634"
  },
 "InsertedDate":"2021-11-05T14:20:39Z"
}
{
 "HealthKitSampleKey":"1422059e-6dcd-5872-8621-7b822e5e3c69",
 "ParticipantIdentifier":"e794c47e-438e-4d7b-9b24-99ce68c75300",
 "StartDate":"2021-10-28T08:25:47-04:00",
 "Date":"2021-10-28T08:25:47-04:00",
 "Value":"49.68",
 "Units":"ml/(kg*min)",
 "Source":
  {
   "Name":"Sample’s Apple Watch S4",
   "Identifier":"com.apple.health.FA902D86-1FDE-492D-B25A-3EB99A9BC6A6",
   "Version":"2664.0.8.1.1",
   "OperatingSystemVersion":"8.1.0",
   "ProductType":"Watch4,4"
  },
 "Device":null,
 "Metadata":
  {
   "HKMetadataKeySyncVersion":"1",
   "HKVO2MaxTestType":"2",
   "HKMetadataKeySyncIdentifier":"720FC6FE-B451-433C-90B8-8784595F980F"
  },
 "InsertedDate":"2021-11-05T14:20:39Z"
}

Deleted Samples JSON Export

{
 "HealthKitSampleKey":"7f445386-e542-554d-8eed-0113e493bd71",
 "ParticipantIdentifier":"e794c47e-438e-4d7b-9b24-99ce68c75300",
 "DeletedDate":"2021-11-05T14:20:12Z"
}
{
 "HealthKitSampleKey":"1669ad87-edae-5090-afb1-a70abf17db28",
 "ParticipantIdentifier":"e794c47e-438e-4d7b-9b24-99ce68c75300",
 "DeletedDate":"2021-11-05T14:20:12Z"
}

 

Apple HealthKit calculates both Resting Energy and Active Energy using a user’s weight, height, sex, and age. Resting Energy represents the calories burned while sleeping or being sedentary, while Active Energy reflects the calories burned through physical activity. Sample intervals are defined by the start and end times of Active Energy on the device. Noncontiguous samples are common in Apple HealthKit data. Gaps indicate periods of Resting Energy, meaning the user was either inactive during that time or not wearing their device.