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

package/src/medication/medication.resource.test.tsx

@@ -0,0 +1,156 @@
+import { useMedicationCodeableConcept, useMedicationFormulations } from './medication.resource';
+import useSWR from 'swr';
+import { openmrsFetch } from '@openmrs/esm-framework';
+
+jest.mocked(openmrsFetch);
+jest.mock('swr');
+
+describe('Medication Resource Tests', () => {
+  test('useMedicationCodeableConcept should call useSWR with null reference if existing codeable concept uuid passed in', () => {
+    // @ts-ignore
+    useSWR.mockImplementation(() => ({ data: null }));
+    const result = useMedicationCodeableConcept('123abc', 'Medication/123abc');
+    expect(useSWR).toHaveBeenCalledWith(null, openmrsFetch);
+    expect(result.medicationCodeableConceptUuid).toBeNull();
+  });
+
+  test('useMedicationCodeableConcept should call useSWR with medication reference if no existing codeable concept uuid passed in', () => {
+    // @ts-ignore
+    useSWR.mockImplementation(() => ({
+      data: { data: { code: { coding: [{ code: 'def678' }] } } },
+    }));
+    const result = useMedicationCodeableConcept(null, 'Medication/123abc');
+    expect(useSWR).toHaveBeenCalledWith('/ws/fhir2/R4/Medication/123abc', openmrsFetch);
+    expect(result.medicationCodeableConceptUuid).toBe('def678');
+  });
+
+  test('useMedicationFormulations should call useSWR with null reference if no concept uuid provided', () => {
+    // @ts-ignore
+    useSWR.mockImplementation(() => ({ data: null }));
+    const result = useMedicationFormulations(null);
+    expect(useSWR).toHaveBeenCalledWith(null, openmrsFetch);
+    expect(result.medicationFormulations).toBeUndefined(); // TODO: is this really what we want? or rather null or empty
+  });
+
+  test('useMedicationFormulations should call useSWR with with medications by concept endpoint and return formualations if concept defined', () => {
+    // @ts-ignore
+    useSWR.mockImplementation(() => ({
+      data: {
+        data: {
+          resourceType: 'Bundle',
+          id: '2ee923c2-6e97-464e-ae0b-797b24c3b3b5',
+          meta: {
+            lastUpdated: '2023-02-27T17:51:19.801-05:00',
+          },
+          type: 'searchset',
+          total: 2,
+          link: [
+            {
+              relation: 'self',
+              url: 'https://ci.pih-emr.org/openmrs/ws/fhir2/R4/Medication?code=3cd27a8a-26fe-102b-80cb-0017a47871b2',
+            },
+          ],
+          entry: [
+            {
+              fullUrl: 'https://ci.pih-emr.org/openmrs/ws/fhir2/R4/Medication/e47fa273-0c52-4f0f-b57b-34001a3e9677',
+              resource: {
+                resourceType: 'Medication',
+                id: 'e47fa273-0c52-4f0f-b57b-34001a3e9677',
+                meta: {
+                  lastUpdated: '2019-09-09T22:55:46.000-04:00',
+                },
+                text: {
+                  status: 'generated',
+                  div: '<div xmlns="http://www.w3.org/1999/xhtml"><table class="hapiPropertyTable"><tbody><tr><td>Id:</td><td>e47fa273-0c52-4f0f-b57b-34001a3e9677</td></tr><tr><td>Code:</td><td>Isoniazide</td></tr><tr><td>Status:</td><td>ACTIVE</td></tr></tbody></table></div>',
+                },
+                extension: [
+                  {
+                    url: 'http://fhir.openmrs.org/ext/medicine',
+                    extension: [
+                      {
+                        url: 'http://fhir.openmrs.org/ext/medicine#drugName',
+                        valueString: 'Isoniazid (H), 100mg tablet',
+                      },
+                    ],
+                  },
+                ],
+                code: {
+                  coding: [
+                    {
+                      code: '3cd27a8a-26fe-102b-80cb-0017a47871b2',
+                      display: 'Isoniazide',
+                    },
+                    {
+                      system: 'https://openconceptlab.org/orgs/CIEL/sources/CIEL',
+                      code: '1679',
+                      display: 'Isoniazide',
+                    },
+                    {
+                      system: 'http://snomed.info/sct',
+                      code: '81335000',
+                      display: 'Isoniazide',
+                    },
+                  ],
+                  text: 'Isoniazide',
+                },
+                status: 'active',
+              },
+            },
+            {
+              fullUrl: 'https://ci.pih-emr.org/openmrs/ws/fhir2/R4/Medication/849218ee-901c-46b3-80f9-7c808132893b',
+              resource: {
+                resourceType: 'Medication',
+                id: '849218ee-901c-46b3-80f9-7c808132893b',
+                meta: {
+                  lastUpdated: '2019-09-09T22:55:46.000-04:00',
+                },
+                text: {
+                  status: 'generated',
+                  div: '<div xmlns="http://www.w3.org/1999/xhtml"><table class="hapiPropertyTable"><tbody><tr><td>Id:</td><td>849218ee-901c-46b3-80f9-7c808132893b</td></tr><tr><td>Code:</td><td>Isoniazide</td></tr><tr><td>Status:</td><td>ACTIVE</td></tr></tbody></table></div>',
+                },
+                extension: [
+                  {
+                    url: 'http://fhir.openmrs.org/ext/medicine',
+                    extension: [
+                      {
+                        url: 'http://fhir.openmrs.org/ext/medicine#drugName',
+                        valueString: 'Isoniazid (H), 300mg tablet',
+                      },
+                    ],
+                  },
+                ],
+                code: {
+                  coding: [
+                    {
+                      code: '3cd27a8a-26fe-102b-80cb-0017a47871b2',
+                      display: 'Isoniazide',
+                    },
+                    {
+                      system: 'https://openconceptlab.org/orgs/CIEL/sources/CIEL',
+                      code: '1679',
+                      display: 'Isoniazide',
+                    },
+                    {
+                      system: 'http://snomed.info/sct',
+                      code: '81335000',
+                      display: 'Isoniazide',
+                    },
+                  ],
+                  text: 'Isoniazide',
+                },
+                status: 'active',
+              },
+            },
+          ],
+        },
+      },
+    }));
+    const result = useMedicationFormulations('123abc');
+    expect(useSWR).toHaveBeenCalledWith('/ws/fhir2/R4/Medication?code=123abc', openmrsFetch);
+    expect(result.medicationFormulations.length).toBe(2);
+    expect(result.medicationFormulations[0].id).toBe('e47fa273-0c52-4f0f-b57b-34001a3e9677');
+    expect(result.medicationFormulations[0].resourceType).toBe('Medication');
+    expect(result.medicationFormulations[1].id).toBe('849218ee-901c-46b3-80f9-7c808132893b');
+    expect(result.medicationFormulations[1].resourceType).toBe('Medication');
+  });
+});

