RKStudio™
User Guide

HealthKit Data

HealthKit data is collected passively when a participant uses the MyDataHelps app, if you have enabled it for your project.

The data coming from HealthKit comes in multiple shapes and sizes, and there are multiple exports tailored to each of them:

HealthKit Samples

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

Field Description
HealthKitSampleKey A unique, auto-generated key for this sample.
ParticipantIdentifier The identifier of the participant this sample was recorded for. Can be used to cross reference with Participants.
Type The data type - e.g. “Steps”, “HeartRate.”
StartDate The start date of the recording, in ISO 8601 format. Includes timezone offset information. May be empty if no start date was recorded.
Date The end date of the recording, in ISO 8601 format. Includes timezone offset information.
Value The recorded value.
Units The units for the corresponding value.
SourceIdentifier Uniquely identifies the iOS App which generated the reading. “com.apple.health.*” indicates a reading from an Apple Device like the iPhone or Apple Watch.
SourceName The name of the source app which generated the reading. In the case of a “com.apple.health.*SourceIdentifier, this is the name of the Apple Device used to generate the reading (e.g. “Chris’ iPhone”).
SourceVersion The version of the source app which generated the reading. In the case of a “com.apple.health.*SourceIdentifier, this is the version of iOS or WatchOS on the device used to generate the reading.
DeviceName The user-facing name for the device, if applicable.
DeviceModel Model of the device used the generate the reading, if applicable.
DeviceManufacturer Manufacturer of the device used the generate the reading, if applicable.
DeviceHardwareVersion An arbitrary string representing the hardware version of the device, if applicable.
DeviceSoftwareVersion An arbitrary string representing the version of the software running on the device, if applicable.
DeviceFirmwareVersion An arbitrary string representing the current version of the firmware running on the device, if applicable.
DeviceLocalIdentifier An identifier that uniquely identifies the device object on the hardware running this code, if applicable.
DeviceFDAIdentifier The device identifier portion of the US Food and Drug Administration’s Unique Device Identifier (UDI), if applicable.
Metadata Additional XML metadata inserted by the source application.
InsertedDate The creation date of the entry, in ISO 8601 format. Is always in UTC.

HealthKit Activity Summaries

HealthKit activity summaries are generated by the Apple Watch and are the data behind the activity rings used to encourage Apple Watch users to stand, exercise, and move around.

Activity Summaries are captured on a daily basis—each activity summary covers a single day.

Field Description
HealthKitActivitySummaryKey A unique, auto-generated key for the activity summary.
ParticipantIdentifier The identifier of the participant the activity summary is for. Can be used to cross reference with Participants.
StartDate The start date of the activity summary, in ISO 8601 format. Includes timezone offset information. May be empty if no start date was recorded.
EndDate The end date of the activity summary, in ISO 8601 format. Includes timezone offset information.
ActiveEnergyBurned The active energy burned recorded by the Apple Watch, in kcal.
ActiveEnergyBurnedGoal The goal for ActiveEnergyBurned the participant set for themselves.
AppleExerciseTime The total exercise time recorded by the Apple Watch, in minutes.
AppleExerciseTimeGoal The goal for AppleExerciseTime the participant set for themselves.
AppleStandHours The number of hours in the day during which the participant stood up for at least 1 minute.
AppleStandHoursGoal The goal for AppleStandHours the participant set for themselves.
InsertedDate The creation date of the entry, in ISO 8601 format. Is always in UTC.

HealthKit Workouts

Workouts in HealthKit have a unique data structure for capturing information specific to the participant’s workout.

