(feat) Introduce generic program enrollment #153

kajambiya · 2023-12-12T06:29:09Z

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 PR introduces generic program enrolment to the form engine. If an encounter is supposed to trigger a program enrolment, the user shall specify the same in the schema using ProgramEnrollmentSubmissionAction and specifying the program details through the config parameter. The user shall also use the enabled flag to specify whether the post submission is enabled or not. See sample below:

"postSubmissionActions": [
  {
    "actionId": "ProgramEnrollmentSubmissionAction",
    "enabled":"tbProgramType === '160541AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA'",
    "config": {
      "enrollmentDate": "tbRegDate",
      "programUuid": "58005eb2-4560-4ada-b7bb-67a5cffa0a27",
      "completionDate": "outcomeTBRx"
    }
  }
]

Screenshots

Screen.Recording.2023-12-12.at.22.17.56.mov

Related Issue

Other

ebambo

@kajambiya thank you for this but please have a look at my comments. Happy to discuss them

src/api/api.ts

src/ohri-form.component.tsx

src/post-submission-actions/program-enrollment-action.ts

ebambo · 2023-12-14T22:11:48Z

src/utils/program-enrolment-helper.ts

@@ -0,0 +1,71 @@
+export function isPostSubmissionEnabled(expression: string, encounters: any[]): boolean {


this function is doing more than checking if a postSubmissionAction is enabled... please rename this and also check if there is no function in the form engine that already does this... how hideWhenExpression is processed ?

There's an existing expression-runner but after studying it, I realised it couldn't be reused for this scenario:
The expression runner has access to all fields so expressions are evaluated in relation to all dependent fields regardless of whether they have data or not. The post submission action on the other hand has no access to all fields but has access to the submitted encounter and the submitted encounter eliminates fields/obs that don't have values, so it's just a few fields that get submitted.
The expression-runner also uses the encounter context which is not present at post-submission.

@kajambiya but the name of this function is not inline with what it does.

CynthiaKamau

Great job 🚀

CynthiaKamau · 2023-12-15T07:59:50Z

src/post-submission-actions/program-enrollment-action.ts

+        patient: patient.id,
+        program: programUuid,
+        dateEnrolled: enrollmentDate ? dayjs(enrollmentDate).format() : null,
+        dateCompleted: completionDate ? dayjs(enrollmentDate).format() : null,


is dateCompleted required for enrollments?

So the api works in such a way that when the completion date is supplied, the program status changes fromActiveto Completed. So to answer your question, a user is disenrolled from a program the moment a completion date is supplied.

I think I get what you meant. I was passing enrollmentDate as the value of dateCompleted. This is now fixed.

CynthiaKamau · 2023-12-15T08:06:09Z

src/post-submission-actions/program-enrollment-action.ts

+          },
+        );
+      } else {
+        const patientEnrolledPrograms = await getPatientEnrolledPrograms(patient.id);


if (hasActiveEnrollment) { throw new Error('Cannot enroll patient to program. Patient already has an active enrollment'); }
Will this section get executed because you are checking if someone is already enrolled ?

Not sure I fully get the question but let me briefly explain what is happening here;
So there's an existing module through which patients are being enrolled into programs. However we are also adding provision for enrolling patients into programs after successful submission of some encounters using post submission actions. Now when the post submission action is in enter mode, the assumption is that someone is being enrolled into a program for the 1st time, however if they already has an active program of the same type, they can't be enrolled again. This is being handled by the backend but saw it wise to handle it on the frontend as well. And yah, the section will get executed.

src/api/api.ts

pirupius · 2023-12-16T07:17:55Z

src/api/api.ts

+  });
+}
+
+export function updateProgramEnrollment(programEnrollmentUuid: string, payload, abortController) {


The typings have to be added here as well

pirupius · 2023-12-16T07:25:10Z

src/ohri-form.component.tsx

-                        },
-                        config,
-                      );
+                      const isActionEnabled = enabled ? isPostSubmissionEnabled(enabled, encounterData) : true;


Was logic meant to take care of backwards compatibility? if am reading this correctly if translates to if enabled (true) then do an action otherwise return true . So in both cases it resolves to true. If the condition enabled only applies to programs, shouldn't we consider adding it within the that handler to skip this step?

The main approach here assuming it's to either enroll or dis-enroll

Hi @pirupius, if you remember that call we had with @ebambo, the post submission action is by default enabled, however it may be disabled given some conditions. See example below:

