Get Wearables Summary

Overview

get_wearables_summary retrieves health data from consumer wearable devices and fitness trackers — Fitbit, Apple
Watch, Apple Health, Garmin, Samsung Health, Withings, Oura, and Whoop — via a Validic integration. Use it for
steps/walking distance, activity/exercise, and other device-reported metrics. For the same kinds of metrics
recorded clinically by a healthcare provider instead, use get_vitals.

Required Parameters

None — all parameters are optional (though person_id is effectively required unless derivable from the token).

Optional Parameters

person_id (string)

Default: None
The FHIR identifier (patient ID) of the person whose wearable data is to be retrieved. Extracted from the access token if not provided.

wearables (list of exact metric names from the FHIR_WEARABLES literal, e.g. 'Steps', 'Heart Rate', 'Blood Pressure', 'Body Weight', 'SpO2')

Default: None (all available wearable metrics)
Invalid names are ignored (logged, or reported via ctx.info when debug=true); if every provided name is invalid, all metrics are returned instead.

start_date / end_date (date, YYYY-MM-DD)

Default: None
Inclusive date bounds. No bound applied if omitted.

cardiovascular_score (integer, 0–100)

Default: None
Optional M2-calculated cardiovascular system score to give the clinical summary context on heart-health metrics (90–100 Excellent, 75–89 Good, 60–74 Fair, <60 Critical).

sleep_score (integer, 0–100)

Default: None
Optional M2-calculated sleep/circadian system score to give the clinical summary context on sleep quality (same scale as above).

count (integer)

Default: 500
Number of raw FHIR Observation records to fetch. Minimum of 500 automatically enforced (wearables generate high-frequency data) — use 500–1000 for daily summaries, 1000–5000 for weekly/monthly trends, 5000+ for comprehensive historical analysis.

output_formats (list of output format strings)

Default: ["statistics"]
Wearables summaries always return a structured statistical payload (ranges, medians, data density, trend direction) regardless of requested format; other values are accepted for compatibility only.

ignore_cache (boolean)

Default: false
If true, bypasses any cached data and fetches fresh records from the FHIR server.

debug (boolean)

Default: false
Enable to include additional diagnostic information in the response.

Returns

FhirRecordRetrievalOutput — a result field containing the wearables summary data as a string.