Skip to main content

useSlimPatientThresholdV2

Loads one patient's Slim threshold configuration.

When to use it​

An undefined patient ID disables the request; use the patient-specific update hook for changes.

Setup​

Call it from a client-side React component below OvokProvider so it uses the client configured at that provider boundary.

Hook arguments​

ArgumentTypeDetails
patientId (optional)stringPatient ID; undefined disables the request.

TypeScript signature​

(patientId?: string): OvokRequestState<SlimPatientThresholdV2>

Request state​

The response payload is SlimPatientThresholdV2. A successful empty result, a failed request, and a request that has not returned data are distinct states.

FieldMeaning
dataLatest successful response, or undefined before one is available.
loadingWhether the request is in progress.
errorRequest error as an Error, or undefined when no request has failed.
reloadRepeats the request with the current arguments.

Request behavior​

The hook loads when its required inputs are available and reloads when those inputs change. Use reload for an explicit refresh; render loading, error, and successful no-result states separately.

Example​

Handle the hook's loading and error states before rendering the result.

import { useSlimPatientThresholdV2 } from '@ovok/core';

export function SlimPatientThresholdV2Example({ patientId }: { patientId?: Parameters<typeof useSlimPatientThresholdV2>[0] }) {
  const { data, loading, error, reload } = useSlimPatientThresholdV2(patientId);
  if (loading) return <p>Loading…</p>;
  if (error) return <p role="alert">{error.message}</p>;
  return <section><button onClick={reload}>Reload</button><pre>{JSON.stringify(data, null, 2)}</pre></section>;
}