Skip to main content

usePublicApiEndpoints

Lists public API endpoints for a selected FHIR release.

When to use it​

The version defaults to R4.

Setup​

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

Hook arguments​

ArgumentTypeDetails
version (optional)OvokFhirVersionFHIR release; defaults to R4.

TypeScript signature​

(version?: OvokFhirVersion): OvokRequestState<OvokPublicApiEndpoint[]>

Request state​

The response payload is OvokPublicApiEndpoint[]. 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 { usePublicApiEndpoints } from '@ovok/core';

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