Field Description
HealthKitWorkoutKey A unique, auto-generated key for this workout.
ParticipantIdentifier The identifier of the participant this task was for. Can be used to cross reference with Participants.
ActivityType The type of activity undertaken during the workout.
StartDate The start date of the workout, in ISO 8601 format. Includes timezone offset information. May be empty if no start date was recorded.
Date The end date of the workout, in ISO 8601 format. Includes timezone offset information.
Duration The duration of the workout, in seconds (if recorded).
TotalDistance The distance traveled during the workout, in meters (if recorded).
TotalEnergyBurned The energy burned during the workout, in kcal (if recorded).
TotalFlightsClimbed The flights of stairs climbed during the workout (if recorded).
TotalSwimmingStrokeCount The number of swimming strokes during the workout (if recorded).
SourceIdentifier Uniquely identifies the iOS App which generated the reading. “com.apple.health.*” indicates a reading from an Apple Device like the iPhone or Apple Watch.
SourceName The name of the source app which generated the reading. In the case of a “com.apple.health.*SourceIdentifier, this is the name of the Apple Device used to generate the reading (e.g. “Chris’ iPhone”).
SourceVersion The version of the source app which generated the reading. In the case of a “com.apple.health.*SourceIdentifier, this is the version of iOS or WatchOS on the device used to generate the reading.
DeviceName The user-facing name for the device, if applicable.
DeviceModel Model of the device used the generate the reading, if applicable.
DeviceManufacturer Manufacturer of the device used the generate the reading, if applicable.
DeviceHardwareVersion An arbitrary string representing the hardware version of the device, if applicable.
DeviceSoftwareVersion An arbitrary string representing the version of the software running on the device, if applicable.
DeviceFirmwareVersion An arbitrary string representing the current version of the firmware running on the device, if applicable.
DeviceLocalIdentifier An identifier that uniquely identifies the device object on the hardware running this code, if applicable.
DeviceFDAIdentifier The device identifier portion of the US Food and Drug Administration’s Unique Device Identifier (UDI), if applicable.
Metadata Additional XML metadata inserted by the source application.
InsertedDate The creation date of the entry, in ISO 8601 format. Is always in UTC.

HealthKit Characteristics

HealthKit Characteristics represent data that does not typically change over time, like date of birth.

Field Description
HealthKitCharacteristicKey A unique, auto-generated key for this characteristic.
ParticipantIdentifier The identifier of the participant this task was for. Can be used to cross reference with Participants.
Date The date the characteristic was recorded, in ISO 8601 format. Includes timezone offset information.
Value The characteristic’s value. May be a date (in ISO 8601 format), a yes/no selection, a number or a text field.
InsertedDate The creation date of the entry, in ISO 8601 format. Is always in UTC.
ModifiedDate The date the entry was last modified, in ISO 8601 format. Is always in UTC.

Sample Export

HealthKit Samples

HealthKitSampleKey,ParticipantIdentifier,StartDate,Date,Type,Value,Units,SourceIdentifier,SourceName,SourceVersion,DeviceName,DeviceModel,DeviceManufacturer,DeviceHardwareVersion,DeviceSoftwareVersion,DeviceFirmwareVersion,DeviceFDAIdentifier,DeviceLocalIdentifier,Metadata,InsertedDate
85e40b42-ba54-e811-8162-e6c7223c41fa,f5e23bf1-29d6-437e-b7e0-4d9bbeea4eaa,2018-04-30T17:00:57-04:00,2018-04-30T17:07:52-04:00,Steps,18,count,com.apple.health.89E9CCE0-ECE6-4B9E-B684-23AA6A979FA1,CE Test iPhone 6S+,11.3,iPhone,iPhone,Apple,"iPhone8,2",11.3,,,,{},2018-05-11T01:26:00Z
86e40b42-ba54-e811-8162-e6c7223c41fa,f5e23bf1-29d6-437e-b7e0-4d9bbeea4eaa,2018-04-30T17:46:04-04:00,2018-04-30T17:54:27-04:00,Steps,248,count,com.apple.health.89E9CCE0-ECE6-4B9E-B684-23AA6A979FA1,CE Test iPhone 6S+,11.3,iPhone,iPhone,Apple,"iPhone8,2",11.3,,,,{},2018-05-11T01:26:00Z
87e40b42-ba54-e811-8162-e6c7223c41fa,f5e23bf1-29d6-437e-b7e0-4d9bbeea4eaa,2018-04-30T17:54:27-04:00,2018-04-30T18:02:06-04:00,Steps,47,count,com.apple.health.89E9CCE0-ECE6-4B9E-B684-23AA6A979FA1,CE Test iPhone 6S+,11.3,iPhone,iPhone,Apple,"iPhone8,2",11.3,,,,{},2018-05-11T01:26:00Z

HealthKit Activity Summaries

