(feat) O3-3316 Add support for encounter diagnosis #298

CynthiaKamau · 2024-05-28T11:48:58Z

Requirements

This PR has a title that briefly describes the work done including the ticket number. If there is a ticket, make sure your PR title includes a conventional commit label. See existing PR titles for inspiration.
My work conforms to the OpenMRS 3.0 Styleguide and design documentation.
My work includes tests or is validated by existing tests.

Summary

This feature attempts to introduce encounter diagnosis in RFE
Current AFE Schema :

{
      "label": "Reason for hospitalization:",
      "id": "hospReason",
      "questionOptions": {
	      "concept": "a8a07a48-1350-11df-a1f1-0026b9348838",
	      "rendering": "problem",
	      "rank": 1
      },
      "type": "diagnosis",
      "validators": []
 }

Proposed schema as in RFE :

{
      "label": "Test Diagnosis",
      "id": "DiagNosIS",
      "type": "diagnosis",
      "questionOptions": {
        "rendering": "repeating",
        "dataSource": "diagnoses",
        "diagnosis": {
          "isConfirmed": "true",
          "rank": 1,
          "conceptClasses": [
            "8d4918b0-c2cc-11de-8d13-0010c6dffd0f"
          ]
        }
      }
}

Screenshots

Screen.Recording.2024-11-27.at.15.11.12.mov

Related Issue

Other

github-actions · 2024-05-28T11:52:02Z

Size Change: -264 kB (-17.22%) 👏

Total Size: 1.27 MB

Filename	Size	Change
`dist/891.js`	0 B	-264 kB (removed)	🏆

ℹ️ View Unchanged

Filename	Size	Change
`dist/151.js`	382 kB	0 B
`dist/225.js`	2.58 kB	0 B
`dist/260.js`	114 kB	0 B
`dist/277.js`	11.9 kB	0 B
`dist/300.js`	645 B	0 B
`dist/335.js`	968 B	0 B
`dist/353.js`	3.02 kB	0 B
`dist/41.js`	3.37 kB	0 B
`dist/422.js`	3.05 kB	0 B
`dist/499.js`	2.51 kB	0 B
`dist/524.js`	265 kB	0 B
`dist/540.js`	2.63 kB	0 B
`dist/55.js`	758 B	0 B
`dist/606.js`	2.24 kB	0 B
`dist/635.js`	14.4 kB	0 B
`dist/658.js`	1.85 kB	0 B
`dist/727.js`	87.2 kB	0 B
`dist/979.js`	6.87 kB	0 B
`dist/99.js`	691 B	0 B
`dist/993.js`	3.09 kB	0 B
`dist/main.js`	357 kB	+66 B (+0.02%)
`dist/openmrs-esm-form-engine-lib.js`	3.8 kB	-2 B (-0.05%)

_{compressed-size-action}

src/components/encounter/encounter-form.component.tsx

brandones · 2024-06-19T15:05:18Z

@CynthiaKamau Ping, are you still working on this? Any blockers?

CynthiaKamau · 2024-06-19T15:43:23Z

@CynthiaKamau Ping, are you still working on this? Any blockers?

Yes, there some fixes that need to be done on the backend to complete the work

brandones · 2024-06-19T15:59:04Z

@CynthiaKamau Please provide links to the work or issues you're talking about. If there is no linkable issue/PR/talk/Slack, please tell us what work needs to be completed before this can move forward.

CynthiaKamau · 2024-06-19T16:31:01Z

@CynthiaKamau Please provide links to the work or issues you're talking about. If there is no linkable issue/PR/talk/Slack, please tell us what work needs to be completed before this can move forward.

This is the link to the backend pr

brandones · 2024-09-15T11:54:36Z

Ok @CynthiaKamau , looks like that backend PR is merged. Can we move forward with this?

CynthiaKamau · 2024-09-17T09:59:54Z

Ok @CynthiaKamau , looks like that backend PR is merged. Can we move forward with this?

Im working on it now

samuelmale

Nice work @CynthiaKamau! Are you planning on adding some test coverage?

src/processors/encounter/encounter-processor-helper.ts

src/adapters/encounter-diagnosis-adapter.ts

src/processors/encounter/encounter-form-processor.ts

src/transformers/default-schema-transformer.ts

src/adapters/encounter-diagnoses-adapter.ts

src/adapters/encounter-diagnoses.test.ts

src/processors/encounter/encounter-form-processor.ts

src/processors/encounter/encounter-processor-helper.ts

brandones · 2024-10-10T16:37:59Z

Ping @samuelmale

samuelmale · 2024-10-14T12:20:13Z

@brandones I left a few more comments for @CynthiaKamau

samuelmale

Thanks for the great work @CynthiaKamau!

