@kenyaemr/esm-patient-registration-app 4.3.0

package/src/patient-registration/field/field.scss

@@ -0,0 +1,127 @@
+@use '@carbon/styles/scss/spacing';
+@use '@carbon/styles/scss/type';
+@import '~@openmrs/esm-styleguide/src/vars';
+
+.productiveHeading02 {
+  @include type.type-style('heading-compact-02');
+  margin-bottom: 1rem;
+}
+
+.productiveHeading02Light {
+  @include type.type-style('heading-compact-02');
+  margin-bottom: 1rem;
+  color: #525252;
+}
+
+.label01 {
+  @include type.type-style('label-01');
+}
+
+.grid {
+  display: grid;
+  grid-template-columns: 1fr 1fr;
+  column-gap: spacing.$spacing-05;
+}
+
+.halfWidthInDesktopView {
+  width: calc(50% - spacing.$spacing-05);
+}
+
+.patientPhoto {
+  display: flex;
+  justify-content: center;
+}
+
+.nameField {
+  grid-row: 1;
+  grid-column: 1;
+}
+
+.nameField > :global(.cds--content-switcher) {
+  display: grid;
+  grid-template-columns: 1fr 1fr;
+  width: max-content;
+  justify-content: flex-start;
+}
+
+.contentSwitcher {
+  margin-bottom: 1rem;
+}
+
+.dobField > :global(.cds--content-switcher) {
+  display: grid;
+  grid-template-columns: 1fr 1fr;
+  width: max-content;
+  justify-content: flex-start;
+}
+
+.photoExtension {
+  margin-bottom: 1rem;
+  grid-row: 1;
+  grid-column: 2;
+  justify-self: center;
+}
+
+.sexField,
+.dobField {
+  margin-bottom: spacing.$spacing-05;
+}
+
+.dobContentSwitcherLabel {
+  margin-bottom: spacing.$spacing-03;
+}
+
+.identifierLabelText {
+  display: flex;
+  align-items: center;
+}
+
+.setIDNumberButton {
+  margin-bottom: spacing.$spacing-05;
+}
+
+.setIDNumberButton > svg {
+  margin-left: spacing.$spacing-03;
+}
+
+.customField {
+  margin-bottom: spacing.$spacing-05;
+}
+
+.attributeField {
+  margin-bottom: spacing.$spacing-05;
+}
+
+:global(.omrs-breakpoint-lt-desktop) {
+  .grid {
+    grid-template-columns: 1fr;
+    grid-template-rows: auto auto;
+  }
+  .nameField {
+    grid-row: 2;
+    grid-column: 1;
+  }
+  .photoExtension {
+    grid-column: 1;
+    grid-row: 1;
+    justify-self: start;
+  }
+  .radioButton label {
+    height: spacing.$spacing-09 !important;
+  }
+  .halfWidthInDesktopView {
+    width: 100%;
+  }
+}
+
+.radioFieldError {
+  color: #da1e28;
+  display: block;
+  font-weight: 400;
+  max-height: 12.5rem;
+  overflow: visible;
+  font-size: 0.75rem;
+  letter-spacing: 0.32px;
+  line-height: 1.34;
+  margin: 0.25rem 0 0;
+}

package/src/patient-registration/field/gender/gender-field.component.tsx

@@ -0,0 +1,49 @@
+import React, { useContext } from 'react';
+import { RadioButton, RadioButtonGroup } from '@carbon/react';
+import styles from '../field.scss';
+import { useTranslation } from 'react-i18next';
+import { PatientRegistrationContext } from '../../patient-registration-context';
+import { useField } from 'formik';
+import { RegistrationConfig } from '../../../config-schema';
+import { useConfig } from '@openmrs/esm-framework';
+
+export const GenderField: React.FC = () => {
+  const { fieldConfigurations } = useConfig() as RegistrationConfig;
+  const { t } = useTranslation();
+  const [field, meta] = useField('gender');
+  const { setFieldValue } = useContext(PatientRegistrationContext);
+  const fieldConfigs = fieldConfigurations?.gender;
+
+  const setGender = (gender: string) => {
+    setFieldValue('gender', gender);
+  };
+  /**
+   * DO NOT REMOVE THIS COMMENT HERE, ADDS TRANSLATION FOR SEX OPTIONS
+   * t('male', 'Male')
+   * t('female', 'Female')
+   * t('other', 'Other')
+   * t('unknown', 'Unknown')
+   */
+
+  return (
+    <div className={styles.halfWidthInDesktopView}>
+      <h4 className={styles.productiveHeading02Light}>{t('sexFieldLabelText', 'Sex')}</h4>
+      <div className={styles.sexField}>
+        <p className="cds--label">{t('genderLabelText', 'Sex')}</p>
+        <RadioButtonGroup name="gender" orientation="vertical" onChange={setGender} valueSelected={field.value}>
+          {fieldConfigs.map((option) => (
+            <RadioButton
+              key={option.label}
+              id={option.id}
+              value={option.value}
+              labelText={t(`${option.label}`, `${option.label}`)}
+            />
+          ))}
+        </RadioButtonGroup>
+        {meta.touched && meta.error && (
+          <div className={styles.radioFieldError}>{t(meta.error, 'Gender is required')}</div>
+        )}
+      </div>
+    </div>
+  );
+};