HealthKitActivitySummaryKey,ParticipantIdentifier,StartDate,EndDate,ActiveEnergyBurned,ActiveEnergyBurnedGoal,AppleExerciseTime,AppleExerciseTimeGoal,AppleStandHours,AppleStandHoursGoal,InsertedDate
6077d380-b954-e811-8162-e6c7223c41fa,8d87da94-ed15-4be3-a69a-41f6c6cfcfef,2018-04-17T00:00:00-04:00,2018-04-17T23:59:59-04:00,1966.522,890,327,30,6,12,2018-05-11T01:20:35Z
6277d380-b954-e811-8162-e6c7223c41fa,8d87da94-ed15-4be3-a69a-41f6c6cfcfef,2018-04-15T00:00:00-04:00,2018-04-15T23:59:59-04:00,0,890,0,30,0,12,2018-05-11T01:20:35Z
6177d380-b954-e811-8162-e6c7223c41fa,8d87da94-ed15-4be3-a69a-41f6c6cfcfef,2018-04-16T00:00:00-04:00,2018-04-16T23:59:59-04:00,4952.519,890,805,30,14,12,2018-05-11T01:20:35Z

HealthKit Workouts

HealthKitWorkoutKey,ParticipantIdentifier,ActivityType,StartDate,Date,Duration,TotalDistance,TotalEnergyBurned,TotalFlightsClimbed,TotalSwimmingStrokeCount,SourceIdentifier,SourceName,SourceVersion,DeviceName,DeviceModel,DeviceManufacturer,DeviceHardwareVersion,DeviceSoftwareVersion,DeviceFirmwareVersion,DeviceFDAIdentifier,DeviceLocalIdentifier,Metadata,InsertedDate
f0f972f4-b954-e811-8162-e6c7223c41fa,9205a702-423c-e811-815e-eba90450b141,Running,2018-04-06T12:10:12-04:00,2018-04-06T12:45:26-04:00,2114.32899594307,863.642877342056,102.917,,,com.apple.health.2B62FC19-C73C-4385-987A-9321D7139476,Christopher’s Apple Watch,4.1,,,,,,,,,"{""HKTimeZone"":""America\/Detroit""}",2018-05-11T01:23:53Z
f1f972f4-b954-e811-8162-e6c7223c41fa,9205a702-423c-e811-815e-eba90450b141,Rowing,2018-04-05T15:37:53-04:00,2018-04-05T15:39:40-04:00,107.115283966064,,6.077,,,com.apple.health.2B62FC19-C73C-4385-987A-9321D7139476,Christopher’s Apple Watch,4.1,,,,,,,,,"{""HKTimeZone"":""America\/Detroit""}",2018-05-11T01:23:53Z
f2f972f4-b954-e811-8162-e6c7223c41fa,9205a702-423c-e811-815e-eba90450b141,Running,2018-04-05T15:41:02-04:00,2018-04-05T15:43:39-04:00,151.452096939087,0,3.237,,,com.apple.health.2B62FC19-C73C-4385-987A-9321D7139476,Christopher’s Apple Watch,4.1,,,,,,,,,"{""HKTimeZone"":""America\/Detroit""}",2018-05-11T01:23:53Z

HealthKit Characteristics

HealthKitCharacteristicKey,ParticipantIdentifier,Date,Type,Value,InsertedDate,ModifiedDate
d0971aca-11dd-e811-816b-9e01d28da2ca,b05418f9-31ce-e811-816a-d46e67bc9fa8,2018-11-10T19:21:42-05:00,DateOfBirth,1969-10-17T00:00:00-0400,2018-10-31T13:35:12Z,2018-11-11T00:21:45Z
695D18E8-428A-E811-8166-F4DD8A83AAAC,TST3182602,2018-11-11T10:24:53-05:00,WheelchairUse,No,2018-07-18T04:27:41Z,2018-11-11T15:24:54Z
  

HealthKit Samples

{
  "HealthKitSampleKey": "85E40B42-BA54-E811-8162-E6C7223C41FA",
  "ParticipantIdentifier": "f5e23bf1-29d6-437e-b7e0-4d9bbeea4eaa",
  "Type": "Steps",
  "StartDate": "2018-04-30T17:00:57-04:00",
  "Date": "2018-04-30T17:07:52-04:00",
  "Value": "18",
  "Units": "count",
  "Source": {
    "Identifier": "com.apple.health.89E9CCE0-ECE6-4B9E-B684-23AA6A979FA1",
    "Name": "CE Test iPhone 6S+",
    "Version": "11.3"
  },
  "Device": {
    "Name": "iPhone",
    "Model": "iPhone",
    "Manufacturer": "Apple",
    "HardwareVersion": "iPhone8,2",
    "SoftwareVersion": "11.3"
  },
  "Metadata": {},
  "InsertedDate": "2018-05-11T01:26:00Z"
}

