Skip to main content

Walking heart-rate average

Use this category for a numeric average heart rate recorded while walking.

Support in @ovok/core​

  • Category key: walkingHeartRateAverage (walking-heart-rate-average)
  • Read: Supported through the observation mapping.
  • Save: Supported through the typed measurement save workflow.

The category key selects a measurement shape. It does not determine the patient, time range, or source device. For the shared React query and save behavior, see Measurements and health data.

Data shape​

The base measurement requires measurementTypeKey. Fields marked optional can be omitted when the source did not provide a value.

FieldTypeUnit or meaningRead and save behavior
walkingHeartRateAveragenumber (optional)bpmMapped and saved as a numeric value; whole-number precision.

Value handling​

Supply the value in bpm. The SDK does not calculate a walking average from other heart-rate observations. A platform source that does not provide this reading may produce no meaningful value; validate source availability before presenting the category as populated.

Read this category​

Select MeasurementTypeKey.walkingHeartRateAverage. The observation mapper returns numeric matching values as walkingHeartRateAverage.

Use useObservations() in a client-side component below OvokProvider. It returns mapped measurements, original observations, loading, and error. The hook reference describes its filters and state.

Save this category​

Supply the source average in bpm and set request-level effectiveDateTime when known.

Pass the measurement to OvokClient.saveMeasurement() or, in React, the function returned by useSaveMeasurement(). Common request fields such as patientId and device are described in the measurement overview.

Example​

This example uses the configured OvokClient from the get started guide. Supply values in the units listed above.

import { MeasurementTypeKey } from '@ovok/core';

async function saveWalkingHeartRateAverage() {
  return client.saveMeasurement({
    measurement: {
      measurementTypeKey: MeasurementTypeKey.walkingHeartRateAverage,
      walkingHeartRateAverage: 84,
    },
    effectiveDateTime: new Date(),
  });
}

When offline queueing is enabled, inspect the returned status. A queued result means the measurement is pending until the queue is flushed; it is not a completed server save.