Create library for representing Health Connect data in IEEE 1752 Open mHealth

HealthConnectOnOMH/.gitignore

@@ -0,0 +1 @@
+/build

HealthConnectOnOMH/build.gradle.kts

@@ -0,0 +1,44 @@
+plugins {
+    id("com.android.library")
+    id("org.jetbrains.kotlin.android")
+}
+
+android {
+    namespace = "edu.stanford.healthconnectonomh"
+    compileSdk = 33
+
+    defaultConfig {
+        minSdk = 26
+
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+        consumerProguardFiles("consumer-rules.pro")
+    }
+
+    buildTypes {
+        release {
+            isMinifyEnabled = false
+            proguardFiles(
+                getDefaultProguardFile("proguard-android-optimize.txt"),
+                "proguard-rules.pro"
+            )
+        }
+    }
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+    kotlinOptions {
+        jvmTarget = "1.8"
+    }
+}
+
+dependencies {
+
+    implementation("androidx.core:core-ktx:1.9.0")
+    implementation("androidx.appcompat:appcompat:1.6.1")
+    implementation("com.google.android.material:material:1.8.0")
+    implementation("androidx.health.connect:connect-client:1.1.0-alpha02")
+    testImplementation("junit:junit:4.13.2")
+    androidTestImplementation("androidx.test.ext:junit:1.1.5")
+    androidTestImplementation("androidx.test.espresso:espresso-core:3.5.1")
+}

HealthConnectOnOMH/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

HealthConnectOnOMH/src/androidTest/java/edu/stanford/healthconnectonomh/ExampleInstrumentedTest.kt

@@ -0,0 +1,24 @@
+package edu.stanford.healthconnectonomh
+
+import androidx.test.platform.app.InstrumentationRegistry
+import androidx.test.ext.junit.runners.AndroidJUnit4
+
+import org.junit.Test
+import org.junit.runner.RunWith
+
+import org.junit.Assert.*
+
+/**
+ * Instrumented test, which will execute on an Android device.
+ *
+ * See [testing documentation](http://d.android.com/tools/testing).
+ */
+@RunWith(AndroidJUnit4::class)
+class ExampleInstrumentedTest {
+    @Test
+    fun useAppContext() {
+        // Context of the app under test.
+        val appContext = InstrumentationRegistry.getInstrumentation().targetContext
+        assertEquals("edu.stanford.healthconnectonomh.test", appContext.packageName)
+    }
+}

HealthConnectOnOMH/src/main/AndroidManifest.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+
+</manifest>

HealthConnectOnOMH/src/main/java/edu/stanford/healthconnectonomh/converter/HealthConnectToOMH.kt

@@ -0,0 +1,42 @@
+package edu.stanford.healthconnectonomh.converter
+
+import androidx.health.connect.client.records.Record
+import androidx.health.connect.client.records.StepsRecord
+import edu.stanford.healthconnectonomh.omhmodels.DataPoint
+import edu.stanford.healthconnectonomh.omhmodels.Header
+import edu.stanford.healthconnectonomh.omhmodels.StartEndTimeInterval
+import edu.stanford.healthconnectonomh.omhmodels.StepCount
+import edu.stanford.healthconnectonomh.omhmodels.StepCountUnit
+import edu.stanford.healthconnectonomh.omhmodels.StepCountUnitValue
+import edu.stanford.healthconnectonomh.omhmodels.TimeIntervalTimeFrame
+import java.time.ZoneOffset
+import java.util.UUID
+
+fun Record.toOMHDataPoint(): DataPoint? {
+    val schema = when(this) {
+        is StepsRecord -> {
+            StepCount(
+                stepCount = StepCountUnitValue(unit = StepCountUnit.STEPS, value = this.count.toDouble()),
+                effectiveTimeFrame = TimeIntervalTimeFrame(
+                    StartEndTimeInterval(
+                        this.startTime.atOffset(ZoneOffset.UTC),
+                        this.endTime.atOffset(ZoneOffset.UTC)
+                    )
+                )
+            )
+        }
+        else -> null
+    }
+
+    return schema?.let {
+        val timeInterval = schema.effectiveTimeFrame as TimeIntervalTimeFrame
+        DataPoint(
+            header = Header(
+                uuid = UUID.randomUUID(),
+                schemaId = schema.schemaId,
+                sourceCreationDateTime = (timeInterval.timeInterval as StartEndTimeInterval).startDateTime
+            ),
+            body = it
+        )
+    }
+}