package/src/medication/medication.resource.tsx

@@ -0,0 +1,45 @@
+import useSWR from 'swr';
+import { type Medication, type MedicationFormulationsResponse } from '../types';
+import { fhirBaseUrl, openmrsFetch } from '@openmrs/esm-framework';
+import { getConceptCodingUuid, getMedicationsByConceptEndpoint } from '../utils';
+
+/**
+ * Given a Medication Reference, fetches that Medication and returns the codeable concept associated with it
+ * Note: returns null if existingMedicationCodeableConcept already defined
+ *
+ * @param existingMedicationCodeableConceptUuid
+ * @param medicationReference
+ */
+export function useMedicationCodeableConcept(
+  existingMedicationCodeableConceptUuid: string,
+  medicationReference: string,
+) {
+  const { data } = useSWR<{ data: Medication }, Error>(
+    existingMedicationCodeableConceptUuid || !medicationReference ? null : `${fhirBaseUrl}/${medicationReference}`,
+    openmrsFetch,
+  );
+
+  return {
+    medicationCodeableConceptUuid: data ? getConceptCodingUuid(data.data.code.coding) : null,
+  };
+}
+
+/**
+ * Given a concept uuid, returns all Medications associated with that concept
+ *
+ * @param medicationCodeableConcept
+ */
+export function useMedicationFormulations(medicationCodeableConcept: string) {
+  const { data } = useSWR<{ data: MedicationFormulationsResponse }, Error>(
+    medicationCodeableConcept ? getMedicationsByConceptEndpoint(medicationCodeableConcept) : null, // note that we don't start the search until we've confirmed we have a uuid to search for
+    openmrsFetch,
+  );
+
+  if (data?.data?.entry) {
+    return {
+      medicationFormulations: data.data.entry.map((e) => e.resource),
+    };
+  } else {
+    return {};
+  }
+}