{
  "HealthKitSampleKey": "86E40B42-BA54-E811-8162-E6C7223C41FA",
  "ParticipantIdentifier": "f5e23bf1-29d6-437e-b7e0-4d9bbeea4eaa",
  "Type": "Steps",
  "StartDate": "2018-04-30T17:46:04-04:00",
  "Date": "2018-04-30T17:54:27-04:00",
  "Value": "248",
  "Units": "count",
  "Source": {
    "Identifier": "com.apple.health.89E9CCE0-ECE6-4B9E-B684-23AA6A979FA1",
    "Name": "CE Test iPhone 6S+",
    "Version": "11.3"
  },
  "Device": {
    "Name": "iPhone",
    "Model": "iPhone",
    "Manufacturer": "Apple",
    "HardwareVersion": "iPhone8,2",
    "SoftwareVersion": "11.3"
  },
  "Metadata": {},
  "InsertedDate": "2018-05-11T01:26:00Z"
}

{
  "HealthKitSampleKey": "87E40B42-BA54-E811-8162-E6C7223C41FA",
  "ParticipantIdentifier": "f5e23bf1-29d6-437e-b7e0-4d9bbeea4eaa",
  "Type": "Steps",
  "StartDate": "2018-04-30T17:54:27-04:00",
  "Date": "2018-04-30T18:02:06-04:00",
  "Value": "47",
  "Units": "count",
  "Source": {
    "Identifier": "com.apple.health.89E9CCE0-ECE6-4B9E-B684-23AA6A979FA1",
    "Name": "CE Test iPhone 6S+",
    "Version": "11.3"
  },
  "Device": {
    "Name": "iPhone",
    "Model": "iPhone",
    "Manufacturer": "Apple",
    "HardwareVersion": "iPhone8,2",
    "SoftwareVersion": "11.3"
  },
  "Metadata": {},
  "InsertedDate": "2018-05-11T01:26:00Z"
}

HealthKit Activity Summaries

{
  "HealthKitActivitySummaryKey": "6077D380-B954-E811-8162-E6C7223C41FA",
  "ParticipantIdentifier": "8d87da94-ed15-4be3-a69a-41f6c6cfcfef",
  "StartDate": "2018-04-17T00:00:00-04:00",
  "EndDate": "2018-04-17T23:59:59-04:00",
  "ActiveEnergyBurned": "1966.522",
  "ActiveEnergyBurnedGoal": "890",
  "AppleExerciseTime": "327",
  "AppleExerciseTimeGoal": "30",
  "AppleStandHours": "6",
  "AppleStandHoursGoal": "12",
  "InsertedDate": "2018-05-11T01:20:35Z"
}

{
  "HealthKitActivitySummaryKey": "6277D380-B954-E811-8162-E6C7223C41FA",
  "ParticipantIdentifier": "8d87da94-ed15-4be3-a69a-41f6c6cfcfef",
  "StartDate": "2018-04-15T00:00:00-04:00",
  "EndDate": "2018-04-15T23:59:59-04:00",
  "ActiveEnergyBurned": "0",
  "ActiveEnergyBurnedGoal": "890",
  "AppleExerciseTime": "0",
  "AppleExerciseTimeGoal": "30",
  "AppleStandHours": "0",
  "AppleStandHoursGoal": "12",
  "InsertedDate": "2018-05-11T01:20:35Z"
}

{
  "HealthKitActivitySummaryKey": "6177D380-B954-E811-8162-E6C7223C41FA",
  "ParticipantIdentifier": "8d87da94-ed15-4be3-a69a-41f6c6cfcfef",
  "StartDate": "2018-04-16T00:00:00-04:00",
  "EndDate": "2018-04-16T23:59:59-04:00",
  "ActiveEnergyBurned": "4952.519",
  "ActiveEnergyBurnedGoal": "890",
  "AppleExerciseTime": "805",
  "AppleExerciseTimeGoal": "30",
  "AppleStandHours": "14",
  "AppleStandHoursGoal": "12",
  "InsertedDate": "2018-05-11T01:20:35Z"
}

HealthKit Workouts