To make this more generic and practical, we need a way to extend the data source to load concepts from custom concept classes and, optionally, sets.

   questionOptions: {
      diagnosis: {
         rank?: number;
         isConfirmed?: boolean;
         conceptClasses?: Array<string>;
         conceptSet?: string;
      }
   }

cc: @ibacher

src/adapters/encounter-diagnoses-adapter.ts

src/types/schema.ts

CynthiaKamau · 2024-11-20T08:15:51Z

Thanks for the great work @CynthiaKamau!

To make this more generic and practical, we need a way to extend the data source to load concepts from custom concept classes and, optionally, sets.
   questionOptions: {
      diagnosis: {
         rank?: number;
         isConfirmed?: boolean;
         conceptClasses?: Array<string>;
         conceptSet?: string;
      }
   }
cc: @ibacher

Is it supported by the backend ? I remember the question with the type problem had the same challenge

samuelmale

@CynthiaKamau can we add some integration test case(s)? One capturing and editing diagnosis would be super imperative!

src/adapters/encounter-diagnosis-adapter.ts

src/processors/encounter/encounter-processor-helper.ts

src/adapters/encounter-diagnosis-adapter.ts

samuelmale

@CynthiaKamau any chance we can add some integrational tests? Here is an example of the "Obs Group": https://github.com/openmrs/openmrs-esm-form-engine-lib/blob/main/src/form-engine.test.tsx#L878-L1007

src/adapters/encounter-diagnosis-adapter.ts

CynthiaKamau · 2025-01-17T06:11:13Z

@samuelmale please review the latest changes

samuelmale · 2025-01-17T08:41:28Z

src/adapters/encounter-diagnosis-adapter.ts

