Connected Devices Module

[PSchmiedmayer]

Use Case

Digital health applications require access to a wide variety of connected devices that can sometimes be connected and paired to a mobile application or can provide their data using a web service-based API. Systems might want to access that data in the user context or by retrieving the data on a web service with the scope of the system to aggregate it independently of a mobile application.

Problem

The Spezi ecosystem currently mainly focuses on access to connected devices using HealthKit. While some connected devices store data within HealthKit, prominent devices do not. These devices include but are not limited to:

• Fitbit: https://dev.fitbit.com/build/reference/web-api/
• Whoop: https://developer.whoop.com/api/#tag/Cycle/operation/getCycleById
• Oura: https://cloud.ouraring.com/docs/

Solution

The Connected Devices Module should be a cross-platform Swift Package that supports iOS, macOS, and Linux to ensure usability across client applications and server-side web services.

Given the cross-platform nature, the SDK should ideally use AsyncHTTPClient as the basis for the work and allow the configuration of the NIO event loop and other injections to ensure a smooth integration into the server-side Swift ecosystem.

The module should contain different sub-targets for the different device types and should ideally provide additional modules that can map each of the gathered observations to HL7 FHIR representations using the Apple FHIR Models SDK.

Alternatives considered

Before implementing all the API connections ourselves, we should do a thorough investigation of existing Swift-based packages that might already integrate with the connected device SDKs or might be able to be reused as dependencies.

Additional context

Please use this issue as a discussion point for more concrete ideas about the structure of the Swift package, its focus and aim, and some first ideas around its API design.

Code of Conduct

• I agree to follow this project's Code of Conduct and Contributing Guidelines