{
  "HealthKitWorkoutKey": "F0F972F4-B954-E811-8162-E6C7223C41FA",
  "ParticipantIdentifier": "9205a702-423c-e811-815e-eba90450b141",
  "ActivityType": "Running",
  "StartDate": "2018-04-06T12:10:12-04:00",
  "Date": "2018-04-06T12:45:26-04:00",
  "Duration": "2114.32899594307",
  "TotalDistance": "863.642877342056",
  "TotalEnergyBurned": "102.917",
  "Source": {
    "Identifier": "com.apple.health.2B62FC19-C73C-4385-987A-9321D7139476",
    "Name": "Christopher’s Apple Watch",
    "Version": "4.1"
  },
  "Metadata": {
    "HKTimeZone": "America/Detroit"
  },
  "InsertedDate": "2018-05-11T01:23:53Z"
}

{
  "HealthKitWorkoutKey": "F1F972F4-B954-E811-8162-E6C7223C41FA",
  "ParticipantIdentifier": "9205a702-423c-e811-815e-eba90450b141",
  "ActivityType": "Rowing",
  "StartDate": "2018-04-05T15:37:53-04:00",
  "Date": "2018-04-05T15:39:40-04:00",
  "Duration": "107.115283966064",
  "TotalEnergyBurned": "6.077",
  "Source": {
    "Identifier": "com.apple.health.2B62FC19-C73C-4385-987A-9321D7139476",
    "Name": "Christopher’s Apple Watch",
    "Version": "4.1"
  },
  "Metadata": {
    "HKTimeZone": "America/Detroit"
  },
  "InsertedDate": "2018-05-11T01:23:53Z"
}

{
  "HealthKitWorkoutKey": "F2F972F4-B954-E811-8162-E6C7223C41FA",
  "ParticipantIdentifier": "9205a702-423c-e811-815e-eba90450b141",
  "ActivityType": "Running",
  "StartDate": "2018-04-05T15:41:02-04:00",
  "Date": "2018-04-05T15:43:39-04:00",
  "Duration": "151.452096939087",
  "TotalDistance": "0",
  "TotalEnergyBurned": "3.237",
  "Source": {
    "Identifier": "com.apple.health.2B62FC19-C73C-4385-987A-9321D7139476",
    "Name": "Christopher’s Apple Watch",
    "Version": "4.1"
  },
  "Events": [
    {
      "HealthKitWorkoutEventKey": "43FC72F4-B954-E811-8162-E6C7223C41FA",
      "Date": "2018-04-05T15:41:05-04:00",
      "Type": "Pause",
      "Metadata": {}
    },
    {
      "HealthKitWorkoutEventKey": "45FC72F4-B954-E811-8162-E6C7223C41FA",
      "Date": "2018-04-05T15:41:09-04:00",
      "Type": "Resume",
      "Metadata": {}
    },
    {
      "HealthKitWorkoutEventKey": "44FC72F4-B954-E811-8162-E6C7223C41FA",
      "Date": "2018-04-05T15:41:46-04:00",
      "Type": "Pause",
      "Metadata": {}
    },
    {
      "HealthKitWorkoutEventKey": "46FC72F4-B954-E811-8162-E6C7223C41FA",
      "Date": "2018-04-05T15:41:48-04:00",
      "Type": "Resume",
      "Metadata": {}
    }
  ],
  "Metadata": {
    "HKTimeZone": "America/Detroit"
  },
  "InsertedDate": "2018-05-11T01:23:53Z"
}

HealthKit Characteristics

{
  "HealthKitCharacteristicKey": "d0971aca-11dd-e811-816b-9e01d28da2ca",
  "ParticipantIdentifier": "b05418f9-31ce-e811-816a-d46e67bc9fa8",
  "Type": "DateOfBirth",
  "Date": "2018-11-10T19:21:42-05:00",
  "Value": "1969-10-17T00:00:00-0400",
  "InsertedDate": "2018-10-31T13:35:12Z",
  "ModifiedDate": "2018-11-11T00:21:45Z"
}
{
  "HealthKitCharacteristicKey": "695D18E8-428A-E811-8166-F4DD8A83AAAC",
  "ParticipantIdentifier": "TST3182602",
  "Type": "WheelchairUse",
  "Date": "2018-11-11T10:24:53-05:00",
  "Value": "No",
  "InsertedDate": "2018-07-18T04:27:41Z",
  "ModifiedDate": "2018-11-11T15:24:54Z"
}