Skip to main content

Uric acid legacy key

This deprecated key is retained for compatibility. Its payload is the same urine-strip analyte measurement used by urine analysis; it does not represent a standalone serum uric-acid value.

Support in @ovok/core​

  • Category key: uricAcid (uric-acid)
  • 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
uro, bil, ket, glu, pro, ph, bld, nit, leu, sg, vcOptional number valuesSame analytes and units as urine analysisUses the urine-analysis save and read behavior.
urineValuesArray of coded values (required)FHIR CodeableConcept plus an optional string valueRequired by the shared urine-analysis type; numeric fields drive saves.
recordedAtDate (optional)Strip recording timeUsed as the effective time when valid.

Deprecation and migration​

The key is deprecated in the SDK type. It is registered to the same service and mapper as urineAnalysis, and its payload contains urine-strip analytes. It does not save or read a separate blood uric-acid measurement. Use the urine analysis category for new code.

The numeric analyte fields, their units and codes, required urineValues array, and optional recordedAt field are documented in the urine analysis field reference.

Read this category​

The legacy key is mapped to the same urine observations as MeasurementTypeKey.urineAnalysis. Prefer the current key in new queries. The returned values use the shared urine-analyte shape.

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​

For compatibility, saves using this key follow the urine-analysis workflow. Migrate the discriminator to MeasurementTypeKey.urineAnalysis without changing the urine-analyte fields. Do not use this key for a serum uric-acid result.

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';

// Migrate the old discriminator to the current urine-analysis category.
async function saveUrineAnalysis() {
  return client.saveMeasurement({
    measurement: {
      measurementTypeKey: MeasurementTypeKey.urineAnalysis,
      ph: 6,
      urineValues: [],
      recordedAt: 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.