CatalogField

The measurement types a declaration may produce, the properties each one accepts, the canonical unit of every property, and the physiological envelope outside which a decoded value is treated as a decoding fault rather than a reading.

A measurement type absent from this catalog cannot be declared. ECG's waveform is still assembled by a device frame handler, but its scalar heart rate can be declared alongside another reading in a combined frame.

The property names mirror the measurement types in

Kind: Interface
Package: @ovok/native

Import

import { CatalogField } from '@ovok/native/bt-management';

TypeScript shape

interface CatalogField {
    unit: string;
    min: number;
    max: number;
    required?: boolean;
    display?: string;
    normalMin?: number;
    normalMax?: number;
    negativeAtZero?: boolean;
    qualitative?: boolean;
}

This is a type-level export; it has no call parameters.

Public members

Member	Type	Details
unit	string	—
min	number	—
max	number	—
required	boolean	Optional. —
display	string	Optional. Human-readable label for localized catalog UIs.
normalMin	number	Optional. —
normalMax	number	Optional. —
negativeAtZero	boolean	Optional. A zero reading is the device's negative result for this analyte.
qualitative	boolean	Optional. Render this analyte as a qualitative Negative/Positive result.

Learn the workflow

Continue with Bluetooth for the workflow context and examples.

Source

View the declaration in the SDK source.

Additional notes

ovok: /core. A typo would otherwise produce an object the backend silently drops, so it is rejected at registration instead.

required marks the properties without which the reading is not that measurement. Every property in

ovok: /core is optional, so a declaration that named only systolic would otherwise compile and then post a blood pressure with no diastolic - a plausible clinical record of something that was never measured. A "result" case must declare all of them.