@ampath/esm-dispensing-app 1.10.0-next.1

package/src/conditions/conditions.resource.ts

@@ -0,0 +1,100 @@
+import { useMemo } from 'react';
+import { fhirBaseUrl, formatDate, parseDate, useFhirFetchAll } from '@openmrs/esm-framework';
+
+export interface Resource {
+  resourceType: string;
+  id: string;
+  meta: ResourceMeta;
+  clinicalStatus: ClinicalStatus;
+  code: Code;
+  subject: Subject;
+  onsetDateTime: string;
+  recordedDate: string;
+  recorder: Recorder;
+}
+
+export interface ResourceMeta {
+  versionId: string;
+  lastUpdated: string;
+  tag: Array<ResourceMetaTag>;
+}
+
+export interface ResourceMetaTag {
+  system: string;
+  code: string;
+  display: string;
+}
+
+export interface ClinicalStatus {
+  coding: Array<Coding>;
+}
+
+export interface Coding {
+  system: string;
+  code: string;
+}
+
+export interface Code {
+  coding: Array<ConditionCoding>;
+  text: string;
+}
+
+export interface ConditionCoding {
+  code: string;
+  display?: string;
+  system?: string;
+}
+
+export interface Subject {
+  reference: string;
+  type: string;
+  display: string;
+}
+
+export interface Recorder {
+  reference: string;
+  type: string;
+  display: string;
+}
+
+export interface Condition {
+  id: string;
+  status?: 'active' | 'inactive';
+  display: string;
+  patient: string;
+  onsetDateTime: string | null;
+  recordedDate: string;
+  recorder: string;
+}
+
+export const usePatientConditions = (patientUuid: string) => {
+  const url = `${fhirBaseUrl}/Condition?patient=${patientUuid}&_summary=data&clinical-status=active`;
+  const { data, isLoading, mutate, error } = useFhirFetchAll<Resource>(url);
+
+  const conditions = useMemo(() => {
+    return data?.reduce<Array<Condition>>((prev, entry) => {
+      if (entry?.resourceType === 'Condition') {
+        const condition: Condition = {
+          id: entry.id,
+          display: entry?.code?.text ?? entry?.code?.coding?.[0]?.display,
+          patient: entry?.subject?.display,
+          recordedDate: entry?.recordedDate,
+          recorder: entry?.recorder?.display,
+          status: entry?.clinicalStatus?.coding[0]?.code as 'active' | 'inactive',
+          onsetDateTime: entry.onsetDateTime ? formatDate(parseDate(entry.onsetDateTime)) : null,
+        };
+        prev.push(condition);
+      }
+      return prev;
+    }, []);
+  }, [data]);
+
+  return {
+    conditions,
+    isLoading,
+    error,
+    mutate,
+  };
+};
+
+export const pageSizesOptions = [3, 5, 10, 20, 50, 100];

package/src/conditions/conditions.scss

@@ -0,0 +1,26 @@
+@use '@carbon/colors';
+@use '@carbon/layout';
+@use '@openmrs/esm-styleguide/src/vars' as *;
+
+.conditionContainer {
+  background-color: colors.$white-0;
+  margin-bottom: layout.$spacing-05;
+}
+
+.table {
+  table-layout: fixed;
+  width: 100%;
+
+  td {
+    padding-left: 2rem !important;
+  }
+}
+
+.conditionColumn {
+  width: 70%;
+}
+
+.onsetDateColumn {
+  width: 30%;
+  text-align: left;
+}

package/src/conditions/conditions.test.tsx

