useFhirVRead

Return a Query for a vread request.

See the useFhirHistory hook to retrieve the list of versions for a resource.

Basic usage

import { asError } from "@bonfhir/core/r4b";
import { useFhirVRead } from "@bonfhir/query/r4b";
import { FhirValue } from "@bonfhir/react/r4b";

export default function MyComponent() {
  const patientQuery = useFhirVRead(
    "Patient",
    "a337ccfc-3ad4-47b4-9f02-3a19e035bb03",
    // The version id to retrieve
    "51a9a637-465b-4ab8-afe4-79875eaf9dd7",
  );

  if (patientQuery.isLoading) {
    return <div>Loading...</div>;
  }

  if (patientQuery.isError) {
    return <div>{asError(patientQuery.error)?.message}</div>;
  }

  return <FhirValue type="HumanName" value={patientQuery.data?.name} />;
}

With the <FhirQueryLoader />

import { useFhirRead } from "@bonfhir/query/r4b";
import { FhirQueryLoader, FhirValue } from "@bonfhir/react/r4b";

export default function MyComponent() {
  const patientQuery = useFhirRead(
    "Patient",
    "a337ccfc-3ad4-47b4-9f02-3a19e035bb03",
    // The version id to retrieve
    "51a9a637-465b-4ab8-afe4-79875eaf9dd7",
  );

  return (
    <FhirQueryLoader query={patientQuery}>
      {(patient) => <FhirValue type="HumanName" value={patient.name} />}
    </FhirQueryLoader>
  );
}

With options

import { DEFAULT_FHIR_CLIENT, useFhirRead } from "@bonfhir/query/r4b";

export default function MyComponent() {
  const patientQuery = useFhirRead(
    "Patient",
    "a337ccfc-3ad4-47b4-9f02-3a19e035bb03",
    // The version id to retrieve
    "51a9a637-465b-4ab8-afe4-79875eaf9dd7",
    {
      // FHIR API options - matches the `FhirClient` options
      fhir: {
        _summary: "true",
      },

      // The name of the FhirClient to use
      fhirClient: DEFAULT_FHIR_CLIENT,

      // React query options
      query: {
        gcTime: Number.POSITIVE_INFINITY,
      },
    },
  );

  //...
}

The useFhirVRead hook errors out on not found - same behavior as the FhirClient.vread.