"postSubmissionActions": [ { "actionId": "ProgramEnrollmentSubmissionAction", "enabled":"tbProgramType === '160541AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA'", "config": { "enrollmentDate": "tbRegDate", "programUuid": "58005eb2-4560-4ada-b7bb-67a5cffa0a27", "completionDate": "outcomeTBRx" } }, { "actionId": "ProgramEnrollmentSubmissionAction", "enabled":"tbProgramType === '160052AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA'", "config": { "enrollmentDate": "tbRegDate", "programUuid": "00f37871-0578-4ebc-af1d-e4b3ce75310d", "completionDate": "outcomeTBRx" } } ],

We have 2 post submission actions but only one can run depending on the program type selected. The other will return false for the enabled flag

src/post-submission-actions/program-enrollment-action.ts

pirupius · 2023-12-20T11:23:34Z

src/ohri-form.component.test.tsx

+
+      // Render the form
+      await act(async () => renderForm(null, postSubmission_test_form));
+      //const getRegisteredPostSubmissionActionSpy = jest.spyOn(registry, 'getRegisteredPostSubmissionAction');


Do we need this? If not then let's clean this up

pirupius · 2023-12-20T11:23:47Z

src/ohri-form.component.test.tsx

+      //expect(postSubmissionSpy).toHaveBeenCalled();
+
+      //expect(api.createProgramEnrollment).toHaveBeenCalled();


same applies to this

kajambiya changed the title ~~Introduce generic program enrollment~~ (feat) Introduce generic program enrollment Dec 12, 2023

kajambiya requested review from pirupius, ebambo, ODORA0, smallgod and samuelmale December 12, 2023 19:21

kajambiya force-pushed the OHRI-1992 branch from 4dc9f87 to de8ea62 Compare December 13, 2023 03:24

kajambiya marked this pull request as ready for review December 13, 2023 03:29

pirupius requested a review from donaldkibet December 13, 2023 06:50

ebambo requested changes Dec 14, 2023

View reviewed changes

pirupius requested review from CynthiaKamau and ebambo December 15, 2023 06:56

CynthiaKamau reviewed Dec 15, 2023

View reviewed changes

pirupius requested changes Dec 16, 2023

View reviewed changes

kajambiya force-pushed the OHRI-1992 branch from 6d17c7c to 0d55bf4 Compare December 19, 2023 06:15

kajambiya added 4 commits December 20, 2023 13:55

Introduce generic program enrollment

b0ee647

fix failing tests

d3530f5

address PR review comments and code clean up

e23c7fc

fix obs count failing test

a466d0f

kajambiya force-pushed the OHRI-1992 branch from 0d55bf4 to a466d0f Compare December 20, 2023 11:05

pirupius reviewed Dec 20, 2023

View reviewed changes

remove commented out code

a95a147

pirupius approved these changes Dec 20, 2023

View reviewed changes

pirupius merged commit d289092 into openmrs:main Dec 20, 2023
6 checks passed

ebambo approved these changes Dec 20, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(feat) Introduce generic program enrollment #153

(feat) Introduce generic program enrollment #153

kajambiya commented Dec 12, 2023 •

edited by pirupius

Loading

ebambo left a comment

ebambo Dec 14, 2023

kajambiya Dec 18, 2023

ebambo Dec 20, 2023

CynthiaKamau left a comment

CynthiaKamau Dec 15, 2023

kajambiya Dec 18, 2023

kajambiya Dec 19, 2023

CynthiaKamau Dec 15, 2023

kajambiya Dec 18, 2023

pirupius Dec 16, 2023

pirupius Dec 16, 2023

kajambiya Dec 18, 2023

pirupius Dec 20, 2023

pirupius Dec 20, 2023

		@@ -0,0 +1,71 @@
		export function isPostSubmissionEnabled(expression: string, encounters: any[]): boolean {

		//expect(postSubmissionSpy).toHaveBeenCalled();

		//expect(api.createProgramEnrollment).toHaveBeenCalled();

(feat) Introduce generic program enrollment #153

(feat) Introduce generic program enrollment #153

Conversation

kajambiya commented Dec 12, 2023 • edited by pirupius Loading

Requirements

Summary

Screenshots

Related Issue

Other

ebambo 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

CynthiaKamau 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

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

kajambiya commented Dec 12, 2023 •

edited by pirupius

Loading