Issues with the validation for eligibility and gender versus program area

carina (Carina Matimbe) 2017-09-11 13:17:39 UTC #1

Question: Dear all. Is there a way to avoid OpenMRS to allowing Male patients to be enrolled in PTV programs and adult patients to be enrolled to a CCR program?

Step-by-step instructions for others to reproduce the problem
Scenario 1: Create a New Male patient with 22 years-> search for the patient-> On patient dashboard look for programs session-> Click on add program -> on program name select PTV-> Chose any completion date and Location-> Click on enrrol button. (The system enrolles the patient)

Scenario 2: Search for the the same Male patient-> On patient dashboard look for programs session-> Click on add program -> on program name select CCR-> Chose any completion date and Location-> Click on enrrol button. (The system enrolles the patient)

Platform: We are using OpenMRS v1.11.5 as a retrospective system

Cheers

dkayiwa (Daniel Kayiwa) 2017-09-12 04:25:24 UTC #2

Having user defined validations for program enrollment is not currently implemented. It therefore requires creating a ticket.

carina (Carina Matimbe) 2017-09-13 07:42:36 UTC #3

Hi @dkayiwa,
Thank you for your response.

dkayiwa (Daniel Kayiwa) 2017-09-13 17:59:15 UTC #4

Did you take a look at the link i gave above?

carina (Carina Matimbe) 2017-09-14 13:09:09 UTC #5

Yes @dkayiwa. I did create the issue successfully.
Thanks

yassin (Yassin Nurmahomed) 2017-10-19 08:47:09 UTC #6

@dkayiwa What would be the best way to implement this validation in a custom module? Should I override ProgramWorkflowService#savePatientProgram?

dkayiwa (Daniel Kayiwa) 2017-10-19 09:03:24 UTC #7

Our practice has been creating validator classes which get called automatically when saving the validated objects. Here is a list of such validators: https://github.com/openmrs/openmrs-core/tree/master/api/src/main/java/org/openmrs/validator

yassin (Yassin Nurmahomed) 2017-10-19 09:44:47 UTC #8

Thanks @dkayiwa.

yassin (Yassin Nurmahomed) 2017-11-02 07:17:36 UTC #9

Hi @dkayiwa

I’m having a problem with the validator implemented.

When I call endpoint /programenrollment with a payload that should not pass validation, the message from error response is actually the key from the messages bundle:

{
  "error": {
    "message": "Invalid Submission",
    "code": "webservices.rest.error.invalid.submission",
    "globalErrors": [
      {
        "code": "error.patientProgram.patientMustBeAged5OrYounger",
        "message": "error.patientProgram.patientMustBeAged5OrYounger"
      }
    ],
    "fieldErrors": {}
  }
}

Any idea what might be wrong?

dkayiwa (Daniel Kayiwa) 2017-11-02 07:40:15 UTC #10

Can i look at your validator implementation?

yassin (Yassin Nurmahomed) 2017-11-02 07:49:47 UTC #11

github.com

esaude/openmrs-module-poc/blob/master/api/src/main/java/org/openmrs/module/poc/api/validator/POCPatientProgramValidator.java

/**
 * This Source Code Form is subject to the terms of the Mozilla Public License,
 * v. 2.0. If a copy of the MPL was not distributed with this file, You can
 * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
 * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
 *
 * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
 * graphic logo is a trademark of OpenMRS Inc.
 */
package org.openmrs.module.poc.api.validator;

import org.joda.time.DateTime;
import org.joda.time.Months;
import org.openmrs.Patient;
import org.openmrs.PatientProgram;
import org.openmrs.annotation.Handler;
import org.springframework.validation.Errors;
import org.springframework.validation.Validator;

import java.util.Date;

This file has been truncated. show original

dkayiwa (Daniel Kayiwa) 2017-11-02 08:02:22 UTC #12

And where are those message codes defined or expanded?

yassin (Yassin Nurmahomed) 2017-11-02 08:59:18 UTC #13

github.com

esaude/openmrs-module-poc/blob/master/api/src/main/resources/messages.properties

${project.parent.artifactId}.title=OpenMRS POC Module Module
error.patientProgram.patientMustBeYoungerThan18Months=Patient must be aged younger than 18 months old
error.patientProgram.patientMustBeAged5OrYounger=Patient must be aged 5 years old or younger

dkayiwa (Daniel Kayiwa) 2017-11-02 09:06:06 UTC #14

Did you intentionally decide not to prefix them with your moduleid?

yassin (Yassin Nurmahomed) 2017-11-02 09:09:19 UTC #15

I did not know it was necessary

yassin (Yassin Nurmahomed) 2017-11-02 09:27:25 UTC #16

@dkayiwa thanks the messages are expanded now, just missing i18n.

We are setting the locale through /session endpoint, but they are always in english.

yassin (Yassin Nurmahomed) 2017-11-02 09:49:18 UTC #17

Nevermind it was missing in config.xml, thank you for your help.