Skip to main content

Resting heart rate

Use this category for a numeric resting heart-rate value.

Support in @ovok/core​

  • Category key: restingHeartRate (resting-heart-rate)
  • 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
restingHeartRatenumber (optional)bpmMapped and saved as a numeric value; whole-number precision.

Value handling​

Supply the source value in bpm. The SDK stores the reading as provided and does not derive resting heart rate from ordinary heart-rate readings.

Read this category​

Select MeasurementTypeKey.restingHeartRate. The mapper returns restingHeartRate for matching observations.

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 restingHeartRate in bpm and use request-level effectiveDateTime for the observation time.

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 saveRestingHeartRate() {
  return client.saveMeasurement({
    measurement: {
      measurementTypeKey: MeasurementTypeKey.restingHeartRate,
      restingHeartRate: 61,
    },
    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.