OpenMRSProgramEnrollmentService¶

public interface OpenMRSProgramEnrollmentService¶: Interface for handling programs enrollment on the OpenMRS server.

Methods¶

createProgramEnrollment¶

ProgramEnrollment createProgramEnrollment(String configName, ProgramEnrollment programEnrollment)¶

Creates the given program enrollment on the OpenMRS server. Configuration with the given configName will be used while performing this action.

Parameters:	configName – the name of the configuration programEnrollment – the program enrollment to be created
Returns:	the created program enrollment

deleteProgramEnrollment¶

void deleteProgramEnrollment(String configName, String uuid)¶

Deletes program enrollment with the given uuid. Configuration with the given configName will be used while performing this action.

Parameters:	configName – the name of the configuration uuid – the UUID of the program enrollment

getBahmniProgramEnrollmentByPatientMotechId¶

List<ProgramEnrollment> getBahmniProgramEnrollmentByPatientMotechId(String configName, String patientMotechId)¶

Returns Bahmni program enrollments associated with the patient having given MOTECH ID. Configuration with the given configName will be used while performing this action.

Parameters:	configName – the name of the configuration patientMotechId – the MOTECH ID of the patient
Returns:	list of matching Bahmni program enrollments

getBahmniProgramEnrollmentByPatientUuid¶

List<ProgramEnrollment> getBahmniProgramEnrollmentByPatientUuid(String configName, String patientUuid)¶

Returns Bahmni program enrollments associated with the patient having given UUID. Configuration with the given configName will be used while performing this action.

Parameters:	configName – the name of the configuration patientUuid – the UUID of the patient
Returns:	list of matching Bahmni program enrollments

getProgramEnrollmentByPatientMotechId¶

List<ProgramEnrollment> getProgramEnrollmentByPatientMotechId(String configName, String patientMotechId)¶

Returns program enrollments associated with the patient having given MOTECH ID. Configuration with the given configName will be used while performing this action.

Parameters:	configName – the name of the configuration patientMotechId – the MOTECH ID of the patient
Returns:	list of matching program enrollments

getProgramEnrollmentByPatientUuid¶

List<ProgramEnrollment> getProgramEnrollmentByPatientUuid(String configName, String patientUuid)¶

Returns program enrollments associated with the patient having given UUID. Configuration with the given configName will be used while performing this action.

Parameters:	configName – the name of the configuration patientUuid – the UUID of the patient
Returns:	list of matching program enrollments

updateProgramEnrollment¶

ProgramEnrollment updateProgramEnrollment(String configName, ProgramEnrollment programEnrollment)¶

Updates the given program enrollment on the OpenMRS server. Configuration with the given configName will be used while performing this action.

Parameters:	configName – the name of the configuration programEnrollment – the program enrollment to be updated
Returns:	the updated program enrollment