@@ -0,0 +1,200 @@
+import React from 'react';
+import { render, screen } from '@testing-library/react';
+import { usePagination } from '@openmrs/esm-framework';
+import { usePatientConditions } from './conditions.resource';
+import PatientConditions from './conditions.component';
+
+jest.mock('./conditions.resource', () => ({
+  usePatientConditions: jest.fn(),
+  pageSizesOptions: [3, 5, 10],
+}));
+
+const mockUsePatientConditions = jest.mocked(usePatientConditions);
+const mockUsePagination = jest.mocked(usePagination);
+
+const mockPatientUuid = 'test-patient-uuid';
+
+describe('PatientConditions', () => {
+  beforeEach(() => {
+    mockUsePagination.mockReturnValue({
+      results: [],
+      currentPage: 1,
+      goTo: jest.fn(),
+      goToNext: jest.fn(),
+      goToPrevious: jest.fn(),
+      paginated: false,
+      showNextButton: false,
+      showPreviousButton: false,
+      totalPages: 1,
+    });
+  });
+
+  it('renders loading skeleton while fetching conditions', () => {
+    mockUsePatientConditions.mockReturnValue({
+      conditions: [],
+      error: undefined,
+      isLoading: true,
+      mutate: jest.fn(),
+    });
+
+    render(<PatientConditions patientUuid={mockPatientUuid} />);
+
+    // DataTableSkeleton renders a table with skeleton rows
+    expect(screen.getByRole('table')).toBeInTheDocument();
+  });
+
+  it('renders error state when fetching fails', () => {
+    const errorMessage = 'Failed to fetch conditions';
+    mockUsePatientConditions.mockReturnValue({
+      conditions: [],
+      error: new Error(errorMessage),
+      isLoading: false,
+      mutate: jest.fn(),
+    });
+
+    render(<PatientConditions patientUuid={mockPatientUuid} />);
+
+    expect(screen.getByText(/error/i)).toBeInTheDocument();
+  });
+
+  it('renders empty state when no conditions exist', () => {
+    mockUsePatientConditions.mockReturnValue({
+      conditions: [],
+      error: undefined,
+      isLoading: false,
+      mutate: jest.fn(),
+    });
+
+    render(<PatientConditions patientUuid={mockPatientUuid} />);
+
+    // Verify EmptyCard is rendered with correct header title
+    expect(screen.getByTestId('empty-card')).toBeInTheDocument();
+    expect(screen.getByRole('heading', { level: 4, name: 'Active conditions' })).toBeInTheDocument();
+  });
+
+  it('renders conditions table with data', () => {
+    const conditions = [
+      {
+        id: 'condition-1',
+        display: 'Hypertension',
+        onsetDateTime: '15-Jan-2024',
+        patient: 'Test Patient',
+        recordedDate: '2024-01-15',
+        recorder: 'Dr. Smith',
+        status: 'active' as const,
+      },
+      {
+        id: 'condition-2',
+        display: 'Diabetes',
+        onsetDateTime: '10-Dec-2023',
+        patient: 'Test Patient',
+        recordedDate: '2023-12-10',
+        recorder: 'Dr. Jones',
+        status: 'active' as const,
+      },
+    ];
+
+    mockUsePatientConditions.mockReturnValue({
+      conditions,
+      error: undefined,
+      isLoading: false,
+      mutate: jest.fn(),
+    });
+
+    mockUsePagination.mockReturnValue({
+      results: conditions,
+      currentPage: 1,
+      goTo: jest.fn(),
+      goToNext: jest.fn(),
+      goToPrevious: jest.fn(),
+      paginated: false,
+      showNextButton: false,
+      showPreviousButton: false,
+      totalPages: 1,
+    });
+
+    render(<PatientConditions patientUuid={mockPatientUuid} />);
+
+    expect(screen.getByText('Active conditions')).toBeInTheDocument();
+    expect(screen.getByText('Hypertension')).toBeInTheDocument();
+    expect(screen.getByText('Diabetes')).toBeInTheDocument();
+    expect(screen.getByText('15-Jan-2024')).toBeInTheDocument();
+    expect(screen.getByText('10-Dec-2023')).toBeInTheDocument();
+  });
+
+  it('displays double dash for missing onset date', () => {
+    const conditions = [
+      {
+        id: 'condition-1',
+        display: 'Headache',
+        onsetDateTime: null,
+        patient: 'Test Patient',
+        recordedDate: '2024-01-15',
+        recorder: 'Dr. Smith',
+        status: 'active' as const,
+      },
+    ];
+
+    mockUsePatientConditions.mockReturnValue({
+      conditions,
+      error: undefined,
+      isLoading: false,
+      mutate: jest.fn(),
+    });
+
+    mockUsePagination.mockReturnValue({
+      results: conditions,
+      currentPage: 1,
+      goTo: jest.fn(),
+      goToNext: jest.fn(),
+      goToPrevious: jest.fn(),
+      paginated: false,
+      showNextButton: false,
+      showPreviousButton: false,
+      totalPages: 1,
+    });
+
+    render(<PatientConditions patientUuid={mockPatientUuid} />);
+
+    expect(screen.getByText('Headache')).toBeInTheDocument();
+    expect(screen.getByText('--')).toBeInTheDocument();
+  });
+
+  it('renders table headers correctly', () => {
+    const conditions = [
+      {
+        id: 'condition-1',
+        display: 'Test Condition',
+        onsetDateTime: '01-Jan-2024',
+        patient: 'Test Patient',
+        recordedDate: '2024-01-01',
+        recorder: 'Dr. Test',
+        status: 'active' as const,
+      },
+    ];
+
+    mockUsePatientConditions.mockReturnValue({
+      conditions,
+      error: undefined,
+      isLoading: false,
+      mutate: jest.fn(),
+    });
+
+    mockUsePagination.mockReturnValue({
+      results: conditions,
+      currentPage: 1,
+      goTo: jest.fn(),
+      goToNext: jest.fn(),
+      goToPrevious: jest.fn(),
+      paginated: false,
+      showNextButton: false,
+      showPreviousButton: false,
+      totalPages: 1,
+    });
+
+    render(<PatientConditions patientUuid={mockPatientUuid} />);
+
+    expect(screen.getByText('Condition')).toBeInTheDocument();
+    expect(screen.getByText('Onset date')).toBeInTheDocument();
+  });
+});