HealthConnectOnOMH/src/main/java/edu/stanford/healthconnectonomh/omhmodels/DataPoint.kt

@@ -0,0 +1,8 @@
+package edu.stanford.healthconnectonomh.omhmodels
+
+
+
+data class DataPoint(
+    val header: Header,
+    val body: Schema
+)

HealthConnectOnOMH/src/main/java/edu/stanford/healthconnectonomh/omhmodels/DateTime.kt

@@ -0,0 +1,5 @@
+package edu.stanford.healthconnectonomh.omhmodels
+
+import java.time.OffsetDateTime
+
+typealias DateTime = OffsetDateTime

HealthConnectOnOMH/src/main/java/edu/stanford/healthconnectonomh/omhmodels/DescriptiveStatistic.kt

@@ -0,0 +1,29 @@
+package edu.stanford.healthconnectonomh.omhmodels
+
+enum class DescriptiveStatistic(
+    private val customSchemaValue: String? = null
+) : SchemaEnumValue, Schema {
+    AVERAGE,
+    COUNT,
+    MAXIMUM,
+    MEDIAN,
+    MINIMUM,
+    STANDARD_DEVIATION,
+    SUM,
+    VARIANCE,
+    TWENTIETH_PERCENTILE("20th percentile"),
+    EIGHTIETH_PERCENTILE("80th percentile"),
+    LOWER_QUARTILE,
+    UPPER_QUARTILE,
+    QUARTILE_DEVIATION,
+    FIRST_QUINTILE("1st quintile"),
+    SECOND_QUINTILE("2nd quintile"),
+    THIRD_QUINTILE("3rd quintile"),
+    FOURTH_QUINTILE("4th quintile");
+
+    override val schemaValue: String
+        get() = customSchemaValue ?: name.lowercase().replace("_", " ")
+
+    override val schemaId: SchemaId
+        get() = SchemaId(IEEE_NAMESPACE.value, "descriptive-statistic", "1.0")
+}

HealthConnectOnOMH/src/main/java/edu/stanford/healthconnectonomh/omhmodels/DurationUnit.kt

@@ -0,0 +1,19 @@
+package edu.stanford.healthconnectonomh.omhmodels
+
+enum class DurationUnit(
+    override val schemaValue: String
+) : Unit {
+    PICOSECOND("ps"),
+    NANOSECOND("ns"),
+    MICROSECOND("us"),
+    MILLISECOND("ms"),
+    SECOND("sec"),
+    MINUTE("min"),
+    HOUR("h"),
+    DAY("d"),
+    WEEK("wk"),
+    MONTH("Mo"),
+    YEAR("yr");
+}
+
+typealias DurationUnitValue = TypedUnitValue<DurationUnit>

HealthConnectOnOMH/src/main/java/edu/stanford/healthconnectonomh/omhmodels/Header.kt

@@ -0,0 +1,17 @@
+package edu.stanford.healthconnectonomh.omhmodels
+
+import java.util.*
+
+data class Header(
+    val uuid: UUID,
+    val schemaId: SchemaId,
+    val sourceCreationDateTime: DateTime,
+    val modality: Modality? = null,
+    val externalDatasheets: List<Datasheet>? = null
+) {
+    data class Datasheet(
+        val datasheetType: String? = null,
+        val datasheetReference: String
+    )
+}
+

