Lipid panel
Use this category for one lipid panel containing one or more cholesterol or triglyceride values. The SDK stores the values as components of a FHIR Observation.
Support in @ovok/core
- Category key:
lipidPanel(lipid-panel) - Read: Supported through the observation mapping.
- Save: Supported through the typed measurement save workflow.
For the shared read and save behavior, see Measurements and health data.
Data shape
| Field | Type | Unit or meaning |
|---|---|---|
totalCholesterol | number (optional) | Total cholesterol. |
hdlCholesterol | number (optional) | HDL cholesterol. |
ldlCholesterol | number (optional) | LDL cholesterol. |
triglycerides | number (optional) | Triglycerides. |
totalCholesterolHdlRatio | number (optional) | Total cholesterol divided by HDL cholesterol. |
unit | 'mg/dL' | 'mmol/L' | Unit for the cholesterol and triglyceride values. The ratio is unitless. |
recordedAt | Date (optional) | Time the panel was measured. |
device | FHIR Reference (optional) | Device reference associated with the reading. |
At least one numeric result must be supplied. The SDK writes available values and skips fields that are missing or not finite. It does not convert between mg/dL and mmol/L or round the supplied values. Use one unit consistently for the panel.
Read this category
Pass MeasurementTypeKey.lipidPanel to useObservations() or the observation mapping method. The mapped result groups the component values into a LipidPanelMeasurement; retain the original Observation if the screen needs its resource metadata.
Save this category
import { MeasurementTypeKey } from '@ovok/core';
const result = await client.saveMeasurement({
measurement: {
measurementTypeKey: MeasurementTypeKey.lipidPanel,
totalCholesterol: 185,
hdlCholesterol: 52,
ldlCholesterol: 108,
triglycerides: 125,
totalCholesterolHdlRatio: 3.6,
unit: 'mg/dL',
recordedAt: new Date(),
},
});
Use the supplied laboratory values and units. The SDK does not calculate missing lipid values or validate clinical reference ranges. Queue-enabled saves can return a pending result; see Offline measurement saves.