(feat) O3-3316 Add support for encounter diagnosis

src/adapters/encounter-diagnosis-adapter.test.ts

@@ -0,0 +1,232 @@
+import { type FormContextProps } from '../provider/form-provider';
+import { type FormField } from '../types';
+import { EncounterDiagnosisAdapter } from './encounter-diagnosis-adapter';
+
+const formContext = {
+  methods: null,
+  workspaceLayout: 'maximized',
+  isSubmitting: false,
+  patient: {
+    id: '833db896-c1f0-11eb-8529-0242ac130003',
+  },
+  formJson: null,
+  visit: null,
+  sessionMode: 'enter',
+  sessionDate: new Date(),
+  location: {
+    uuid: '41e6e516-c1f0-11eb-8529-0242ac130003',
+  },
+  currentProvider: null,
+  layoutType: 'small-desktop',
+  domainObjectValue: {
+    uuid: '873455da-3ec4-453c-b565-7c1fe35426be',
+    obs: [],
+    diagnoses: [],
+  },
+  previousDomainObjectValue: null,
+  processor: null,
+  formFields: [],
+  formFieldAdapters: null,
+  formFieldValidators: null,
+  customDependencies: {
+    patientPrograms: [],
+  },
+  deletedFields: [],
+  getFormField: jest.fn(),
+  addFormField: jest.fn(),
+  updateFormField: jest.fn(),
+  removeFormField: () => {},
+  addInvalidField: jest.fn(),
+  removeInvalidField: jest.fn(),
+  setInvalidFields: jest.fn(),
+  setForm: jest.fn(),
+  setDeletedFields: jest.fn(),
+} as FormContextProps;
+
+const field = {
+  label: 'Test Diagnosis',
+  id: 'DiagNosIS',
+  type: 'diagnosis',
+  questionOptions: {
+    rendering: 'repeating',
+    diagnosis: {
+      rank: 1,
+      isConfirmed: false,
+    },
+    datasource: {
+      name: 'problem_datasource',
+      config: {
+        class: [
+          '8d4918b0-c2cc-11de-8d13-0010c6dffd0f',
+          '8d492954-c2cc-11de-8d13-0010c6dffd0f',
+          '8d492b2a-c2cc-11de-8d13-0010c6dffd0f',
+        ],
+      },
+    },
+  },
+  meta: {
+    submission: {
+      newValue: null,
+    },
+    previousValue: null,
+  },
+  validators: [
+    {
+      type: 'form_field',
+    },
+    {
+      type: 'default_value',
+    },
+  ],
+  isHidden: false,
+  isRequired: false,
+  isDisabled: false,
+} as FormField;
+
+const diagnoses = [
+  {
+    uuid: '8d975f9e-e9e6-452f-be7c-0e87c047f056',
+    diagnosis: {
+      coded: {
+        uuid: '127133AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+        display: 'Schistosoma Mansonii Infection',
+        links: [],
+      },
+    },
+    condition: null,
+    encounter: {
+      uuid: '9a4b06bd-d655-414f-b9ce-69e940c337ce',
+    },
+    certainty: 'CONFIRMED',
+    rank: 1,
+    voided: false,
+    display: 'Schistosoma Mansonii Infection',
+    patient: {
+      uuid: '00affa97-0010-417c-87f5-de48362de915',
+      display: '1000VKV - Bett Tett',
+    },
+    formFieldNamespace: 'rfe-forms',
+    formFieldPath: 'rfe-forms-DiagNosIS_1',
+    links: [],
+    resourceVersion: '1.8',
+  },
+  {
+    uuid: 'b2d0e95b-d2f6-49d1-a477-acc7026edbd7',
+    diagnosis: {
+      coded: {
+        uuid: '137329AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+        display: 'Infection due to Entamoeba Histolytica',
+        links: [],
+      },
+    },
+    condition: null,
+    encounter: {
+      uuid: '9a4b06bd-d655-414f-b9ce-69e940c337ce',
+    },
+    certainty: 'PROVISIONAL',
+    rank: 1,
+    voided: false,
+    display: 'Infection due to Entamoeba Histolytica',
+    patient: {
+      uuid: '00affa97-0010-417c-87f5-de48362de915',
+      display: '1000VKV - Bett Tett',
+    },
+    formFieldNamespace: 'rfe-forms',
+    formFieldPath: 'rfe-forms-DiagNosIS',
+    links: [],
+    resourceVersion: '1.8',
+  },
+];
+
+describe('EncounterDiagnosisAdapter', () => {
+  it('should should handle submission of a diagnosis field', async () => {
+    const value = '127133AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA';
+    EncounterDiagnosisAdapter.transformFieldValue(field, value, formContext);
+    expect(field.meta.submission.newValue).toEqual({
+      patient: '833db896-c1f0-11eb-8529-0242ac130003',
+      condition: null,
+      diagnosis: {
+        coded: '127133AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+      },
+      certainty: 'PROVISIONAL',
+      rank: 1,
+      formFieldPath: 'rfe-forms-DiagNosIS',
+      formFieldNamespace: 'rfe-forms',
+    });
+  });
+
+  it('should get initial value for the diagnosis', async () => {
+    formContext.domainObjectValue.diagnoses.push(...diagnoses);
+    const diagnosis = await EncounterDiagnosisAdapter.getInitialValue(field, null, formContext);
+    expect(diagnosis).toEqual('137329AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA');
+  });
+
+  it('should return null for getPreviousValue', async () => {
+    const previousValue = await EncounterDiagnosisAdapter.getPreviousValue(field, null, formContext);
+    expect(previousValue).toBeNull();
+  });
+
+  it('should execute tearDown without issues', () => {
+    expect(() => EncounterDiagnosisAdapter.tearDown()).not.toThrow();
+  });
+
+  it('should edit a diagnosis value', () => {
+    formContext.sessionMode = 'edit';
+
+    const value = '128138AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA';
+    field.meta = {
+      initialValue: {
+        omrsObject: {
+          uuid: '0e20bb67-5d7f-41e0-96a1-751efc21a96f',
+          diagnosis: {
+            coded: {
+              uuid: '127133AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+              display: 'Schistosoma Mansonii Infection',
+            },
+          },
+        },
+        refinedValue: null,
+      },
+    };
+
+    EncounterDiagnosisAdapter.transformFieldValue(field, value, formContext);
+    expect(field.meta.submission.newValue).toEqual({
+      patient: '833db896-c1f0-11eb-8529-0242ac130003',
+      condition: null,
+      diagnosis: {
+        coded: '128138AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+      },
+      certainty: 'PROVISIONAL',
+      rank: 1,
+      formFieldPath: 'rfe-forms-DiagNosIS',
+      formFieldNamespace: 'rfe-forms',
+      uuid: '0e20bb67-5d7f-41e0-96a1-751efc21a96f',
+    });
+    expect(field.meta.submission.voidedValue).toBe(undefined);
+  });
+
+  it('should void removed diagnosis in edit mode', () => {
+    formContext.sessionMode = 'edit';
+
+    field.meta = {
+      initialValue: {
+        omrsObject: {
+          uuid: '0e20bb67-5d7f-41e0-96a1-751efc21a96f',
+          diagnosis: {
+            coded: {
+              uuid: '127133AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+              display: 'Schistosoma Mansonii Infection',
+            },
+          },
+        },
+        refinedValue: null,
+      },
+    };
+
+    EncounterDiagnosisAdapter.transformFieldValue(field, null, formContext);
+    expect(field.meta.submission.voidedValue).toEqual({
+      voided: true,
+      uuid: '0e20bb67-5d7f-41e0-96a1-751efc21a96f',
+    });
+  });
+});

src/adapters/encounter-diagnosis-adapter.ts

@@ -0,0 +1,113 @@
+import { type OpenmrsResource } from '@openmrs/esm-framework';
+import { type OpenmrsObs, type FormFieldValueAdapter, type FormProcessorContextProps } from '../types';
+import { type FormContextProps } from '../provider/form-provider';
+import { type OpenmrsEncounter, type FormField } from '../types';
+import { gracefullySetSubmission } from '../utils/common-utils';
+import { isEmpty } from '../validators/form-validator';
+import { voidObs } from './obs-adapter';
+import { isTrue } from '../utils/boolean-utils';
+
+export let assignedDiagnosesIds: string[] = [];
+
+export const EncounterDiagnosisAdapter: FormFieldValueAdapter = {
+  transformFieldValue: function (field: FormField, value: any, context: FormContextProps) {
+    if (field.meta.initialValue?.omrsObject && isEmpty(value)) {
+      return gracefullySetSubmission(field, undefined, voidObs(field.meta.initialValue.omrsObject as OpenmrsObs));
+    }
+    if (!isEmpty(value)) {
+      const previousDiagnosis = field.meta.initialValue?.omrsObject as OpenmrsResource;
+      if (hasPreviousDiagnosisValueChanged(previousDiagnosis, value)) {
+        return gracefullySetSubmission(
+          field,
+          editDiagnosis(value, field, previousDiagnosis, context.patient.id),
+          undefined,
+        );
+      }
+    }
+    const newValue = constructNewDiagnosis(value, field, context.patient.id);
+    gracefullySetSubmission(field, newValue, null);
+    return newValue;
+  },
+  getInitialValue: function (
+    field: FormField,
+    sourceObject: OpenmrsResource,
+    context: FormProcessorContextProps,
+  ): Promise<any> {
+    const encounter = sourceObject ?? (context.domainObjectValue as OpenmrsEncounter);
+    const matchedDiagnosis = encounter.diagnoses.find(
+      (diagnosis) => diagnosis.formFieldPath === `rfe-forms-${field.id}`,
+    );
+
+    if (matchedDiagnosis) {
+      field.meta = {
+        ...(field.meta || {}),
+        initialValue: {
+          omrsObject: matchedDiagnosis,
+          refinedValue: matchedDiagnosis.diagnosis?.coded.uuid,
+        },
+      };
+      if (!assignedDiagnosesIds.includes(matchedDiagnosis.diagnosis?.coded?.uuid)) {
+        assignedDiagnosesIds.push(matchedDiagnosis.diagnosis?.coded?.uuid);
+      }
+      return matchedDiagnosis.diagnosis?.coded.uuid;
+    }
+    return null;
+  },
+  getPreviousValue: function (
+    field: FormField,
+    sourceObject: OpenmrsResource,
+    context: FormProcessorContextProps,
+  ): Promise<any> {
+    return null;
+  },
+  getDisplayValue: (field: FormField, value: any) => {
+    return field.questionOptions.answers?.find((option) => option.concept == value)?.label || value;
+  },
+  tearDown: function (): void {
+    assignedDiagnosesIds = [];
+  },
+};
+
+const constructNewDiagnosis = (value: any, field: FormField, patientUuid: string) => {
+  if (!value) {
+    return null;
+  }
+  return {
+    patient: patientUuid,
+    condition: null,
+    diagnosis: {
+      coded: value,
+    },
+    certainty: isTrue(field.questionOptions?.diagnosis?.isConfirmed) ? 'CONFIRMED' : 'PROVISIONAL',
+    rank: field.questionOptions.diagnosis?.rank ?? 1, // rank 1 denotes a diagnosis is primary, else secondary
+    formFieldPath: `rfe-forms-${field.id}`,
+    formFieldNamespace: 'rfe-forms',
+  };
+};
+
+function editDiagnosis(
+  newEncounterDiagnosis: any,
+  field: FormField,
+  previousDiagnosis: OpenmrsResource,
+  patientUuid: string,
+) {
+  return {
+    patient: patientUuid,
+    condition: null,
+    diagnosis: {
+      coded: newEncounterDiagnosis,
+    },
+    certainty: isTrue(field.questionOptions?.diagnosis?.isConfirmed) ? 'CONFIRMED' : 'PROVISIONAL',
+    rank: field.questionOptions.diagnosis?.rank ?? 1, // rank 1 denotes a diagnosis is primary, else secondary
+    formFieldPath: `rfe-forms-${field.id}`,
+    formFieldNamespace: 'rfe-forms',
+    uuid: previousDiagnosis.uuid,
+  };
+}
+
+export function hasPreviousDiagnosisValueChanged(previousDiagnosis: OpenmrsResource, newValue: any) {
+  if (isEmpty(previousDiagnosis)) {
+    return false;
+  }
+  return previousDiagnosis.value !== newValue;
+}

src/components/repeat/repeat.component.tsx

@@ -15,6 +15,7 @@ import { useFormFactory } from '../../provider/form-factory-provider';
 const renderingByTypeMap: Record<string, RenderType> = {
   obsGroup: 'group',
   testOrder: 'select',
+  diagnosis: 'ui-select-extended',
 };
 
 const Repeat: React.FC<FormFieldInputProps> = ({ field }) => {

src/constants.ts

@@ -5,6 +5,7 @@ export const encounterRepresentation =
   'custom:(uuid,encounterDatetime,encounterType:(uuid,name,description),location:(uuid,name),' +
   'patient:(uuid,display),encounterProviders:(uuid,provider:(uuid,name),encounterRole:(uuid,name)),' +
   'orders:(uuid,display,concept:(uuid,display),voided),' +
+  'diagnoses:(uuid,certainty,condition,formFieldPath,formFieldNamespace,display,rank,voided,diagnosis:(coded:(uuid,display))),' +
   'obs:(uuid,obsDatetime,comment,voided,groupMembers,formFieldNamespace,formFieldPath,concept:(uuid,name:(uuid,name)),value:(uuid,name:(uuid,name),' +
   'names:(uuid,conceptNameType,name))))';
 export const FormsStore = 'forms-engine-store';

src/datasources/concept-data-source.ts

@@ -18,11 +18,13 @@ export class ConceptDataSource extends BaseOpenMRSDataSource {
         const urlParts = searchUrl.split('searchType=fuzzy');
         searchUrl = `${urlParts[0]}searchType=fuzzy&class=${config.class}&${urlParts[1]}`;
       } else {
-        return openmrsFetch(searchTerm ? `${searchUrl}&q=${searchTerm}` : searchUrl).then(({ data }) => {
-          return data.results.filter(
-            (concept) => concept.conceptClass && config.class.includes(concept.conceptClass.uuid),
-          );
-        });
+        return openmrsFetch(searchTerm ? `${searchUrl}&q=${searchTerm}` : `${searchUrl}&q=${'Diagnosis'}`).then(
+          ({ data }) => {
+            return data.results.filter(
+              (concept) => concept.conceptClass && config.class.includes(concept.conceptClass.uuid),
+            );
+          },
+        );
       }
     }