Articles in this section

See more

[Legacy] Apple HealthKit Clinical Record Data Format

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

The HealthKit Clinical Record export file contains records obtained from the participant's healthcare provider. This data is only available when your project has enabled Clinical Data capture, and the participant has linked Apple Health with their provider's Electronic Medical Record (EMR) system.

Each entry in the Clinical Record export contains a single clinical record item, e.g., a single allergy, condition or procedure result.

Table of Contents

Data Fields

Field Description
HealthKitClinicalRecordKey A unique, auto-generated key for this record.
ParticipantIdentifier The identifier of the participant this task was for. Can be used to cross reference with Participants.
Type Identifies the type of clinical record, e.g., ClinicalLabResult, ClinicalProcedure. Note that Clinical Condition has a space in the type name, but the others do not.
Date The date Apple Health received the data from the provider, in ISO 8601 format. Includes timezone offset information.
Resource Record data received from Apple Health. See Resource Fields, below.
InsertedDate The date MyDataHelps received the data from Apple Health, in ISO 8601 format. Includes timezone offset information.
Source Information about the source system.
  • Identifier - Apple's unique identifier for the provider's system.
  • Name - The name of the provider's system.
  • Version - The OS version on the participant's device when Apple Health received the record.

 

HealthKit Clinical Records are only available in JSON format.

Resource Fields

The bulk of the clinical data is contained in the Resource field, a JSON string containing the following fields:

Field Description
SourceUrl Indicates the URL of the provider's system.
Type The resource type represented by the Data field.
Identifier A unique identifier for this record in the provider's system.
Data The FHIR (Fast Healthcare Interoperability Resources) data for the record, received from the provider's system. For detailed help interpreting the data, see the FHIR specification. The Type field tells you which FHIR resource this record contains. For example, a ClinicalLabResult record might contain an Observation Resource, while a ClinicalAllergy record might contain an Allergy Intolerance Resource.

Sample JSON Export

{
  "HealthKitClinicalRecordKey": "8D88374A-BB8B-E911-8179-925A5DCDFB35",
  "ParticipantIdentifier": "de9e12b8-b78b-e911-8179-925a5dcdfb35",
  "Type": "ClinicalAllergy",
  "Date": "2019-06-10T12:48:03-07:00",
  "Resource": {
    "SourceUrl": "https://localhost:9090/resource/AllergyIntolerance/2",
    "Data": {
      "id": "2",
      "recordedDate": "2015-02-18",
      "resourceType": "AllergyIntolerance",
      "substance": {
        "text": "Peanuts",
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "256349002"
          }
        ]
      },
      "patient": {
        "display": "John Doe",
        "reference": "Patient/1"
      },
      "reaction": [
        {
          "manifestation": [
            {
              "text": "Wheezing"
            }
          ],
          "severity": "severe"
        }
      ]
    },
    "Identifier": "2",
    "Type": "AllergyIntolerance"
  },
  "Source": {
    "Identifier": "com.apple.public.health.clinical.B0734C79-CD39-D049-84F6-CBE9A5629AB8",
    "Name": "Sample Location A",
    "Version": "12.2"
  },
  "InsertedDate": "2019-06-10T20:06:55Z"
}

{
  "HealthKitClinicalRecordKey": "558B374A-BB8B-E911-8179-925A5DCDFB35",
  "ParticipantIdentifier": "de9e12b8-b78b-e911-8179-925a5dcdfb35",
  "Type": "ClinicalVitalSign",
  "Date": "2019-06-10T12:48:03-07:00",
  "Resource": {
    "SourceUrl": "https://localhost:9090/resource/Observation/4",
    "Data": {
      "category": {
        "text": "Vital Signs",
        "coding": [
          {
            "system": "http://hl7.org/fhir/observation-category",
            "code": "vital-signs"
          }
        ]
      },
      "issued": "2017-03-18T00:00:00Z",
      "status": "final",
      "id": "4",
      "code": {
        "text": "BMI-body mass index",
        "coding": [
          {
            "system": "http://loinc.org",
            "code": "39156-5"
          }
        ]
      },
      "encounter": {
        "reference": "Encounter/355"
      },
      "valueQuantity": {
        "code": "kg/m^2",
        "system": "http://unitsofmeasure.org",
        "value": 26.2,
        "unit": "kg/m^2"
      },
      "resourceType": "Observation"
    },
    "Identifier": "4",
    "Type": "Observation"
  },
  "Source": {
    "Identifier": "com.apple.public.health.clinical.B0734C79-CD39-D049-84F6-CBE9A5629AB8",
    "Name": "Sample Location A",
    "Version": "12.2"
  },
  "InsertedDate": "2019-06-10T20:06:57Z"
}

Related articles