@openmrs/esm-fast-data-entry-app 1.0.0-pre.9 → 1.0.0

package/src/forms-page/FormsPage.tsx

@@ -0,0 +1,106 @@
+import { useConfig, useSession } from '@openmrs/esm-framework';
+import { Tab, Tabs, TabList, TabPanels, TabPanel } from '@carbon/react';
+import React from 'react';
+import { type Config } from '../config-schema';
+import { useGetAllForms } from '../hooks';
+import FormsTable from './forms-table';
+import styles from './styles.scss';
+import { useTranslation } from 'react-i18next';
+import { fdeWorkflowStorageName, fdeWorkflowStorageVersion } from '../context/FormWorkflowReducer';
+import { fdeGroupWorkflowStorageName, fdeGroupWorkflowStorageVersion } from '../context/GroupFormWorkflowReducer';
+
+// helper function useful for debugging
+// given a list of forms, it will organize into permissions
+// and list which forms are associated with that permission
+export const getFormPermissions = (forms) => {
+  const output = {};
+  forms?.forEach(
+    (form) =>
+      (output[form.encounterType.editPrivilege.display] = [
+        ...(output[form.encounterType.editPrivilege.display] || []),
+        form.display,
+      ]),
+  );
+  return output;
+};
+
+// Function adds `id` field to rows so they will be accepted by DataTable
+// "display" is prefered for display name if present, otherwise fall back on "name'"
+const prepareRowsForTable = (rawFormData) => {
+  if (rawFormData) {
+    return rawFormData?.map((form) => ({
+      ...form,
+      id: form.uuid,
+      display: form.display || form.name,
+    }));
+  }
+  return null;
+};
+
+const FormsPage = () => {
+  const config = useConfig();
+  const { t } = useTranslation();
+  const { formCategories, formCategoriesToShow } = config;
+  const { forms, isLoading, error } = useGetAllForms();
+  const cleanRows = prepareRowsForTable(forms);
+  const { user } = useSession();
+  const savedFormsData = localStorage.getItem(fdeWorkflowStorageName + ':' + user?.uuid);
+  const savedGroupFormsData = localStorage.getItem(fdeGroupWorkflowStorageName + ':' + user?.uuid);
+  const activeForms = [];
+  const activeGroupForms = [];
+
+  if (savedFormsData && JSON.parse(savedFormsData)?.['_storageVersion'] === fdeWorkflowStorageVersion) {
+    Object.entries(JSON.parse(savedFormsData).forms).forEach(
+      ([formUuid, form]: [string, { [key: string]: unknown }]) => {
+        if (form.workflowState) activeForms.push(formUuid);
+      },
+    );
+  }
+  if (savedGroupFormsData && JSON.parse(savedGroupFormsData)?.['_storageVersion'] === fdeGroupWorkflowStorageVersion) {
+    Object.entries(JSON.parse(savedGroupFormsData).forms).forEach(
+      ([formUuid, form]: [string, { [key: string]: unknown }]) => {
+        if (form.workflowState) activeGroupForms.push(formUuid);
+      },
+    );
+  }
+
+  const categoryRows = formCategoriesToShow.map((name) => {
+    const category = formCategories.find((category) => category.name === name);
+    let rows = [];
+    if (category && cleanRows && cleanRows.length) {
+      const uuids = category.forms?.map((form) => form.formUUID);
+      rows = cleanRows.filter((row) => uuids.includes(row.uuid));
+    }
+    return { ...{ name, rows } };
+  });
+
+  return (
+    <div className={styles.mainContent}>
+      <h3 className={styles.pageTitle}>{t('fastDataEntry', 'Fast Data Entry')}</h3>
+      <Tabs>
+        <TabList>
+          <Tab label={t('allForms', 'All Forms')}>
+            {`${t('allForms', 'All Forms')} (${cleanRows ? cleanRows?.length : '??'})`}
+          </Tab>
+          {categoryRows?.map((category, index) => (
+            <Tab label={category.name} key={index}>
+              {`${category.name} (${category.rows.length})`}
+            </Tab>
+          ))}
+        </TabList>
+        <TabPanels>
+          <TabPanel>
+            <FormsTable rows={cleanRows} {...{ error, isLoading, activeForms, activeGroupForms }} />
+          </TabPanel>
+          {categoryRows?.map((category, index) => (
+            <TabPanel key={index}>
+              <FormsTable rows={category.rows} {...{ error, isLoading, activeForms, activeGroupForms }} />
+            </TabPanel>
+          ))}
+        </TabPanels>
+      </Tabs>
+    </div>
+  );
+};
+
+export default FormsPage;