package/src/medication-dispense/medication-dispense.resource.test.tsx

@@ -0,0 +1,243 @@
+import useSWR from 'swr';
+import { openmrsFetch, type Session } from '@openmrs/esm-framework';
+import {
+  deleteMedicationDispense,
+  initiateMedicationDispenseBody,
+  saveMedicationDispense,
+  useOrderConfig,
+  useSubstitutionReasonValueSet,
+  useSubstitutionTypeValueSet,
+} from './medication-dispense.resource';
+import {
+  type MedicationDispense,
+  type MedicationRequest,
+  MedicationDispenseStatus,
+  MedicationRequestStatus,
+  type Provider,
+} from '../types';
+import dayjs from 'dayjs';
+
+jest.mocked(openmrsFetch);
+jest.mock('swr');
+
+describe('Medication Dispense Resource tests', () => {
+  test('saveMedicationDispense should call medication dispense FHIR endpoint with appropriate data and method POST', () => {
+    const medicationDispense: MedicationDispense = {
+      dosageInstruction: undefined,
+      id: '',
+      location: { display: '', reference: '', type: '' },
+      medicationReference: { display: '', reference: '', type: '' },
+      meta: { lastUpdated: '' },
+      quantity: undefined,
+      performer: undefined,
+      resourceType: 'MedicationDispense',
+      status: null,
+      subject: { display: '', reference: '', type: '' },
+      substitution: { reason: [], type: undefined, wasSubstituted: false },
+      type: undefined,
+      whenHandedOver: '',
+      whenPrepared: '',
+    };
+    const abortController: AbortController = {
+      signal: undefined,
+      abort(): void {},
+    };
+
+    saveMedicationDispense(medicationDispense, MedicationDispenseStatus.completed, abortController);
+    expect(openmrsFetch).toHaveBeenCalledWith('/ws/fhir2/R4/MedicationDispense', {
+      method: 'POST',
+      signal: abortController.signal,
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      body: medicationDispense,
+    });
+  });
+
+  test('saveMedicationDispense should call medication dispense FHIR endpoint with appropriate data and method PUT', () => {
+    const medicationDispense: MedicationDispense = {
+      dosageInstruction: undefined,
+      id: '123abc',
+      location: { display: '', reference: '', type: '' },
+      medicationReference: { display: '', reference: '', type: '' },
+      meta: { lastUpdated: '' },
+      performer: undefined,
+      quantity: undefined,
+      resourceType: 'MedicationDispense',
+      status: null,
+      subject: { display: '', reference: '', type: '' },
+      substitution: { reason: [], type: undefined, wasSubstituted: false },
+      type: undefined,
+      whenHandedOver: '',
+      whenPrepared: '',
+    };
+    const abortController: AbortController = {
+      signal: undefined,
+      abort(): void {},
+    };
+
+    saveMedicationDispense(medicationDispense, MedicationDispenseStatus.completed, abortController);
+    expect(openmrsFetch).toHaveBeenCalledWith('/ws/fhir2/R4/MedicationDispense/123abc', {
+      method: 'PUT',
+      signal: abortController.signal,
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      body: medicationDispense,
+    });
+  });
+
+  test('deleteMedicationDispense should call medication request FHIR endpoint with appropriate uuid and method DELETE', () => {
+    deleteMedicationDispense('123abc');
+    expect(openmrsFetch).toHaveBeenCalledWith('/ws/fhir2/R4/MedicationDispense/123abc', { method: 'DELETE' });
+  });
+
+  test('useOrderConfig should fetch order config via SWR', () => {
+    // @ts-ignore
+    useSWR.mockImplementation(() => ({ data: { data: 'mockedOrderConfig' } }));
+    const orderConfig = useOrderConfig();
+    expect(orderConfig.orderConfigObject).toBe('mockedOrderConfig');
+  });
+
+  test('useSubstitutionTypeValueSet should call fetch substitution type value set via SWR', () => {
+    // @ts-ignore
+    useSWR.mockImplementation(() => ({
+      data: { data: 'mockedSubstitutionTypeValueSet' },
+    }));
+    const result = useSubstitutionTypeValueSet('123');
+    expect(useSWR).toHaveBeenCalledWith('/ws/fhir2/R4/ValueSet/123', openmrsFetch);
+    expect(result.substitutionTypeValueSet).toBe('mockedSubstitutionTypeValueSet');
+  });
+
+  test('useSubstitutionReasonValueSet should call fetch substitution reason value set via SWR', () => {
+    // @ts-ignore
+    useSWR.mockImplementation(() => ({
+      data: { data: 'mockedSubstitutionReasonValueSet' },
+    }));
+    const result = useSubstitutionReasonValueSet('123');
+    expect(useSWR).toHaveBeenCalledWith('/ws/fhir2/R4/ValueSet/123', openmrsFetch);
+    expect(result.substitutionReasonValueSet).toBe('mockedSubstitutionReasonValueSet');
+  });
+
+  test('initiateMedicationDispenseBody should initialize medication dispense body from request', () => {
+    const activeMedicationRequest: MedicationRequest = {
+      intent: '',
+      medicationReference: { reference: 'Medication/123abc' },
+      meta: { lastUpdated: '' },
+      priority: '',
+      resourceType: 'MedicationRequest',
+      status: MedicationRequestStatus.active,
+      subject: { reference: 'Patient/765432' },
+      dispenseRequest: {
+        numberOfRepeatsAllowed: 0,
+        quantity: {
+          value: 20.0,
+          system: 'http://snomed.info/sct',
+          code: '123456789',
+          unit: 'Tablet',
+        },
+        validityPeriod: { start: '' },
+      },
+      encounter: { reference: '', type: '' },
+      requester: {
+        display: '',
+        identifier: { value: '' },
+        reference: '',
+        type: '',
+      },
+      dosageInstruction: [
+        {
+          text: 'Take with food',
+          timing: {
+            repeat: {
+              duration: 30.0,
+              durationUnit: 'd',
+            },
+            code: {
+              coding: [
+                {
+                  code: '',
+                },
+              ],
+            },
+          },
+          asNeededBoolean: false,
+          route: {
+            coding: [
+              {
+                code: '545767',
+              },
+            ],
+          },
+          doseAndRate: [
+            {
+              doseQuantity: {
+                value: 5.0,
+                unit: 'Tablet',
+                system: 'http://snomed.info/sct',
+                code: '385055001',
+              },
+            },
+          ],
+        },
+      ],
+      id: '456def',
+    };
+
+    const session: Session = {
+      authenticated: true,
+      sessionId: '',
+      user: undefined,
+      currentProvider: {
+        uuid: 'ghi789',
+        identifier: undefined,
+      },
+      sessionLocation: {
+        uuid: '987654',
+        display: undefined,
+        links: undefined,
+      },
+    };
+
+    const providers: Provider[] = [
+      {
+        uuid: 'ghi789',
+        person: null,
+      },
+    ];
+
+    const medicationDispense: MedicationDispense = initiateMedicationDispenseBody(
+      activeMedicationRequest,
+      session,
+      providers,
+      true,
+    );
+
+    expect(medicationDispense.id).toBeUndefined();
+    expect(medicationDispense.resourceType).toBe('MedicationDispense');
+    expect(medicationDispense.medicationReference.reference).toBe('Medication/123abc');
+    expect(medicationDispense.status).toBeNull();
+    expect(medicationDispense.authorizingPrescription[0].reference).toBe('MedicationRequest/456def');
+    expect(medicationDispense.authorizingPrescription[0].type).toBe('MedicationRequest');
+    expect(medicationDispense.medicationCodeableConcept).toBeUndefined();
+    expect(medicationDispense.subject.reference).toBe('Patient/765432');
+    expect(medicationDispense.performer[0].actor.reference).toBe('Practitioner/ghi789');
+    expect(medicationDispense.location.reference).toBe('Location/987654');
+    expect(medicationDispense.quantity.value).toBe(20.0);
+    expect(medicationDispense.quantity.system).toBe('http://snomed.info/sct');
+    expect(medicationDispense.quantity.unit).toBe('Tablet');
+    expect(medicationDispense.quantity.code).toBe('123456789');
+    expect(dayjs(medicationDispense.whenPrepared).isToday()).toBeTruthy();
+    expect(dayjs(medicationDispense.whenHandedOver).isToday()).toBeTruthy();
+    expect(medicationDispense.dosageInstruction[0].text).toBe('Take with food');
+    expect(medicationDispense.dosageInstruction[0].timing.repeat.duration).toBe(30.0);
+    expect(medicationDispense.dosageInstruction[0].timing.repeat.durationUnit).toBe('d');
+    expect(medicationDispense.dosageInstruction[0].asNeededBoolean).toBe(false);
+    expect(medicationDispense.dosageInstruction[0].route.coding[0].code).toBe('545767');
+    expect(medicationDispense.dosageInstruction[0].doseAndRate[0].doseQuantity.value).toBe(5);
+    expect(medicationDispense.dosageInstruction[0].doseAndRate[0].doseQuantity.system).toBe('http://snomed.info/sct');
+    expect(medicationDispense.dosageInstruction[0].doseAndRate[0].doseQuantity.code).toBe('385055001');
+    expect(medicationDispense.dosageInstruction[0].doseAndRate[0].doseQuantity.unit).toBe('Tablet');
+    expect(medicationDispense.substitution.wasSubstituted).toBe(false);
+  });
+});

