Skip to main content

useSlimPatients

Lists patients through the Slim patient-list endpoint.

When to use it​

Use the typed list query; results are wrapped in a page.

Setup​

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

Hook arguments​

ArgumentTypeDetails
params (optional)SlimPatientListQueryTyped query or list options; see the API reference for its complete field contract.

TypeScript signature​

(params?: SlimPatientListQuery): OvokRequestState<SlimPage<SlimPatientListItem>>

Request state​

The response payload is SlimPage<SlimPatientListItem>. 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 { useSlimPatients } from '@ovok/core';

export function SlimPatientsExample({ params }: { params?: Parameters<typeof useSlimPatients>[0] }) {
  const { data, loading, error, reload } = useSlimPatients(params);
  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>;
}