package/src/forms-page/forms-table/FormsTable.tsx

@@ -0,0 +1,117 @@
+import { ErrorState } from '@openmrs/esm-framework';
+import {
+  DataTable,
+  DataTableSkeleton,
+  Table,
+  TableBody,
+  TableCell,
+  TableContainer,
+  TableHead,
+  TableHeader,
+  TableRow,
+  TableToolbar,
+  TableToolbarContent,
+  TableToolbarSearch,
+} from '@carbon/react';
+import React from 'react';
+import { useTranslation } from 'react-i18next';
+import { Link } from 'react-router-dom';
+import EmptyState from '../../empty-state/EmptyState';
+import styles from './styles.scss';
+
+const FormsTable = ({ rows, error, isLoading, activeForms, activeGroupForms }) => {
+  const { t } = useTranslation();
+
+  const tableHeaders = [
+    {
+      key: 'display',
+      header: t('formName', 'Form Name'),
+      isSortable: true,
+    },
+    {
+      key: 'actions',
+      header: t('actions', 'Actions'),
+    },
+    {
+      key: 'actions2',
+      header: '',
+    },
+  ];
+
+  const augmentedRows = rows?.map((row) => ({
+    ...row,
+    actions: (
+      <Link to={`form/${row.uuid}`}>
+        {activeForms.includes(row.uuid) ? t('resumeSession', 'Resume Session') : t('fillForm', 'Fill Form')}
+      </Link>
+    ),
+    actions2: (
+      <Link to={`groupform/${row.uuid}`}>
+        {activeGroupForms.includes(row.uuid)
+          ? t('resumeGroupSession', 'Resume Group Session')
+          : t('startGroupSession', 'Start Group Session')}
+      </Link>
+    ),
+  }));
+
+  if (isLoading) return <DataTableSkeleton />;
+  if (error) {
+    return <ErrorState headerTitle={t('errorLoadingData', 'Error Loading Data')} error={error} />;
+  }
+  if (augmentedRows.length === 0) {
+    return (
+      <EmptyState
+        headerTitle={t('noFormsFound', 'No Forms To Show')}
+        displayText={t(
+          'noFormsFoundMessage',
+          'No forms could be found for this category. Please double check the form concept uuids and access permissions.',
+        )}
+      />
+    );
+  }
+  return (
+    <DataTable rows={augmentedRows} headers={tableHeaders}>
+      {({ rows, headers, getTableProps, getHeaderProps, getRowProps, onInputChange }) => {
+        return (
+          <TableContainer>
+            <div className={styles.toolbarWrapper}>
+              <TableToolbar className={styles.tableToolbar}>
+                <TableToolbarContent>
+                  <TableToolbarSearch onChange={onInputChange} />
+                </TableToolbarContent>
+              </TableToolbar>
+            </div>
+            <Table {...getTableProps()}>
+              <TableHead>
+                <TableRow>
+                  {headers.map((header) => (
+                    <TableHeader
+                      {...getHeaderProps({
+                        header,
+                        isSortable: header.isSortable,
+                      })}
+                    >
+                      {header.header}
+                    </TableHeader>
+                  ))}
+                </TableRow>
+              </TableHead>
+              <TableBody>
+                {rows?.map((row) => (
+                  <TableRow {...getRowProps({ row })}>
+                    {row.cells.map((cell) => (
+                      <TableCell key={cell.id}>{cell.value}</TableCell>
+                    ))}
+                  </TableRow>
+                ))}
+              </TableBody>
+            </Table>
+          </TableContainer>
+        );
+      }}
+    </DataTable>
+  );
+};
+
+export default FormsTable;
+export { FormsTable };

package/src/forms-page/forms-table/index.ts

@@ -0,0 +1,3 @@
+import FormsTable from './FormsTable';
+
+export default FormsTable;

package/src/forms-page/forms-table/styles.scss

@@ -0,0 +1,19 @@
+@use '@carbon/colors';
+@use '@carbon/layout';
+
+.toolbarWrapper {
+  position: relative;
+  display: flex;
+  height: layout.$spacing-09;
+  justify-content: flex-end;
+}
+
+.tableToolbar {
+  width: 20%;
+  min-width: 12.5rem;
+}
+
+.inactiveLink {
+  color: colors.$gray-40;
+  cursor: not-allowed;
+}

package/src/forms-page/index.ts

@@ -0,0 +1,3 @@
+import FormsPage from './FormsPage';
+
+export default FormsPage;

package/src/forms-page/styles.scss