package/src/medication-dispense/medication-dispense.resource.tsx

@@ -0,0 +1,178 @@
+import dayjs from 'dayjs';
+import useSWR from 'swr';
+import { fhirBaseUrl, restBaseUrl, openmrsFetch, type Session } from '@openmrs/esm-framework';
+import {
+  type MedicationDispense,
+  type MedicationDispenseStatus,
+  type MedicationRequest,
+  type OrderConfig,
+  type Provider,
+  type ProviderRequestResponse,
+  type ValueSet,
+} from '../types';
+
+export function saveMedicationDispense(
+  medicationDispense: MedicationDispense,
+  medicationDispenseStatus: MedicationDispenseStatus,
+  abortController?: AbortController,
+) {
+  // if we have an id, this is an update, otherwise it's a create
+  const url = medicationDispense.id
+    ? `${fhirBaseUrl}/MedicationDispense/${medicationDispense.id}`
+    : `${fhirBaseUrl}/MedicationDispense`;
+
+  const method = medicationDispense.id ? 'PUT' : 'POST';
+
+  medicationDispense.status = medicationDispenseStatus;
+
+  // TODO for now we don't support a different prepared and handed over date, so just set the handed over to the prepared date
+  medicationDispense.whenPrepared = medicationDispense.whenHandedOver;
+
+  return openmrsFetch(url, {
+    method: method,
+    signal: abortController?.signal,
+    headers: {
+      'Content-Type': 'application/json',
+    },
+    body: medicationDispense,
+  });
+}
+
+export function deleteMedicationDispense(medicationDispenseUuid: string) {
+  return openmrsFetch(`${fhirBaseUrl}/MedicationDispense/${medicationDispenseUuid}`, {
+    method: 'DELETE',
+  });
+}
+
+export function useOrderConfig() {
+  const { data, error, isValidating } = useSWR<{ data: OrderConfig }, Error>(
+    `${restBaseUrl}/orderentryconfig`,
+    openmrsFetch,
+  );
+  return {
+    orderConfigObject: data ? data.data : null,
+    error,
+    isLoading: !data && !error,
+    isValidating,
+  };
+}
+
+export function useProviders(providerRoles: Array<string>) {
+  const rep = 'custom:(uuid,person:(display)';
+  const { data } = useSWR<{ data: ProviderRequestResponse }, Error>(
+    providerRoles && providerRoles.length > 0
+      ? `${restBaseUrl}/provider?providerRoles=${providerRoles.join(',')}&v=${rep})`
+      : `${restBaseUrl}/provider?v=${rep})`,
+    openmrsFetch,
+  );
+  return data?.data?.results.sort((a, b) => a.person?.display.localeCompare(b.person?.display));
+}
+
+export function useReasonForPauseValueSet(uuid: string) {
+  const valueSet = useValueSet(uuid);
+  return { reasonForPauseValueSet: valueSet };
+}
+
+export function useReasonForCloseValueSet(uuid: string) {
+  const valueSet = useValueSet(uuid);
+  return { reasonForCloseValueSet: valueSet };
+}
+
+export function useSubstitutionTypeValueSet(uuid: string) {
+  const valueSet = useValueSet(uuid);
+  return { substitutionTypeValueSet: valueSet };
+}
+
+export function useSubstitutionReasonValueSet(uuid: string) {
+  const valueSet = useValueSet(uuid);
+  return { substitutionReasonValueSet: valueSet };
+}
+
+export function useValueSet(uuid: string) {
+  const { data } = useSWR<{ data: ValueSet }, Error>(`${fhirBaseUrl}/ValueSet/${uuid}`, openmrsFetch);
+  return data ? data.data : null;
+}
+
+// TODO: what about the issue with the repetitive reloading?
+export function initiateMedicationDispenseBody(
+  medicationRequest: MedicationRequest,
+  session: Session,
+  providers: Provider[],
+  populateDispenseInformation: boolean,
+): MedicationDispense {
+  let medicationDispense: MedicationDispense = {
+    resourceType: 'MedicationDispense',
+    status: null,
+    authorizingPrescription: [
+      {
+        reference: 'MedicationRequest/' + medicationRequest.id,
+        type: 'MedicationRequest',
+      },
+    ],
+    medicationReference: medicationRequest.medicationReference,
+    medicationCodeableConcept: medicationRequest.medicationCodeableConcept,
+    subject: medicationRequest.subject,
+    performer: [
+      {
+        actor: {
+          reference: session?.currentProvider ? `Practitioner/${session.currentProvider.uuid}` : '',
+        },
+      },
+    ],
+    location: {
+      reference: session?.sessionLocation ? `Location/${session.sessionLocation.uuid}` : '',
+    },
+    whenHandedOver: dayjs().format(),
+  };
+
+  if (populateDispenseInformation) {
+    medicationDispense = {
+      ...medicationDispense,
+      quantity: {
+        value: medicationRequest.dispenseRequest?.quantity?.value,
+        code: medicationRequest.dispenseRequest?.quantity?.code,
+        unit: medicationRequest.dispenseRequest?.quantity?.unit,
+        system: medicationRequest.dispenseRequest?.quantity?.system,
+      },
+      dosageInstruction: [
+        {
+          // see https://openmrs.atlassian.net/browse/O3-3791 for an explanation for the reason for the below
+          text: [
+            medicationRequest.dosageInstruction[0].text,
+            medicationRequest.dosageInstruction[0].additionalInstruction?.length > 0
+              ? medicationRequest.dosageInstruction[0].additionalInstruction[0].text
+              : null,
+          ]
+            .filter((str) => str != null)
+            .join(' '),
+          timing: medicationRequest.dosageInstruction[0].timing,
+          asNeededBoolean: false,
+          route: medicationRequest.dosageInstruction[0].route,
+          doseAndRate: medicationRequest.dosageInstruction[0].doseAndRate
+            ? medicationRequest.dosageInstruction[0].doseAndRate
+            : [
+                {
+                  doseQuantity: {
+                    value: null,
+                    code: null,
+                    unit: null,
+                  },
+                },
+              ],
+        },
+      ],
+      substitution: blankSubstitution,
+    };
+  }
+  return medicationDispense;
+}
+
+export const blankSubstitution = {
+  wasSubstituted: false,
+  reason: [
+    {
+      coding: [{ code: null }],
+    },
+  ],
+  type: { coding: [{ code: null }] },
+};