package/src/patient-registration/field/gender/gender-field.test.tsx

@@ -0,0 +1,66 @@
+import React, { useContext } from 'react';
+import { render, fireEvent } from '@testing-library/react';
+import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
+import { Formik, Form } from 'formik';
+
+import { GenderField } from './gender-field.component';
+
+jest.mock('@openmrs/esm-framework', () => ({
+  ...(jest.requireActual('@openmrs/esm-framework') as any),
+  useConfig: jest.fn(() => ({
+    fieldConfigurations: {
+      gender: [
+        {
+          value: 'Male',
+          label: 'Male',
+          id: 'male',
+        },
+      ],
+      name: {
+        displayMiddleName: false,
+        unidentifiedPatient: false,
+        defaultUnknownGivenName: '',
+        defaultUnknownFamilyName: '',
+      },
+    },
+  })),
+}));
+
+jest.mock('react', () => ({
+  ...(jest.requireActual('react') as any),
+  useContext: jest.fn(() => ({
+    setFieldValue: jest.fn(),
+  })),
+}));
+
+jest.mock('formik', () => ({
+  ...(jest.requireActual('formik') as any),
+  useField: jest.fn(() => [{}, {}]),
+}));
+
+describe('GenderField', () => {
+  const renderComponent = () => {
+    return render(
+      <Formik initialValues={{}} onSubmit={null}>
+        <Form>
+          <GenderField />
+        </Form>
+      </Formik>,
+    );
+  };
+
+  it('renders', () => {
+    expect(renderComponent()).not.toBeNull();
+  });
+
+  it('has a label', () => {
+    expect(renderComponent().getAllByText('Sex')).toBeTruthy();
+  });
+
+  it('checks an option', () => {
+    const component = renderComponent();
+    fireEvent.click(component.getByLabelText('Male'));
+    expect(component.getByLabelText('Male')).toBeChecked();
+  });
+});

package/src/patient-registration/field/id/id-field.component.tsx