@@ -0,0 +1,9 @@
+@use '@carbon/layout';
+
+.mainContent {
+  padding: layout.$spacing-07;
+}
+
+.pageTitle {
+  margin-bottom: layout.$spacing-06;
+}

package/src/group-form-entry-workflow/GroupFormEntryWorkflow.tsx

@@ -0,0 +1,26 @@
+import { ExtensionSlot } from '@openmrs/esm-framework';
+import React from 'react';
+import GroupDisplayHeader from './group-display-header';
+import styles from './styles.scss';
+import { GroupFormWorkflowProvider } from '../context/GroupFormWorkflowContext';
+import GroupSearchHeader from './group-search-header';
+import SessionMetaWorkspace from './SessionMetaWorkspace';
+import GroupSessionWorkspace from './GroupSessionWorkspace';
+
+const GroupFormEntryWorkflow = () => {
+  return (
+    <GroupFormWorkflowProvider>
+      <div className={styles.breadcrumbsContainer}>
+        <ExtensionSlot name="breadcrumbs-slot" />
+      </div>
+      <GroupSearchHeader />
+      <GroupDisplayHeader />
+      <div className={styles.workspaceWrapper}>
+        <SessionMetaWorkspace />
+        <GroupSessionWorkspace />
+      </div>
+    </GroupFormWorkflowProvider>
+  );
+};
+
+export default GroupFormEntryWorkflow;

package/src/group-form-entry-workflow/GroupSessionWorkspace.tsx