HealthConnectOnOMH/src/main/java/edu/stanford/healthconnectonomh/omhmodels/Modality.kt

@@ -0,0 +1,6 @@
+package edu.stanford.healthconnectonomh.omhmodels
+
+enum class Modality {
+    SENSED,
+    SELF_REPORTED
+}

HealthConnectOnOMH/src/main/java/edu/stanford/healthconnectonomh/omhmodels/Schema.kt

@@ -0,0 +1,5 @@
+package edu.stanford.healthconnectonomh.omhmodels
+
+interface Schema {
+    val schemaId: SchemaId
+}

HealthConnectOnOMH/src/main/java/edu/stanford/healthconnectonomh/omhmodels/SchemaEnumValue.kt

@@ -0,0 +1,5 @@
+package edu.stanford.healthconnectonomh.omhmodels
+
+interface SchemaEnumValue {
+    val schemaValue: String
+}

HealthConnectOnOMH/src/main/java/edu/stanford/healthconnectonomh/omhmodels/SchemaId.kt

@@ -0,0 +1,50 @@
+package edu.stanford.healthconnectonomh.omhmodels
+
+import java.util.regex.Pattern
+
+/**
+ * A schema identifier. It consists of a namespace, a name, and a version. A schema identifier unambiguously identifies
+ * a single, immutable schema. The namespace is used to avoid naming collisions in schemas written by different groups
+ * or organisations.
+ *
+ * @author Emerson Farrugia
+ * @version 1.0
+ * @see [schema-id](https://www.openmhealth.org/documentation/#/schema-docs/schema-library/schemas/omh_schema-id)
+ */
+
+data class SchemaId(
+    val namespace: SchemaNamespace = OMH_NAMESPACE,
+    val name: SchemaName,
+    val version: SchemaVersion
+) : Comparable<SchemaId> {
+
+    constructor(namespace: String, name: String, version: String) : this(
+        namespace = SchemaNamespace(namespace),
+        name = SchemaName(name),
+        version = SchemaVersion.fromString(version)
+    )
+
+    companion object {
+        val PATTERN: Pattern = Pattern.compile("([^:]+):([^:]+):([^:]+)")
+
+        fun fromString(id: String): SchemaId {
+            val matcher = PATTERN.matcher(id)
+            require(matcher.matches()) { "A malformed schema ID has been specified." }
+
+            return SchemaId(
+                namespace = matcher.group(1),
+                name = matcher.group(2),
+                version = matcher.group(3)
+            )
+        }
+
+        private val comparator = compareBy<SchemaId> { it.namespace }
+            .thenBy { it.name }
+            .thenBy { it.version }
+    }
+
+    override fun toString(): String = "$namespace:$name:$version"
+
+    override fun compareTo(other: SchemaId): Int =
+        comparator.compare(this, other)
+}

HealthConnectOnOMH/src/main/java/edu/stanford/healthconnectonomh/omhmodels/SchemaName.kt

@@ -0,0 +1,34 @@
+package edu.stanford.healthconnectonomh.omhmodels
+
+import java.util.regex.Pattern
+
+/**
+ * A schema name, which uniquely [identifies][SchemaId] a schema when combined with a [SchemaNamespace] and [SchemaVersion].
+ *
+ * @author Emerson Farrugia
+ */
+
+@JvmInline
+value class SchemaName(
+    val value: String
+) : Comparable<SchemaName> {
+
+    init {
+        require(isValid(value)) { "A malformed name has been specified." }
+    }
+
+    companion object {
+        private const val PATTERN_STRING = "[a-zA-Z0-9-]+"
+        private val PATTERN: Pattern = Pattern.compile(PATTERN_STRING)
+
+        fun isValid(string: String?): Boolean =
+            string
+                ?.let { PATTERN.matcher(it).matches() }
+                ?: true
+    }
+
+    override fun toString(): String = value
+
+    override fun compareTo(other: SchemaName): Int =
+        value.compareTo(other.value)
+}