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

Apple HealthKitV2 Scored Assessments Export Format

The HealthKit scored assessments export contains standardized clinical questionnaire results recorded in Apple Health (e.g., PHQ-9, GAD-7). Each assessment includes a numeric score, a risk category, and the individual question answers provided by the participant.

Data Structure

Three files will be created per type of assessment (e.g., "PHQ9"). The file names will correspond to the type of assessment (e.g., "HealthKitV2ScoredAssessment_PHQ9_20250601-20250624", "HealthKitV2ScoredAssessment_PHQ9_Answers_20250601-20250624", and "HealthKitV2ScoredAssessment_PHQ9_Deleted_20250601-20250624").

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

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

  • Deleted Assessments: Participants may delete their HealthKit scored assessments from their device. Deleted assessments are tracked in a separate file per assessment type.

 

Scored Assessments

Field Description
HealthKitScoredAssessmentKey A unique, auto-generated key for this scored assessment.
ParticipantIdentifier The identifier of the participant this assessment was recorded for. Can be used to cross reference with Participants.
ParticipantID The stable, automatically generated, internal system identifier for this participant. Universally unique identifier (UUID).
StartDate The start date of the assessment, in ISO 8601 format. Includes timezone offset information.
EndDate The end date of the assessment, in ISO 8601 format. Includes timezone offset information.
Risk The risk category derived from the assessment score (e.g., "NoneToMinimal", "Mild", "Moderate", "ModeratelySevere", "Severe").
Score The total numeric score for the assessment.
InsertedDate The creation date of the entry, in ISO 8601 format. Is always in UTC.

Answers

Field Description
HealthKitScoredAssessmentKey The key of the scored assessment this answer belongs to. Can be used to cross reference with the Scored Assessments file.
ParticipantIdentifier The identifier of the participant this answer was recorded for. Can be used to cross reference with Participants.
ParticipantID The stable, automatically generated, internal system identifier for this participant. Universally unique identifier (UUID).
Index The zero-based index of the question within the assessment.
Answer The participant's response to the question (e.g., "NotAtAll", "SeveralDays", "MoreThanHalfTheDays", "NearlyEveryDay").

Deleted Scored Assessments

Field Description
HealthKitScoredAssessmentKey A unique, auto-generated key for this scored assessment.
ParticipantIdentifier The identifier of the participant this assessment was recorded for. Can be used to cross reference with Participants.
ParticipantID The stable, automatically generated, internal system identifier for this participant. Universally unique identifier (UUID).
DeletedDate The date the assessment was deleted, in ISO 8601 format. Is always in UTC.


CSV Exports

Scored Assessments

HealthKitScoredAssessmentKey,ParticipantIdentifier,StartDate,EndDate,Risk,Score,InsertedDate,ParticipantID
cd19a2f5-ddda-5541-bb89-40abe439ccd2,MDH-3229-1050,2024-12-10T10:30:17-05:00,2024-12-10T10:30:17-05:00,NoneToMinimal,1,2025-06-06T15:44:33Z,539e5aec-e108-f011-b56a-147dda22d041
bc920e60-80f9-5a8c-8b41-988ab07fbd38,MDH-3229-1050,2024-12-11T10:30:17-05:00,2024-12-11T10:30:17-05:00,NoneToMinimal,3,2025-06-06T15:44:33Z,539e5aec-e108-f011-b56a-147dda22d041

Answer

HealthKitScoredAssessmentKey,ParticipantIdentifier,ParticipantID,Index,Answer
cd19a2f5-ddda-5541-bb89-40abe439ccd2,MDH-3229-1050,539e5aec-e108-f011-b56a-147dda22d041,0,NotAtAll
cd19a2f5-ddda-5541-bb89-40abe439ccd2,MDH-3229-1050,539e5aec-e108-f011-b56a-147dda22d041,1,NotAtAll
cd19a2f5-ddda-5541-bb89-40abe439ccd2,MDH-3229-1050,539e5aec-e108-f011-b56a-147dda22d041,2,SeveralDays

Deleted Scored Assessment

HealthKitScoredAssessmentKey,ParticipantIdentifier,DeletedDate,ParticipantID
cd19a2f5-ddda-5541-bb89-40abe439ccd2,MDH-3229-1050,2025-06-06T15:44:44Z,539e5aec-e108-f011-b56a-147dda22d041

 

JSON Exports

Scored Assessments

{
    "HealthKitScoredAssessmentKey": "cd19a2f5-ddda-5541-bb89-40abe439ccd2",
    "ParticipantIdentifier": "MDH-3229-1050",
    "ParticipantID": "539e5aec-e108-f011-b56a-147dda22d041",
    "StartDate": "2024-12-10T10:30:17-05:00",
    "EndDate": "2024-12-10T10:30:17-05:00",
    "InsertedDate": "2025-06-06T15:44:33Z",
    "Risk": "NoneToMinimal",
    "Score": 1,
    "Answers": [
        "NotAtAll",
        "NotAtAll",
        "SeveralDays",
        "NotAtAll",
        "NotAtAll",
        "NotAtAll",
        "NotAtAll",
        "NotAtAll",
        "NotAtAll"
    ]
}
{
    "HealthKitScoredAssessmentKey": "bc920e60-80f9-5a8c-8b41-988ab07fbd38",
    "ParticipantIdentifier": "MDH-3229-1050",
    "ParticipantID": "539e5aec-e108-f011-b56a-147dda22d041",
    "StartDate": "2024-12-11T10:30:17-05:00",
    "EndDate": "2024-12-11T10:30:17-05:00",
    "InsertedDate": "2025-06-06T15:44:33Z",
    "Risk": "NoneToMinimal",
    "Score": 3,
    "Answers": [
        "SeveralDays",
        "SeveralDays",
        "SeveralDays",
        "SeveralDays",
        "NotAtAll",
        "NotAtAll",
        "SeveralDays",
        "NotAtAll",
        "NotAtAll"
    ]
}

Deleted Scored Assessments

{
    "HealthKitScoredAssessmentKey": "cd19a2f5-ddda-5541-bb89-40abe439ccd2",
    "ParticipantIdentifier": "MDH-3229-1050",
    "ParticipantID": "539e5aec-e108-f011-b56a-147dda22d041",
    "DeletedDate": "2025-06-06T15:44:44Z"
}