@@ -0,0 +1,207 @@
+import { getGlobalStore, useConfig, useSession, useStore } from '@openmrs/esm-framework';
+import { Button } from '@carbon/react';
+import React, { useCallback, useContext, useEffect, useState } from 'react';
+import PatientCard from '../patient-card/PatientCard';
+import styles from './styles.scss';
+import { useTranslation } from 'react-i18next';
+import { v4 as uuid } from 'uuid';
+import GroupFormWorkflowContext from '../context/GroupFormWorkflowContext';
+import FormBootstrap from '../FormBootstrap';
+import CompleteModal from '../CompleteModal';
+import CancelModal from '../CancelModal';
+
+const formStore = getGlobalStore('ampath-form-state');
+
+const WorkflowNavigationButtons = () => {
+  const context = useContext(GroupFormWorkflowContext);
+  const { activeFormUuid, submitForNext, patientUuids, activePatientUuid, workflowState } = context;
+  const store = useStore(formStore);
+  const formState = store[activeFormUuid];
+  const navigationDisabled =
+    (formState !== 'ready' || workflowState !== 'EDIT_FORM') && formState !== 'readyWithValidationErrors';
+  const [cancelModalOpen, setCancelModalOpen] = useState(false);
+  const [completeModalOpen, setCompleteModalOpen] = useState(false);
+  const { t } = useTranslation();
+
+  const isLastPatient = activePatientUuid === patientUuids[patientUuids.length - 1];
+
+  const handleClickNext = () => {
+    if (workflowState === 'EDIT_FORM' || formState === 'readyWithValidationErrors') {
+      submitForNext();
+    }
+  };
+
+  return (
+    <>
+      <div className={styles.rightPanelActionButtons}>
+        <Button kind="primary" onClick={handleClickNext} disabled={navigationDisabled}>
+          {isLastPatient ? t('saveForm', 'Save Form') : t('nextPatient', 'Next patient')}
+        </Button>
+        <Button kind="secondary" onClick={() => setCompleteModalOpen(true)}>
+          {t('saveAndComplete', 'Save & Complete')}
+        </Button>
+        <Button kind="tertiary" onClick={() => setCancelModalOpen(true)}>
+          {t('cancel', 'Cancel')}
+        </Button>
+      </div>
+      <CancelModal open={cancelModalOpen} setOpen={setCancelModalOpen} context={context} />
+      <CompleteModal open={completeModalOpen} setOpen={setCompleteModalOpen} context={context} validateFirst={false} />
+    </>
+  );
+};
+
+const GroupSessionWorkspace = () => {
+  const { groupSessionConcepts } = useConfig();
+  const { t } = useTranslation();
+  const {
+    patientUuids,
+    activePatientUuid,
+    encounters,
+    activeEncounterUuid,
+    activeVisitUuid,
+    activeFormUuid,
+    activeGroupUuid,
+    activeGroupName,
+    activeSessionUuid,
+    saveEncounter,
+    activeSessionMeta,
+    groupVisitTypeUuid,
+    updateVisitUuid,
+    submitForNext,
+    workflowState,
+  } = useContext(GroupFormWorkflowContext);
+
+  const { sessionLocation } = useSession();
+
+  useEffect(() => {
+    if (activeVisitUuid) {
+      updateVisitUuid(activeVisitUuid);
+    }
+  }, [updateVisitUuid, activeVisitUuid, activePatientUuid]);
+
+  // If there's no active visit, trigger the creation of a new one
+  const handleEncounterCreate = useCallback(
+    (payload) => {
+      // Create a visit with the same date as the encounter being saved
+      const obsTime = new Date(activeSessionMeta.sessionDate);
+      payload.obs.forEach((item, index) => {
+        payload.obs[index] = {
+          ...item,
+          groupMembers: item.groupMembers?.map((mem) => ({
+            ...mem,
+            obsDatetime: obsTime.toISOString(),
+          })),
+          obsDatetime: obsTime.toISOString(),
+        };
+      });
+      const visitUuid = activeVisitUuid ? activeVisitUuid : uuid();
+      if (!activeVisitUuid) {
+        Object.entries(groupSessionConcepts).forEach(([field, uuid]) => {
+          if (activeSessionMeta?.[field] != null) {
+            payload.obs.push({
+              concept: uuid,
+              value: activeSessionMeta[field],
+            });
+          }
+        });
+
+        const otherIdentifiers = [
+          { concept: groupSessionConcepts.cohortId, value: activeGroupUuid },
+          { concept: groupSessionConcepts.cohortName, value: activeGroupName },
+          {
+            concept: groupSessionConcepts.sessionUuid,
+            value: activeSessionUuid,
+          },
+        ];
+        payload.obs.push(...otherIdentifiers);
+        // If this is a newly created encounter and visit, add session concepts to encounter payload.
+        const visitInfo = {
+          startDatetime: activeSessionMeta.sessionDate,
+          stopDatetime: activeSessionMeta.sessionDate,
+          uuid: visitUuid,
+          patient: {
+            uuid: activePatientUuid,
+          },
+          location: {
+            uuid: sessionLocation?.uuid,
+          },
+          visitType: {
+            uuid: groupVisitTypeUuid,
+          },
+        };
+        payload.visit = visitInfo;
+        updateVisitUuid(visitUuid);
+      }
+      payload.location = sessionLocation?.uuid;
+      payload.encounterDatetime = obsTime.toISOString();
+    },
+    [
+      activeSessionMeta,
+      activeVisitUuid,
+      sessionLocation?.uuid,
+      groupSessionConcepts,
+      activeGroupUuid,
+      activeGroupName,
+      activeSessionUuid,
+      activePatientUuid,
+      groupVisitTypeUuid,
+      updateVisitUuid,
+    ],
+  );
+
+  // Once form has been posted, save the new encounter uuid so we can edit it later
+  const handlePostResponse = useCallback(
+    (encounter) => {
+      if (encounter && encounter.uuid) {
+        saveEncounter(encounter.uuid);
+      }
+    },
+    [saveEncounter],
+  );
+
+  const switchPatient = useCallback(
+    (patientUuid) => {
+      submitForNext(patientUuid);
+    },
+    [submitForNext],
+  );
+
+  if (workflowState === 'NEW_GROUP_SESSION') return null;
+
+  return (
+    <div className={styles.workspace}>
+      <div className={styles.formMainContent}>
+        <div className={styles.formContainer}>
+          <FormBootstrap
+            patientUuid={activePatientUuid}
+            encounterUuid={activeEncounterUuid}
+            {...{
+              formUuid: activeFormUuid,
+              handlePostResponse,
+              handleEncounterCreate,
+            }}
+          />
+        </div>
+        <div className={styles.rightPanel}>
+          <h4>{t('formsFilled', 'Forms filled')}</h4>
+          <div className={styles.patientCardsSection}>
+            {patientUuids?.map((patientUuid) => (
+              <PatientCard
+                key={patientUuid}
+                {...{
+                  patientUuid,
+                  activePatientUuid,
+                  editEncounter: switchPatient,
+                  encounters,
+                }}
+              />
+            ))}
+          </div>
+          <WorkflowNavigationButtons />
+        </div>
+      </div>
+    </div>
+  );
+};
+
+export default GroupSessionWorkspace;

package/src/group-form-entry-workflow/SessionDetailsForm.tsx

