stanfordbdhg/healthkitonomh

Installation

HealthKitOnOMH can be installed into your Xcode project using Swift Package Manager.

1. In Xcode 14 and newer (requires Swift 5.7), go to “File” » “Add Packages...”
2. Enter the URL to this GitHub repository, then select the HealthKitOnOMH package to install.

Usage

The HealthKitonOMH library provides extensions that convert supported HealthKit samples into corresponding IEEE Standard 1752.1 and Open mHealth (OMH) schemas.

let sample: HKQuantitySample = // ...
let dataPoint: DataPoint<HealthKitQuantitySample> = try sample.omhDataPoint

Example

In the following example, we will query the HealthKit store for step count data, convert the resulting samples to Open mHealth data points based on the omh:heart-rate schema.

import HealthKitOnOMH

// Initialize an HKHealthStore instance and request permissions with it
// ...

// Or create a HealthKit sample
let date = ISO8601DateFormatter().date(from: "1885-11-11T00:00:00-08:00") ?? .now
let sample = HKQuantitySample(
    type: HKQuantityType(.heartRate),
    quantity: HKQuantity(unit: HKUnit.count().unitDivided(by: .minute()), doubleValue: 42.0),
    start: date,
    end: date
)

// Convert the sample into an Open mHealth (OMH) Data Point
let json: String
do {
    guard let omhDataPoint = try sample.omhDataPoint as? any DataPoint<HeartRate> else {
        return
    }
            
    // Encode the data point as JSON
    let encoder = JSONEncoder()
    encoder.outputFormatting = [.prettyPrinted, .withoutEscapingSlashes, .sortedKeys]
    
    // Note that Open mHealth uses snake case for its properties when represented in JSON
    encoder.keyEncodingStrategy = .convertToSnakeCase
            
    let data = try encoder.encode(omhDataPoint)
            
    json = String(decoding: data, as: UTF8.self)
} catch {
    // Handle any errors here.
    // ...
}

The above code will produce the following JSON in conformance with Open mHealth's heart-rate schema:

{
  "body" : {
    "effective_time_frame" : {
      "time_interval" : {
        "end_date_time" : {
          "value" : "1885-11-11T08:00:00Z"
        },
        "start_date_time" : {
          "value" : "1885-11-11T08:00:00Z"
        }
      }
    },
    "heart_rate" : {
      "unit" : "beats/min",
      "value" : 42
    }
  },
  "header" : {
    "creation_date_time" : {
      "value" : "2023-10-11T11:53:30Z"
    },
    "id" : "FF7F647D-8757-4926-871A-3D61DDCD0900",
    "schema_id" : {
      "name" : "heart-rate",
      "namespace" : "omh",
      "version" : "2.0"
    }
  }
}

Supported Types

|HKQuantityType|Supported|Open mHealth / IEEE 1752 schema| |-------------|:---------:|-------------| | HKQuantityTypeIdentifierBodyTemperature | :white_check_mark: | omh:body-temperature:3.x | | HKCorrelationTypeIdentifierBloodPressure | :white_check_mark: | omh:blood-pressure:3.x | | HKQuantityTypeIdentifierBloodGlucose | :white_check_mark: | omh:blood-glucose:3.x | | HKQuantityTypeIdentifierBodyFatPercentage | :white_check_mark: | omh:body-fat-percentage:1.x | | HKQuantityTypeIdentifierBodyMass | :white_check_mark: | omh:body-weight:2.x | | HKQuantityTypeIdentifierBodyMassIndex | :white_check_mark: | omh:body-mass-index:1.x | | HKQuantityTypeIdentifierBodyTemperature | :white_check_mark: | omh:body-temperature:3.x | | HKQuantityTypeIdentifierHeartRate | :white_check_mark: | omh:heart-rate:2.x | | HKQuantityTypeIdentifierHeight | :white_check_mark: | omh:body-height:1.x | | HKQuantityTypeIdentifierOxygenSaturation | :white_check_mark: | omh:oxygen-saturation:2.x | | HKQuantityTypeIdentifierRespiratoryRate | :white_check_mark: | omh:respiratory-rate:2.x | | HKQuantityTypeIdentifierStepCount | :white_check_mark: | omh:step-count:3.x |

License

This project is licensed under the MIT License. See Licenses for more information.

Contributors

This project is developed as part of the Stanford Biodesign for Digital Health projects at Stanford. See CONTRIBUTORS.md for a full list of all HealthKitOnOMH contributors.

Notices

HealthKit is a registered trademark of Apple, Inc.

[Stanford Byers Center for Biodesign Logo] [Stanford Byers Center for Biodesign Logo]

Package Metadata

Repository: stanfordbdhg/healthkitonomh

Default branch: main

README: README.md