@@ -0,0 +1,142 @@
+import React, { useContext, useEffect, useState } from 'react';
+import { useTranslation } from 'react-i18next';
+import { Button, SkeletonText } from '@carbon/react';
+import { ArrowRight } from '@carbon/react/icons';
+import { useLayoutType, useConfig, isDesktop, UserHasAccess } from '@openmrs/esm-framework';
+import IdentifierSelectionOverlay from './identifier-selection-overlay';
+import { IdentifierInput } from '../../input/custom-input/identifier/identifier-input.component';
+import { PatientRegistrationContext } from '../../patient-registration-context';
+import {
+  FormValues,
+  IdentifierSource,
+  PatientIdentifierType,
+  PatientIdentifierValue,
+} from '../../patient-registration-types';
+import { ResourcesContext } from '../../../offline.resources';
+import styles from '../field.scss';
+
+export function setIdentifierSource(
+  identifierSource: IdentifierSource,
+  identifierValue: string,
+  initialValue: string,
+): {
+  identifierValue: string;
+  autoGeneration: boolean;
+  selectedSource: IdentifierSource;
+} {
+  const autoGeneration = identifierSource?.autoGenerationOption?.automaticGenerationEnabled;
+  return {
+    selectedSource: identifierSource,
+    autoGeneration,
+    identifierValue: autoGeneration
+      ? 'auto-generated'
+      : identifierValue !== 'auto-generated'
+      ? identifierValue
+      : initialValue,
+  };
+}
+
+export function initializeIdentifier(identifierType: PatientIdentifierType, identifierProps): PatientIdentifierValue {
+  return {
+    identifierTypeUuid: identifierType.uuid,
+    identifierName: identifierType.name,
+    preferred: identifierType.isPrimary,
+    initialValue: '',
+    required: identifierType.isPrimary || identifierType.required,
+    ...identifierProps,
+    ...setIdentifierSource(
+      identifierProps?.selectedSource ?? identifierType.identifierSources?.[0],
+      identifierProps?.identifierValue,
+      identifierProps?.initialValue ?? '',
+    ),
+  };
+}
+
+export function deleteIdentifierType(identifiers: FormValues['identifiers'], identifierFieldName) {
+  return Object.fromEntries(Object.entries(identifiers).filter(([fieldName]) => fieldName !== identifierFieldName));
+}
+
+export const Identifiers: React.FC = () => {
+  const { identifierTypes } = useContext(ResourcesContext);
+  const isLoading = !identifierTypes;
+  const { values, setFieldValue, initialFormValues } = useContext(PatientRegistrationContext);
+  const { t } = useTranslation();
+  const layout = useLayoutType();
+  const [showIdentifierOverlay, setShowIdentifierOverlay] = useState(false);
+  const config = useConfig();
+  const { defaultPatientIdentifierTypes } = config;
+
+  useEffect(() => {
+    // Initialization
+    if (identifierTypes) {
+      const identifiers = {};
+      identifierTypes
+        .filter(
+          (type) =>
+            type.isPrimary ||
+            type.required ||
+            !!defaultPatientIdentifierTypes?.find(
+              (defaultIdentifierTypeUuid) => defaultIdentifierTypeUuid === type.uuid,
+            ),
+        )
+        .filter((type) => !values.identifiers[type.fieldName])
+        .forEach((type) => {
+          identifiers[type.fieldName] = initializeIdentifier(
+            type,
+            values.identifiers[type.uuid] ?? initialFormValues.identifiers[type.uuid] ?? {},
+          );
+        });
+      /*
+        Identifier value should only be updated if there is any update in the
+        identifier values, otherwise, if the below 'if' clause is removed, it will
+        fall into an infinite run.
+      */
+      if (Object.keys(identifiers).length) {
+        setFieldValue('identifiers', {
+          ...values.identifiers,
+          ...identifiers,
+        });
+      }
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [identifierTypes, setFieldValue, defaultPatientIdentifierTypes, values.identifiers, initializeIdentifier]);
+
+  if (isLoading) {
+    return (
+      <div className={styles.halfWidthInDesktopView}>
+        <div className={styles.identifierLabelText}>
+          <h4 className={styles.productiveHeading02Light}>{t('idFieldLabelText', 'Identifiers')}</h4>
+        </div>
+        <SkeletonText />
+      </div>
+    );
+  }
+
+  return (
+    <div className={styles.halfWidthInDesktopView}>
+      <UserHasAccess privilege={['Get Identifier Types', 'Add Patient Identifiers']}>
+        <div className={styles.identifierLabelText}>
+          <h4 className={styles.productiveHeading02Light}>{t('idFieldLabelText', 'Identifiers')}</h4>
+          <Button
+            kind="ghost"
+            className={styles.setIDNumberButton}
+            onClick={() => setShowIdentifierOverlay(true)}
+            size={isDesktop(layout) ? 'sm' : 'md'}>
+            {t('configure', 'Configure')} <ArrowRight size={16} />
+          </Button>
+        </div>
+      </UserHasAccess>
+      <div>
+        {Object.entries(values.identifiers).map(([fieldName, identifier]) => (
+          <IdentifierInput key={fieldName} fieldName={fieldName} patientIdentifier={identifier} />
+        ))}
+        {showIdentifierOverlay && (
+          <IdentifierSelectionOverlay
+            setFieldValue={setFieldValue}
+            closeOverlay={() => setShowIdentifierOverlay(false)}
+          />
+        )}
+      </div>
+    </div>
+  );
+};

package/src/patient-registration/field/id/identifier-selection-overlay.tsx

@@ -0,0 +1,194 @@
+import React, { useMemo, useCallback, useEffect, useState, useContext } from 'react';
+import { useTranslation } from 'react-i18next';
+import { Button, ButtonSet, Checkbox, Search, RadioButtonGroup, RadioButton } from '@carbon/react';
+import { isDesktop, useConfig, useLayoutType } from '@openmrs/esm-framework';
+import { FormValues, PatientIdentifierType, PatientIdentifierValue } from '../../patient-registration-types';
+import Overlay from '../../ui-components/overlay';
+import { ResourcesContext } from '../../../offline.resources';
+import { PatientRegistrationContext } from '../../patient-registration-context';
+import {
+  isUniqueIdentifierTypeForOffline,
+  shouldBlockPatientIdentifierInOfflineMode,
+} from '../../input/custom-input/identifier/utils';
+import { initializeIdentifier, setIdentifierSource } from './id-field.component';
+import styles from './identifier-selection.scss';
+
+interface PatientIdentifierOverlayProps {
+  setFieldValue: (string, PatientIdentifierValue) => void;
+  closeOverlay: () => void;
+}
+
+const PatientIdentifierOverlay: React.FC<PatientIdentifierOverlayProps> = ({ closeOverlay, setFieldValue }) => {
+  const layout = useLayoutType();
+  const { identifierTypes } = useContext(ResourcesContext);
+  const { isOffline, values, initialFormValues } = useContext(PatientRegistrationContext);
+  const [unsavedIdentifierTypes, setUnsavedIdentifierTypes] = useState<FormValues['identifiers']>(values.identifiers);
+  const [searchString, setSearchString] = useState<string>('');
+  const { t } = useTranslation();
+  const { defaultPatientIdentifierTypes } = useConfig();
+  const defaultPatientIdentifierTypesMap = useMemo(() => {
+    const map = {};
+    defaultPatientIdentifierTypes?.forEach((typeUuid) => {
+      map[typeUuid] = true;
+    });
+    return map;
+  }, [defaultPatientIdentifierTypes]);
+
+  useEffect(() => {
+    setUnsavedIdentifierTypes(values.identifiers);
+  }, [values.identifiers]);
+
+  const handleSearch = useCallback((event) => setSearchString(event?.target?.value ?? ''), []);
+
+  const filteredIdentifiers = useMemo(
+    () => identifierTypes?.filter((identifier) => identifier?.name?.toLowerCase().includes(searchString.toLowerCase())),
+    [unsavedIdentifierTypes, searchString],
+  );
+
+  const handleCheckingIdentifier = (identifierType: PatientIdentifierType, checked: boolean) =>
+    setUnsavedIdentifierTypes((unsavedIdentifierTypes) => {
+      if (checked) {
+        return {
+          ...unsavedIdentifierTypes,
+          [identifierType.fieldName]: initializeIdentifier(
+            identifierType,
+            values.identifiers[identifierType.fieldName] ??
+              initialFormValues.identifiers[identifierType.fieldName] ??
+              {},
+          ),
+        };
+      }
+      if (unsavedIdentifierTypes[identifierType.fieldName]) {
+        return Object.fromEntries(
+          Object.entries(unsavedIdentifierTypes).filter(([fieldName]) => fieldName !== identifierType.fieldName),
+        );
+      }
+      return unsavedIdentifierTypes;
+    });
+
+  const handleSelectingIdentifierSource = (identifierType: PatientIdentifierType, sourceUuid) =>
+    setUnsavedIdentifierTypes((unsavedIdentifierTypes) => ({
+      ...unsavedIdentifierTypes,
+      [identifierType.fieldName]: {
+        ...unsavedIdentifierTypes[identifierType.fieldName],
+        ...setIdentifierSource(
+          identifierType.identifierSources.find((source) => source.uuid === sourceUuid),
+          unsavedIdentifierTypes[identifierType.fieldName].identifierValue,
+          unsavedIdentifierTypes[identifierType.fieldName].initialValue,
+        ),
+      },
+    }));
+
+  const identifierTypeFields = useMemo(
+    () =>
+      filteredIdentifiers.map((identifierType) => {
+        const patientIdentifier = unsavedIdentifierTypes[identifierType.fieldName];
+        const isDisabled =
+          identifierType.isPrimary ||
+          identifierType.required ||
+          defaultPatientIdentifierTypesMap[identifierType.uuid] ||
+          // De-selecting shouldn't be allowed if the identifier was selected earlier and is present in the form.
+          // If the user wants to de-select an identifier-type already present in the form, they'll need to delete the particular identifier from the form itself.
+          values.identifiers[identifierType.fieldName];
+        const isDisabledOffline = isOffline && shouldBlockPatientIdentifierInOfflineMode(identifierType);
+
+        return (
+          <div key={identifierType.uuid} className={styles.space05}>
+            <Checkbox
+              id={identifierType.uuid}
+              value={identifierType.uuid}
+              labelText={identifierType.name}
+              onChange={(e, { checked }) => handleCheckingIdentifier(identifierType, checked)}
+              checked={!!patientIdentifier}
+              disabled={isDisabled || (isOffline && isDisabledOffline)}
+            />
+            {patientIdentifier &&
+              identifierType?.identifierSources?.length > 0 &&
+              /* 
+                This check are for the cases when there's an initialValue identifier is assigned
+                to the patient
+                The corresponding flow is like:
+                1. If there's no change to the actual initial identifier, then the source remains null, 
+                hence the list of the identifier sources shouldn't be displayed.
+                2. If user wants to edit the patient identifier's value, hence there will be an initialValue,
+                along with a source assigned to itself(only if the identifierType has sources, else there's nothing to worry about), which by
+                default is the first identifierSource
+              */
+              (!patientIdentifier.initialValue || patientIdentifier?.selectedSource) && (
+                <div className={styles.radioGroup}>
+                  <RadioButtonGroup
+                    legendText={t('source', 'Source')}
+                    name={`${identifierType?.fieldName}-identifier-sources`}
+                    defaultSelected={patientIdentifier?.selectedSource?.uuid}
+                    onChange={(sourceUuid: string) => handleSelectingIdentifierSource(identifierType, sourceUuid)}
+                    orientation="vertical">
+                    {identifierType?.identifierSources.map((source) => (
+                      <RadioButton
+                        key={source.uuid}
+                        labelText={source.name}
+                        name={source.uuid}
+                        value={source.uuid}
+                        className={styles.radioButton}
+                        disabled={
+                          isOffline &&
+                          isUniqueIdentifierTypeForOffline(identifierType) &&
+                          source.autoGenerationOption?.manualEntryEnabled
+                        }
+                      />
+                    ))}
+                  </RadioButtonGroup>
+                </div>
+              )}
+          </div>
+        );
+      }),
+    [
+      filteredIdentifiers,
+      unsavedIdentifierTypes,
+      defaultPatientIdentifierTypesMap,
+      values.identifiers,
+      isOffline,
+      handleCheckingIdentifier,
+    ],
+  );
+
+  const handleConfiguringIdentifiers = useCallback(() => {
+    setFieldValue('identifiers', unsavedIdentifierTypes);
+    closeOverlay();
+  }, [unsavedIdentifierTypes, setFieldValue]);
+
+  return (
+    <Overlay
+      close={closeOverlay}
+      header={t('configureIdentifiers', 'Configure identifiers')}
+      buttonsGroup={
+        <ButtonSet className={isDesktop(layout) ? styles.desktop : styles.tablet}>
+          <Button className={styles.button} kind="secondary" onClick={closeOverlay}>
+            {t('cancel', 'Cancel')}
+          </Button>
+          <Button className={styles.button} kind="primary" onClick={handleConfiguringIdentifiers}>
+            {t('configureIdentifiers', 'Configure identifiers')}
+          </Button>
+        </ButtonSet>
+      }>
+      <div>
+        <p className={styles.bodyLong02}>
+          {t('IDInstructions', "Select the identifiers you'd like to add for this patient:")}
+        </p>
+        {identifierTypes.length > 7 && (
+          <div className={styles.space05}>
+            <Search
+              labelText={t('searchIdentifierPlaceholder', 'Search identifier')}
+              placeholder={t('searchIdentifierPlaceholder', 'Search identifier')}
+              onChange={handleSearch}
+              value={searchString}
+            />
+          </div>
+        )}
+        <fieldset>{identifierTypeFields}</fieldset>
+      </div>
+    </Overlay>
+  );
+};
+
+export default PatientIdentifierOverlay;

package/src/patient-registration/field/id/identifier-selection.scss

@@ -0,0 +1,37 @@
+@use '@carbon/styles/scss/spacing';
+@import '../../patient-registration.scss';
+
+.button {
+  height: 4rem;
+  display: flex;
+  align-content: flex-start;
+  align-items: baseline;
+  min-width: 50%;
+}
+
+.tablet {
+  padding: 1.5rem 1rem;
+  background-color: $ui-02;
+}
+
+.desktop {
+  padding: 0rem;
+}
+
+.radioGroup {
+  background-color: $ui-01;
+  padding: spacing.$spacing-05;
+}
+
+.radioButton {
+  margin: 0 !important;
+  label {
+    height: spacing.$spacing-07;
+  }
+}
+
+:global(.omrs-breakpoint-lt-desktop) {
+  .radioButton label {
+    height: spacing.$spacing-09 !important;
+  }
+}