@@ -0,0 +1,154 @@
+import { Layer, Tile, TextInput, TextArea, DatePicker, DatePickerInput } from '@carbon/react';
+import React, { useContext } from 'react';
+import { useConfig } from '@openmrs/esm-framework';
+import { useParams } from 'react-router-dom';
+import styles from './styles.scss';
+import { useTranslation } from 'react-i18next';
+import { Controller, useFormContext } from 'react-hook-form';
+import { AttendanceTable } from './attendance-table';
+import GroupFormWorkflowContext from '../context/GroupFormWorkflowContext';
+import useGetPatients from '../hooks/useGetPatients';
+import ConfigurableQuestionsSection from './configurable-questions/ConfigurableQuestionsSection';
+import useSpecificQuestions from '../hooks/useForm';
+
+interface ParamTypes {
+  formUuid?: string;
+}
+
+const SessionDetailsForm = () => {
+  const { specificQuestions } = useConfig();
+  const { formUuid } = useParams() as ParamTypes;
+  const { questions } = useSpecificQuestions(formUuid, specificQuestions);
+
+  const { t } = useTranslation();
+  const {
+    register,
+    formState: { errors },
+    control,
+  } = useFormContext();
+
+  const { activeGroupMembers } = useContext(GroupFormWorkflowContext);
+  const { patients, isLoading } = useGetPatients(activeGroupMembers);
+
+  return (
+    <div>
+      {!isLoading && (
+        <div className={styles.formSection}>
+          <h4>{t('sessionDetails', '1. Session details')}</h4>
+          <div>
+            <p>{t('allFieldsRequired', 'All fields are required unless marked optional')}</p>
+          </div>
+          <Layer>
+            <Tile className={styles.formSectionTile}>
+              <Layer>
+                <div
+                  style={{
+                    display: 'flex',
+                    flexDirection: 'column',
+                    rowGap: '1.5rem',
+                  }}
+                >
+                  <TextInput
+                    id="text"
+                    type="text"
+                    labelText={t('sessionName', 'Session Name')}
+                    {...register('sessionName', { required: true })}
+                    invalid={errors.sessionName}
+                    invalidText={t('requiredField', 'This field is required')}
+                  />
+                  <TextInput
+                    id="text"
+                    type="text"
+                    labelText={t('practitionerName', 'Practitioner Name')}
+                    {...register('practitionerName', { required: true })}
+                    invalid={errors.practitionerName}
+                    invalidText={t('requiredField', 'This field is required')}
+                  />
+                  <Controller
+                    name="sessionDate"
+                    control={control}
+                    rules={{ required: true }}
+                    render={({ field }) => (
+                      <DatePicker datePickerType="single" size="md" maxDate={new Date()} {...field}>
+                        <DatePickerInput
+                          id="session-date"
+                          labelText={t('sessionDate', 'Session Date')}
+                          placeholder="mm/dd/yyyy"
+                          size="md"
+                          invalid={errors.sessionDate}
+                          invalidText={t('requiredField', 'This field is required')}
+                        />
+                      </DatePicker>
+                    )}
+                  />
+                  <TextArea
+                    id="text"
+                    type="text"
+                    labelText={t('sessionNotes', 'Session Notes')}
+                    {...register('sessionNotes', { required: true })}
+                    invalid={errors.sessionNotes}
+                    invalidText={t('requiredField', 'This field is required')}
+                  />
+                </div>
+              </Layer>
+            </Tile>
+          </Layer>
+          <h4>{t('sessionParticipants', '2. Session participants')}</h4>
+          <div>
+            <p>
+              {t(
+                'markAbsentPatients',
+                'The patients in this group. Patients that are not present in the session should be marked as absent.',
+              )}
+            </p>
+          </div>
+          <Layer>
+            <Tile className={styles.formSectionTile}>
+              <Layer>
+                <div
+                  style={{
+                    display: 'flex',
+                    flexDirection: 'column',
+                    rowGap: '1.5rem',
+                  }}
+                >
+                  <AttendanceTable patients={patients} />
+                </div>
+              </Layer>
+            </Tile>
+          </Layer>
+          {questions?.length > 0 ? (
+            <>
+              <h4>{t('sessionSpecificDetails', '3. Specific details')}</h4>
+              <div>
+                <p>
+                  {t(
+                    'sessionSpecificDetailsDescription',
+                    'They will be mapped to form responses for all patients as pre-filled data.',
+                  )}
+                </p>
+              </div>
+              <Layer>
+                <Tile className={styles.formSectionTile}>
+                  <Layer>
+                    <div
+                      style={{
+                        display: 'flex',
+                        flexDirection: 'column',
+                        rowGap: '1.5rem',
+                      }}
+                    >
+                      <ConfigurableQuestionsSection register={register} specificQuestions={questions} />
+                    </div>
+                  </Layer>
+                </Tile>
+              </Layer>
+            </>
+          ) : null}
+        </div>
+      )}
+    </div>
+  );
+};
+
+export default SessionDetailsForm;