package/src/config-schema.ts

@@ -0,0 +1,192 @@
+import { Type, validators } from '@openmrs/esm-framework';
+import { type CustomTab } from './types';
+
+export const configSchema = {
+  appName: {
+    _type: Type.String,
+    _default: 'Pharmacy',
+  },
+  actionButtons: {
+    pauseButton: {
+      enabled: {
+        _type: Type.Boolean,
+        _description: 'Enabled/Disable including a Pause button in the button action bar',
+        _default: true,
+      },
+    },
+    closeButton: {
+      enabled: {
+        _type: Type.Boolean,
+        _description: 'Enabled/Disable including a Close button in the button action bar',
+        _default: true,
+      },
+    },
+  },
+  dispenseBehavior: {
+    allowModifyingPrescription: {
+      _type: Type.Boolean,
+      _description:
+        'Enable/Disable editing the prescription. If Disabled, Quantity will be he only editable field on prescription form. Note that this means that quantity units will need to be mandatory and set correctly on the prescription.',
+      _default: true,
+    },
+    restrictTotalQuantityDispensed: {
+      _type: Type.Boolean,
+      _description:
+        'Enable/Disable restricting dispensing quantity greater than total quantity ordered. Marks prescription as complete when total quantity dispensed. If true, allowModifyingPrescription *must* be false, as this functionality relies solely on numeric quantity and assumes no change in formulation, dosage, unit, etc',
+      _default: false,
+    },
+  },
+  dispenserProviderRoles: {
+    _type: Type.Array,
+    _description:
+      'Array of provider roles uuids.  If specified, only providers with these roles will be listed in the "Dispensed By" dropdown.  Note that this simply restricts the providers that can be recorded as Dispensers, it does not limit who can create dispense events.',
+    _default: [],
+  },
+  medicationRequestExpirationPeriodInDays: {
+    _type: Type.Number,
+    _description: 'Medication Requests older that this will be considered expired',
+    _default: 90,
+  },
+  locationBehavior: {
+    locationColumn: {
+      enabled: {
+        _type: Type.Boolean,
+        _description:
+          'Enabled/Disable including a Location column in the main prescriptions table showing ordering location',
+        _default: false,
+      },
+    },
+    locationFilter: {
+      enabled: {
+        _type: Type.Boolean,
+        _description: 'Enable/Disable Location filter on main prescriptions page',
+        _default: false,
+      },
+      tag: {
+        _type: Type.String,
+        _description: 'Name of the location tag to use when fetching locations to populate filter',
+        _default: 'Login Location',
+      },
+      associatedPharmacyLocationAttribute: {
+        _type: Type.String,
+        _description: 'Name of the attribute used to associate locations with a pharmacy location',
+        _default: 'Associated Pharmacy Location',
+      },
+    },
+  },
+  refreshInterval: {
+    _type: Type.Number,
+    _description: 'The interval, in milliseconds, to query the backend for new/changed data',
+    _default: 60000,
+  },
+  valueSets: {
+    reasonForPause: {
+      uuid: {
+        _type: Type.UUID,
+        _description:
+          "UUID for the Value Set of valid answers to the 'Reason for Pause' question. Defaults to CIEL value set: https://app.openconceptlab.org/#/orgs/CIEL/sources/CIEL/concepts/168099/",
+        _default: '2462a9d7-61fb-4bf5-9359-aedecb8d03cb',
+      },
+    },
+    reasonForClose: {
+      uuid: {
+        _type: Type.UUID,
+        _description:
+          "UUID for the Value Set of valid answers to the 'Reason for Close' question. Defaults to CIEL value set: https://app.openconceptlab.org/#/orgs/CIEL/sources/CIEL/concepts/168099/",
+        _default: '2462a9d7-61fb-4bf5-9359-aedecb8d03cb',
+      },
+    },
+    substitutionReason: {
+      uuid: {
+        _type: Type.UUID,
+        _description:
+          "UUID for the Value Set of valid answers to the 'Reason for Substitution' question. Defaults to CIEL value set: https://app.openconceptlab.org/#/orgs/CIEL/sources/CIEL/concepts/167862/",
+        _default: '2de6e1be-f2dd-4ba0-9516-8a611aa2af9b',
+      },
+    },
+    substitutionType: {
+      uuid: {
+        _type: Type.UUID,
+        _description:
+          "UUID for the Value Set of valid answers to the 'Type of Substitution' question. Defaults to CIEL value set: https://app.openconceptlab.org/#/orgs/CIEL/sources/CIEL/concepts/167859/",
+        _default: 'b9c5bca0-d026-4245-a4d2-e4c0a8999082',
+      },
+    },
+  },
+  enableStockDispense: {
+    _type: Type.Boolean,
+    _description:
+      'Enable or disable stock deduction during the dispensing process. Requires the stock management module to be installed and configured.',
+    _default: false,
+  },
+  validateBatch: {
+    _type: Type.Boolean,
+    _description:
+      'Enable or disable stock item batch number validation. Requires the stock management module to be installed and configured.',
+    _default: true,
+  },
+  leftNavMode: {
+    _type: Type.String,
+    _description: 'Sets the left nav mode for the dispensing app.',
+    _validators: [validators.oneOf(['normal', 'collapsed', 'hidden'])],
+    _default: 'collapsed',
+  },
+  completeOrderWithThisDispense: {
+    _type: Type.Boolean,
+    _description: 'Enable or disable the "Complete order with this dispense" checkbox on the dispense form.',
+    _default: false,
+  },
+  customTabs: {
+    _type: Type.Array,
+    _description: 'Custom tabs to be added to the prescription panel. See README for more details.',
+    _default: [],
+  },
+};
+
+export interface PharmacyConfig {
+  appName: string;
+  actionButtons: {
+    pauseButton: {
+      enabled: boolean;
+    };
+    closeButton: {
+      enabled: boolean;
+    };
+  };
+  refreshInterval: number;
+  dispenseBehavior: {
+    allowModifyingPrescription: boolean;
+    restrictTotalQuantityDispensed: boolean;
+  };
+  dispenserProviderRoles: [];
+  medicationRequestExpirationPeriodInDays: number;
+  locationBehavior: {
+    locationColumn: {
+      enabled: boolean;
+    };
+    locationFilter: {
+      enabled: boolean;
+      tag: string;
+      associatedPharmacyLocationAttribute: string;
+    };
+  };
+  valueSets: {
+    reasonForPause: {
+      uuid: string;
+    };
+    reasonForClose: {
+      uuid: string;
+    };
+    substitutionReason: {
+      uuid: string;
+    };
+    substitutionType: {
+      uuid: string;
+    };
+  };
+  enableStockDispense: boolean;
+  completeOrderWithThisDispense: boolean;
+  validateBatch: boolean;
+  leftNavMode: 'normal' | 'collapsed' | 'hidden';
+  customTabs: Array<CustomTab>;
+}

