@openmrs/esm-patient-common-lib 13.0.2-pre.12768 → 13.0.2-pre.12774

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-patient-common-lib",
-  "version": "13.0.2-pre.12768",
+  "version": "13.0.2-pre.12774",
   "license": "MPL-2.0",
   "description": "Library for common patient chart components",
   "browser": "dist/openmrs-esm-patient-common-lib.js",

package/src/index.ts

@@ -16,6 +16,8 @@ export * from './time-helper';
 export * from './types';
 export * from './useAllowedFileExtensions';
 export * from './useMaxAttachmentFileSize';
+export * from './usePatientForBanner';
+export * from './usePatientIdentifier';
 export * from './useSystemVisitSetting';
 export * from './visit';
 export * from './workspaces';

package/src/usePatientForBanner.test.tsx

@@ -0,0 +1,50 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+import { renderHook } from '@testing-library/react';
+import { usePatient } from '@openmrs/esm-framework';
+import { mockPatient } from 'tools';
+import { usePatientForBanner } from './usePatientForBanner';
+
+const mockUsePatient = vi.mocked(usePatient);
+
+describe('usePatientForBanner', () => {
+  beforeEach(() => {
+    mockUsePatient.mockReset();
+    mockUsePatient.mockReturnValue({ patient: null, patientUuid: null, isLoading: false, error: null });
+  });
+
+  it('does not fetch when the supplied patient already has banner data', () => {
+    const { result } = renderHook(() => usePatientForBanner(mockPatient));
+
+    expect(mockUsePatient).toHaveBeenCalledWith('');
+    expect(result.current).toBe(mockPatient);
+  });
+
+  it('fetches the full patient when the supplied patient is partial', () => {
+    const partialPatient = { id: mockPatient.id, birthDate: mockPatient.birthDate } as fhir.Patient;
+    mockUsePatient.mockReturnValue({
+      patient: mockPatient,
+      patientUuid: mockPatient.id,
+      isLoading: false,
+      error: null,
+    });
+
+    const { result } = renderHook(() => usePatientForBanner(partialPatient));
+
+    expect(mockUsePatient).toHaveBeenCalledWith(mockPatient.id);
+    expect(result.current).toBe(mockPatient);
+  });
+
+  it('fetches the patient by UUID when no patient is supplied', () => {
+    mockUsePatient.mockReturnValue({
+      patient: mockPatient,
+      patientUuid: mockPatient.id,
+      isLoading: false,
+      error: null,
+    });
+
+    const { result } = renderHook(() => usePatientForBanner(undefined, mockPatient.id));
+
+    expect(mockUsePatient).toHaveBeenCalledWith(mockPatient.id);
+    expect(result.current).toBe(mockPatient);
+  });
+});

package/src/usePatientForBanner.ts

@@ -0,0 +1,19 @@
+import { usePatient } from '@openmrs/esm-framework';
+
+export function hasPatientBannerData(patient?: fhir.Patient) {
+  return Boolean(patient?.name?.length && patient?.identifier?.length);
+}
+
+/**
+ * Resolves a patient with the data needed by the patient header. Some callers pass a partial
+ * patient or a REST representation, so fetch the FHIR patient when the supplied patient cannot
+ * populate the banner. No request is made when the supplied patient already has what the banner
+ * needs.
+ */
+export function usePatientForBanner(patient?: fhir.Patient, patientUuid?: string) {
+  const uuid = patientUuid ?? patient?.id;
+  const shouldFetch = Boolean(uuid) && !hasPatientBannerData(patient);
+  const { patient: fetchedPatient } = usePatient(shouldFetch ? uuid : '');
+
+  return hasPatientBannerData(patient) ? patient : fetchedPatient ?? patient;
+}

package/src/usePatientIdentifier.ts

@@ -0,0 +1,23 @@
+import { useMemo } from 'react';
+import { usePrimaryIdentifierCode } from '@openmrs/esm-framework';
+
+/**
+ * Returns the patient's preferred identifier value (the one matching the configured
+ * primary identifier type), falling back to the patient's first identifier. Returns
+ * `undefined` until the patient and/or the primary identifier code has loaded.
+ */
+export function usePatientIdentifier(patient?: fhir.Patient) {
+  const primaryIdentifierCode = usePrimaryIdentifierCode()?.primaryIdentifierCode;
+
+  return useMemo(() => {
+    if (!patient?.identifier?.length) {
+      return undefined;
+    }
+
+    const preferredIdentifier = patient.identifier.find(
+      (identifier) => identifier.type?.coding?.[0]?.code === primaryIdentifierCode,
+    );
+
+    return (preferredIdentifier ?? patient.identifier[0])?.value;
+  }, [patient?.identifier, primaryIdentifierCode]);
+}