+  return previousDiagnosis.value !== newValue;
+}
+
+export function voidDiagnosis(obs: OpenmrsObs) {


Suggested change

export function voidDiagnosis(obs: OpenmrsObs) {

export function voidDiagnosis(diagnosis: OpenmrsResource) {

samuelmale · 2025-01-17T08:43:18Z

src/form-engine.test.tsx

+        return Promise.resolve([
+          {
+            uuid: 'aaa-1',
+            display: 'Kololo',
+          },
+          {
+            uuid: 'aaa-2',
+            display: 'Naguru',
+          },
+          {
+            uuid: 'aaa-3',
+            display: 'Muyenga',
+          },
+        ]);


Do you need locations for your test case?

samuelmale · 2025-01-17T08:43:46Z

src/form-engine.test.tsx

@@ -1047,6 +1098,86 @@ describe('Form engine component', () => {
    });
  });

+  describe('Diagnisis field', () => {


Suggested change

describe('Diagnisis field', () => {

describe('Encounter Diagnosis', () => {

samuelmale · 2025-01-17T08:47:29Z

src/form-engine.test.tsx

+      const addButtons = screen.getAllByRole('button', { name: 'Add' });
+      expect(addButtons.length).toBeGreaterThan(0);


We always have a single "Add" button in a repeat section.

This is the form im using as my mock

samuelmale · 2025-01-17T08:48:21Z

src/form-engine.test.tsx

+      });
+      const addButtons = screen.getAllByRole('button', { name: 'Add' });
+      expect(addButtons.length).toBeGreaterThan(0);
+      screen.debug(addButtons);


Is this a debug leftover?

samuelmale · 2025-01-17T08:57:59Z

src/form-engine.test.tsx

+    it('should save diagnosis field on form submission', async () => {
+      await act(async () => {
+        renderForm(null, diagnosisForm);
+      });
+      const saveEncounterMock = jest.spyOn(api, 'saveEncounter');
+
+      const combobox = await screen.findByRole('combobox', { name: /test diagnosis 1/i });
+      expect(combobox).toBeInTheDocument();
+
+      await userEvent.click(combobox);
+      await waitFor(() => {
+        expect(screen.getByText('stage 1')).toBeInTheDocument();
+        expect(screen.getByText('stage 2')).toBeInTheDocument();
+      });
+      await user.click(screen.getByText('stage 1'));
+      await user.click(screen.getByRole('button', { name: /save/i }));
+      expect(saveEncounterMock).toHaveBeenCalledTimes(1);
+      const [_, encounter] = saveEncounterMock.mock.calls[0];
+      expect(encounter.diagnoses.length).toBe(1);
+      expect(encounter.diagnoses[0]).toEqual({
+        patient: '8673ee4f-e2ab-4077-ba55-4980f408773e',
+        condition: null,
+        diagnosis: {
+          coded: 'stage-1-uuid',
+        },
+        certainty: 'CONFIRMED',
+        rank: 1,
+        formFieldPath: `rfe-forms-diagnosis1`,
+        formFieldNamespace: 'rfe-forms',
+      });
+    });


Can you also add a unit test validating that the "repeating container" is properly constructed in edit mode?

samuelmale · 2025-01-17T10:31:17Z

src/transformers/default-schema-transformer.ts

@@ -276,3 +279,31 @@ function handleQuestionsWithObsComments(sectionQuestions: Array<FormField>): Arr

  return augmentedQuestions;
 }
+
+function handleDiagnosis(question: FormField) {


@CynthiaKamau can you also configure the field to be search-able?

question.questionOptions.isSearchable = true;

samuelmale

This is close! just a few more comments.

samuelmale · 2025-01-21T09:09:57Z

src/adapters/encounter-diagnosis-adapter.ts

+  return previousDiagnosis.value !== newValue;
+}
+
+export function voidDiagnosis(obs: OpenmrsResource) {


I guess this voids a diagnosis not an obs

samuelmale · 2025-01-21T09:10:36Z

src/form-engine.test.tsx

@@ -1047,14 +1102,128 @@ describe('Form engine component', () => {
    });
  });

-  function renderForm(formUUID, formJson, intent?: string, mode?: SessionMode) {
+  describe('Encounter diagnisis', () => {


Suggested change

describe('Encounter diagnisis', () => {

describe('Encounter diagnosis, () => {

samuelmale · 2025-01-21T09:14:30Z

src/form-engine.test.tsx

+      expect(screen.getByRole('button', { name: /Remove/i })).toBeInTheDocument();
+    });
+
+    it('should render diagnosis field', async () => {


"should render all diagnosis fields" reads better

samuelmale · 2025-01-21T09:24:49Z

src/form-engine.test.tsx

+
+      const addButtons = screen.getAllByRole('button', { name: 'Add' });
+      expect(addButtons.length).toBeGreaterThan(0);
+      await user.click(addButtons[0]);


I would do something like this:

const testDiagnosis1AddButton = screen.getAllByRole('button', { name: 'Add' })[0]; await user.click(testDiagnosis1AddButton);

Overtaken by events

samuelmale

LGTM, thank you @CynthiaKamau for the great work!

CynthiaKamau marked this pull request as draft May 28, 2024 11:49

CynthiaKamau force-pushed the O3-3316 branch from b959145 to 2d22e64 Compare May 28, 2024 11:51

samuelmale reviewed May 29, 2024

View reviewed changes

src/components/encounter/encounter-form.component.tsx Outdated Show resolved Hide resolved

CynthiaKamau force-pushed the O3-3316 branch from c9635c2 to 7274df9 Compare June 4, 2024 10:28

CynthiaKamau force-pushed the O3-3316 branch 2 times, most recently from a40ba8d to 2415c6d Compare September 16, 2024 19:12

CynthiaKamau force-pushed the O3-3316 branch 2 times, most recently from e5de3c9 to 63ad98e Compare September 25, 2024 10:58

CynthiaKamau marked this pull request as ready for review September 25, 2024 10:58

samuelmale reviewed Sep 25, 2024

View reviewed changes

CynthiaKamau force-pushed the O3-3316 branch 2 times, most recently from bc33d5d to 089214e Compare September 30, 2024 10:54

CynthiaKamau requested a review from samuelmale September 30, 2024 10:55

samuelmale reviewed Sep 30, 2024

View reviewed changes

CynthiaKamau requested a review from samuelmale October 2, 2024 12:28

CynthiaKamau force-pushed the O3-3316 branch from d601ac0 to e77e0b3 Compare November 7, 2024 12:49

denniskigen requested review from denniskigen and pirupius November 7, 2024 13:18

samuelmale reviewed Nov 19, 2024

View reviewed changes

src/adapters/encounter-diagnoses-adapter.ts Outdated Show resolved Hide resolved

src/types/schema.ts Outdated Show resolved Hide resolved

samuelmale requested a review from mogoodrich November 19, 2024 10:46

CynthiaKamau force-pushed the O3-3316 branch 2 times, most recently from c424cf2 to f306ec1 Compare January 6, 2025 09:46

CynthiaKamau requested a review from samuelmale January 6, 2025 09:57

CynthiaKamau force-pushed the O3-3316 branch 2 times, most recently from 1bbba35 to 025ca74 Compare January 9, 2025 07:36

samuelmale previously requested changes Jan 9, 2025

View reviewed changes

src/adapters/encounter-diagnosis-adapter.ts Outdated Show resolved Hide resolved

src/adapters/encounter-diagnosis-adapter.ts Outdated Show resolved Hide resolved

src/processors/encounter/encounter-processor-helper.ts Outdated Show resolved Hide resolved

samuelmale reviewed Jan 13, 2025

View reviewed changes

src/adapters/encounter-diagnosis-adapter.ts Outdated Show resolved Hide resolved

CynthiaKamau force-pushed the O3-3316 branch from 025ca74 to ee9e145 Compare January 14, 2025 12:56

CynthiaKamau requested a review from samuelmale January 14, 2025 12:59

samuelmale reviewed Jan 15, 2025

View reviewed changes

src/adapters/encounter-diagnosis-adapter.ts Outdated Show resolved Hide resolved

src/adapters/encounter-diagnosis-adapter.ts Outdated Show resolved Hide resolved

CynthiaKamau force-pushed the O3-3316 branch from dd56bad to 876b6b9 Compare January 16, 2025 12:33

CynthiaKamau requested a review from samuelmale January 16, 2025 12:36

samuelmale reviewed Jan 17, 2025

View reviewed changes

CynthiaKamau added 5 commits January 20, 2025 12:08

(feat) O3-3316 Add support for encounter diagnosis

d479938

code-review

05cec3f

add tests

d00719c

code review

c76aef9

code review

a63c779

CynthiaKamau force-pushed the O3-3316 branch from 21c8333 to caa7318 Compare January 20, 2025 11:04

code review

4463805

CynthiaKamau force-pushed the O3-3316 branch from caa7318 to 4463805 Compare January 20, 2025 11:06

CynthiaKamau requested a review from samuelmale January 20, 2025 11:07

samuelmale reviewed Jan 21, 2025

View reviewed changes

minor improvements

b93ae75

samuelmale approved these changes Jan 21, 2025

View reviewed changes

samuelmale merged commit 694ab02 into main Jan 21, 2025
6 checks passed

samuelmale deleted the O3-3316 branch January 21, 2025 11:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(feat) O3-3316 Add support for encounter diagnosis #298

(feat) O3-3316 Add support for encounter diagnosis #298

CynthiaKamau commented May 28, 2024 •

edited

Loading

github-actions bot commented May 28, 2024 •

edited

Loading

brandones commented Jun 19, 2024

CynthiaKamau commented Jun 19, 2024

brandones commented Jun 19, 2024

CynthiaKamau commented Jun 19, 2024 •

edited

Loading

brandones commented Sep 15, 2024

CynthiaKamau commented Sep 17, 2024

samuelmale left a comment

brandones commented Oct 10, 2024

samuelmale commented Oct 14, 2024

samuelmale left a comment

CynthiaKamau commented Nov 20, 2024

samuelmale left a comment

samuelmale left a comment

CynthiaKamau commented Jan 17, 2025

samuelmale Jan 17, 2025

samuelmale Jan 17, 2025

samuelmale Jan 17, 2025

samuelmale Jan 17, 2025

CynthiaKamau Jan 17, 2025

samuelmale Jan 17, 2025

samuelmale Jan 17, 2025

samuelmale Jan 17, 2025

CynthiaKamau Jan 20, 2025

samuelmale left a comment

samuelmale Jan 21, 2025

samuelmale Jan 21, 2025

samuelmale Jan 21, 2025

samuelmale Jan 21, 2025

samuelmale left a comment

	export function voidDiagnosis(obs: OpenmrsObs) {
	export function voidDiagnosis(diagnosis: OpenmrsResource) {

	describe('Diagnisis field', () => {
	describe('Encounter Diagnosis', () => {

		const addButtons = screen.getAllByRole('button', { name: 'Add' });
		expect(addButtons.length).toBeGreaterThan(0);

	describe('Encounter diagnisis', () => {
	describe('Encounter diagnosis, () => {

(feat) O3-3316 Add support for encounter diagnosis #298

(feat) O3-3316 Add support for encounter diagnosis #298

Conversation

CynthiaKamau commented May 28, 2024 • edited Loading

Requirements

Summary

Screenshots

Related Issue

Other

github-actions bot commented May 28, 2024 • edited Loading

brandones commented Jun 19, 2024

CynthiaKamau commented Jun 19, 2024

brandones commented Jun 19, 2024

CynthiaKamau commented Jun 19, 2024 • edited Loading

brandones commented Sep 15, 2024

CynthiaKamau commented Sep 17, 2024

samuelmale left a comment

Choose a reason for hiding this comment

brandones commented Oct 10, 2024

samuelmale commented Oct 14, 2024

samuelmale left a comment

Choose a reason for hiding this comment

CynthiaKamau commented Nov 20, 2024

samuelmale left a comment

Choose a reason for hiding this comment

samuelmale left a comment

Choose a reason for hiding this comment

CynthiaKamau commented Jan 17, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

samuelmale left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

samuelmale left a comment

Choose a reason for hiding this comment

CynthiaKamau commented May 28, 2024 •

edited

Loading

github-actions bot commented May 28, 2024 •

edited

Loading

CynthiaKamau commented Jun 19, 2024 •

edited

Loading