Skip to main content

Respiratory rate

Use this category for a numeric respiratory-rate reading.

Support in @ovok/core​

  • Category key: respiratoryRate (respiratory-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
respiratoryRatenumber (optional)breaths per minuteMapped and saved as a numeric rate; one decimal place on save.

Value handling​

Supply the value as breaths per minute. The SDK rounds saved values to one decimal place. It does not calculate respiratory rate from other measurements.

Read this category​

Select MeasurementTypeKey.respiratoryRate. The mapper returns the numeric value as respiratoryRate.

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 respiratoryRate in breaths per minute. Use request-level effectiveDateTime when you know the reading 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 saveRespiratoryRate() {
  return client.saveMeasurement({
    measurement: {
      measurementTypeKey: MeasurementTypeKey.respiratoryRate,
      respiratoryRate: 16,
    },
    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.