Skip to main content

VO₂ max

Use this category for a numeric VO₂ max value.

Support in @ovok/core​

  • Category key: vo2Max (vo2-max)
  • 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
vo2Maxnumber (optional)mL/kg/minMapped and saved as a numeric value; one decimal place on save.

Value handling​

Supply the value in millilitres per kilogram per minute. The SDK stores the provided value and does not calculate VO₂ max from exercise or heart-rate data.

Read this category​

Select MeasurementTypeKey.vo2Max. The mapped field is named vo2Max.

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 vo2Max in mL/kg/min 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 saveVo2Max() {
  return client.saveMeasurement({
    measurement: {
      measurementTypeKey: MeasurementTypeKey.vo2Max,
      vo2Max: 42.3,
    },
    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.