Articles in this section

See more

[Legacy] Apple HealthKit Characteristics Export Format

  • Updated
Follow
Please note that the Apple HealthKit Characteristics Export Format is a legacy export and we recommend using the Apple HealthKitV2 Characteristics Export Format. This article should only be used for legacy exports, created prior to 11-April-2022.

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

Table of Contents

Data Fields

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 CSV Export

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

Sample JSON Export

{
  "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"
}

Related articles