Get Vitals

Overview

get_vitals retrieves vital signs from clinical/EHR sources (doctor visits, hospital stays, clinic measurements) —
blood pressure, heart rate, temperature, respiratory rate, oxygen saturation (SpO2), pulse, body weight, height,
BMI, and other physiological measurements recorded by healthcare providers. For the same metrics captured by a
consumer wearable device instead, use get_wearables_summary.

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 vital signs are to be retrieved. Extracted from the access token if not provided.

vitals (list of strings, e.g. blood_pressure, heart_rate, temperature, respiratory_rate, oxygen_saturation)

• Default: None (all available vital signs)
• Filters to specific vital sign types.

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

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

count (integer)

• Default: the environment's observations_default_count
• Number of raw FHIR records to fetch before filtering. Minimum of 300 automatically enforced; increase to 1000–5000 for comprehensive historical searches.

output_formats (list of table | timeline | statistics | csv | markdown)

• Default: ["table", "statistics"]
• table for detailed records, statistics for aggregated insights, timeline for chronological view, csv for export, markdown for documentation. Multiple formats can be combined.

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 retrieved vitals data as a string, formatted per output_formats.