package/src/constants.ts

@@ -0,0 +1,22 @@
+export const spaRoot = window['getOpenmrsSpaBase'];
+export const basePath = '/dispensing';
+export const spaBasePath = `${window.spaBase}${basePath}`;
+
+// defined in FHIR 2 module
+export const OPENMRS_FHIR_PREFIX = 'http://fhir.openmrs.org';
+export const OPENMRS_FHIR_EXT_PREFIX = OPENMRS_FHIR_PREFIX + '/ext';
+export const OPENMRS_FHIR_EXT_MEDICINE = OPENMRS_FHIR_EXT_PREFIX + '/medicine';
+export const OPENMRS_FHIR_EXT_DISPENSE_RECORDED = OPENMRS_FHIR_EXT_PREFIX + '/medicationdispense/recorded';
+export const OPENMRS_FHIR_EXT_REQUEST_FULFILLER_STATUS = OPENMRS_FHIR_EXT_PREFIX + '/medicationrequest/fulfillerstatus';
+
+export const PRIVILEGE_CREATE_DISPENSE = 'Task: dispensing.create.dispense';
+export const PRIVILEGE_CREATE_DISPENSE_MODIFY_DETAILS = 'Task: dispensing.create.dispense.allowSubstitutions';
+export const PRIVILEGE_EDIT_DISPENSE = 'Task: dispensing.edit.dispense';
+export const PRIVILEGE_DELETE_DISPENSE = 'Task: dispensing.delete.dispense';
+export const PRIVILEGE_DELETE_DISPENSE_THIS_PROVIDER_ONLY = 'Task: dispensing.delete.dispense.ifCreator';
+
+export const JSON_MERGE_PATH_MIME_TYPE = 'application/merge-patch+json';
+
+export const PRESCRIPTIONS_TABLE_ENDPOINT = 'Encounter?_query=encountersWithMedicationRequests';
+
+export const PRESCRIPTION_DETAILS_ENDPOINT = 'MedicationRequest';

package/src/dashboard/dispensing-dashboard-link.component.tsx

@@ -0,0 +1,36 @@
+import React, { useMemo } from 'react';
+import classNames from 'classnames';
+import { BrowserRouter } from 'react-router-dom';
+import { useTranslation } from 'react-i18next';
+import { ConfigurableLink } from '@openmrs/esm-framework';
+
+const DispensingDashboardLink = () => {
+  return (
+    <BrowserRouter>
+      <DashboardExtension />
+    </BrowserRouter>
+  );
+};
+
+export default DispensingDashboardLink;
+
+function DashboardExtension() {
+  const { t } = useTranslation();
+  const spaBasePath = `${window.spaBase}/home`;
+
+  const navLink = useMemo(() => {
+    const pathArray = location.pathname.split('/home');
+    const lastElement = pathArray[pathArray.length - 1];
+    return decodeURIComponent(lastElement);
+  }, []);
+
+  return (
+    <ConfigurableLink
+      className={classNames('cds--side-nav__link', {
+        'active-left-nav-link': navLink.match('dispensing'),
+      })}
+      to={`${spaBasePath}/dispensing`}>
+      {t('dispensing', 'Dispensing')}
+    </ConfigurableLink>
+  );
+}

package/src/dashboard/dispensing-dashboard.component.tsx

@@ -0,0 +1,36 @@
+import React from 'react';
+import { useTranslation } from 'react-i18next';
+import { InlineNotification } from '@carbon/react';
+import { useConfig } from '@openmrs/esm-framework';
+import { type PharmacyConfig } from '../config-schema';
+import { PharmacyHeader } from '../pharmacy-header/pharmacy-header.component';
+import PrescriptionTabLists from '../prescriptions/prescription-tab-lists.component';
+import FillPrescriptionButton from '../fill-prescription/fill-prescription-button.component';
+
+export default function DispensingDashboard() {
+  const config = useConfig<PharmacyConfig>();
+  const { t } = useTranslation();
+
+  if (config.dispenseBehavior.restrictTotalQuantityDispensed && config.dispenseBehavior.allowModifyingPrescription) {
+    return (
+      <div className={`omrs-main-content`}>
+        <InlineNotification
+          title={t('dispensingAppError', 'Dispensing App Error')}
+          subtitle={t(
+            'dispensingAppMisconfigurationMessage',
+            "Please contact your system administration: Misconfiguration - 'restrictTotalQuantityDispensed' cannot be enabled if 'allowModifyingPrescription' is enabled.",
+          )}
+        />
+      </div>
+    );
+  } else {
+    return (
+      <div className={`omrs-main-content`}>
+        <PharmacyHeader />
+        {/* <DispensingTiles /> */}
+        <FillPrescriptionButton />
+        <PrescriptionTabLists />
+      </div>
+    );
+  }
+}

package/src/declarations.d.ts

@@ -0,0 +1,2 @@
+declare module '*.css';
+declare module '*.scss';