org.openmrs.api.impl

Class EncounterServiceImpl

java.lang.Object

org.openmrs.api.impl.BaseOpenmrsService

org.openmrs.api.impl.EncounterServiceImpl

All Implemented Interfaces:

EncounterService, OpenmrsService

@Transactional
public class EncounterServiceImpl
extends BaseOpenmrsService
implements EncounterService

Default implementation of the EncounterService

This class should not be instantiated alone, get a service class from the Context: Context.getEncounterService();

See Also:

Context, EncounterService

Constructor Summary

Constructors

Constructor and Description
EncounterServiceImpl()

Method Summary

Modifier and Type	Method and Description
boolean	canEditAllEncounterTypes(User subject) Determines whether given user is granted to edit all encounter types or not
boolean	canEditEncounter(Encounter encounter, User user) Checks if passed in user can edit given encounter.
boolean	canViewAllEncounterTypes(User subject) Determines whether given user is granted to view all encounter types or not
boolean	canViewEncounter(Encounter encounter, User user) Checks if passed in user can view given encounter.
void	checkIfEncounterTypesAreLocked() Check if the encounter types are locked, and if so, throw exception during manipulation of encounter type
List<Encounter>	filterEncountersByViewPermissions(List<Encounter> encounters, User user) Filters out all encounters to which given user does not have access.
List<EncounterType>	findEncounterTypes(String name) Find Encounter Types with name matching the beginning of the search string.
EncounterVisitHandler	getActiveEncounterVisitHandler() Gets the active handler for assigning visits to encounters.
List<EncounterRole>	getAllEncounterRoles(boolean includeRetired) Get all encounter roles based on includeRetired flag
Map<Integer,List<Encounter>>	getAllEncounters(Cohort patients) Get all encounters for a cohort of patients
List<EncounterType>	getAllEncounterTypes() Get all encounter types (including retired)
List<EncounterType>	getAllEncounterTypes(boolean includeRetired) Get all encounter types.
Integer	getCountOfEncounters(String query, boolean includeVoided) Return the number of encounters matching a patient name or patient identifier
Encounter	getEncounter(Integer encounterId) Get encounter by internal identifier
Encounter	getEncounterByUuid(String uuid) Get Encounter by its UUID
EncounterRole	getEncounterRole(Integer encounterRoleId) Gets an encounter role when and internal encounter role id is provided.
EncounterRole	getEncounterRoleByName(String name) Get EncounterRole by name
EncounterRole	getEncounterRoleByUuid(String uuid) Get EncounterRole by its UUID
List<EncounterRole>	getEncounterRolesByName(String name) Get EncounterRoles by name
List<Encounter>	getEncounters(EncounterSearchCriteria encounterSearchCriteria) Get all encounters that match a variety of (nullable) criteria contained in the parameter object.
List<Encounter>	getEncounters(Patient who, Location loc, Date fromDate, Date toDate, Collection<Form> enteredViaForms, Collection<EncounterType> encounterTypes, Collection<Provider> providers, Collection<VisitType> visitTypes, Collection<Visit> visits, boolean includeVoided) Deprecated. As of 2.0, replaced by getEncounters(EncounterSearchCriteria)
List<Encounter>	getEncounters(String query, Integer start, Integer length, boolean includeVoided) Search for encounters by patient name or patient identifier and returns a specific number of them from the specified starting position.
List<Encounter>	getEncounters(String query, Integer patientId, Integer start, Integer length, boolean includeVoided) Searches for encounters by patient id, provider identifier, location, encounter type, provider, form or provider name.
List<Encounter>	getEncountersByPatient(Patient patient) Get all encounters (not voided) for a patient, sorted by encounterDatetime ascending.
List<Encounter>	getEncountersByPatient(String query) Search for encounters by patient name or patient identifier.
List<Encounter>	getEncountersByPatient(String query, boolean includeVoided) Search for encounters by patient name or patient identifier.
List<Encounter>	getEncountersByPatientId(Integer patientId) Get encounters for a patientId
List<Encounter>	getEncountersByPatientIdentifier(String identifier) Get encounters (not voided) for a patient identifier
List<Encounter>	getEncountersByVisit(Visit visit, boolean includeVoided) Gets all encounters grouped within a given visit.
List<Encounter>	getEncountersByVisitsAndPatient(Patient patient, boolean includeVoided, String query, Integer start, Integer length) Gets encounters for the given patient.
Integer	getEncountersByVisitsAndPatientCount(Patient patient, boolean includeVoided, String query) Returns result count for EncounterService.getEncountersByVisitsAndPatient(Patient, boolean, String, Integer, Integer).
List<Encounter>	getEncountersNotAssignedToAnyVisit(Patient patient) Gets the unvoided encounters for the specified patient that are not assigned to any visit.
EncounterType	getEncounterType(Integer encounterTypeId) Get encounterType by internal identifier
EncounterType	getEncounterType(String name) Get encounterType by exact name
EncounterType	getEncounterTypeByUuid(String uuid) Get EncounterType by its UUID
List<EncounterVisitHandler>	getEncounterVisitHandlers()
void	purgeEncounter(Encounter encounter) Completely remove an encounter from database.
void	purgeEncounter(Encounter encounter, boolean cascade) Completely remove an encounter from database.
void	purgeEncounterRole(EncounterRole encounterRole) Completely remove an encounter role from database.
void	purgeEncounterType(EncounterType encounterType) Completely remove an encounter type from database.
EncounterRole	retireEncounterRole(EncounterRole encounterRole, String reason) Retire an EncounterRole.
EncounterType	retireEncounterType(EncounterType encounterType, String reason) Retire an EncounterType.
Encounter	saveEncounter(Encounter encounter) Saves a new encounter or updates an existing encounter.
EncounterRole	saveEncounterRole(EncounterRole encounterRole) Saves a new encounter role or updates an existing encounter role.
EncounterType	saveEncounterType(EncounterType encounterType) Save a new Encounter Type or update an existing Encounter Type.
void	setEncounterDAO(EncounterDAO dao) Set the given dao on this encounter service.
Encounter	transferEncounter(Encounter encounter, Patient patient) Transfer encounter to another patient
EncounterRole	unretireEncounterRole(EncounterRole encounterRole) Unretire an EncounterRole.
EncounterType	unretireEncounterType(EncounterType encounterType) Unretire an EncounterType.
Encounter	unvoidEncounter(Encounter encounter) Unvoid encounter record
Encounter	voidEncounter(Encounter encounter, String reason) Voiding a encounter essentially removes it from circulation

Methods inherited from class org.openmrs.api.impl.BaseOpenmrsService

onShutdown, onStartup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Constructor Detail

EncounterServiceImpl

public EncounterServiceImpl()

Method Detail

setEncounterDAO

public void setEncounterDAO(EncounterDAO dao)

Description copied from interface: EncounterService

Set the given dao on this encounter service. The dao will act as the conduit through with all encounter calls get to the database

Specified by:

setEncounterDAO in interface EncounterService

See Also:

EncounterService.setEncounterDAO(org.openmrs.api.db.EncounterDAO)

getEncountersByPatient

@Transactional(readOnly=true)
public List<Encounter> getEncountersByPatient(String query,
                                                                            boolean includeVoided)
                                                                     throws APIException

Description copied from interface: EncounterService

Search for encounters by patient name or patient identifier.

Specified by:

getEncountersByPatient in interface EncounterService

Parameters:

query - patient name or identifier

includeVoided - Specifies whether voided encounters should be included

Returns:

list of encounters for the given patient

Throws:

APIException - Should get all unvoided encounters for the given patient name Should get all unvoided encounters for the given patient identifier Should throw error if given null parameter Should include voided encounters in the returned list if includedVoided is true

See Also:

EncounterService.getEncountersByPatient(java.lang.String, boolean)

saveEncounter

public Encounter saveEncounter(Encounter encounter)
                        throws APIException

Description copied from interface: EncounterService

Saves a new encounter or updates an existing encounter. If an existing encounter, this method will automatically apply encounter.patient to all encounter.obs.patient

Specified by:

saveEncounter in interface EncounterService

Parameters:

encounter - to be saved

Throws:

APIException - Should save encounter with basic details Should update encounter successfully Should cascade save to contained obs Should cascade patient to orders in the encounter Should cascade save to contained obs when encounter already exists Should cascade encounter datetime to obs Should only cascade the obsdatetimes to obs with different initial obsdatetimes Should not overwrite creator if non null Should not overwrite dateCreated if non null Should not overwrite obs and orders creator or dateCreated Should not assign encounter to visit if no handler is registered Should not assign encounter to visit if the no assign handler is registered Should assign encounter to visit if the assign to existing handler is registered Should assign encounter to visit if the assign to existing or new handler is registered Should cascade save encounter providers Should cascade delete encounter providers Should cascade save encounter conditions Should void and create new obs when saving encounter Should fail if user is not supposed to edit encounters of type of given encounter Should cascade save encounter allergies

See Also:

EncounterService.saveEncounter(org.openmrs.Encounter)

getEncounter

@Transactional(readOnly=true)
public Encounter getEncounter(Integer encounterId)
                                                     throws APIException

Description copied from interface: EncounterService

Get encounter by internal identifier

Specified by:

getEncounter in interface EncounterService

Parameters:

encounterId - encounter id

Returns:

encounter with given internal identifier

Throws:

APIException - Should throw error if given null parameter Should fail if user is not allowed to view encounter by given id Should return encounter if user is allowed to view it

See Also:

EncounterService.getEncounter(java.lang.Integer)

getEncountersByPatient

@Transactional(readOnly=true)
public List<Encounter> getEncountersByPatient(Patient patient)
                                                                     throws APIException

Description copied from interface: EncounterService

Get all encounters (not voided) for a patient, sorted by encounterDatetime ascending.

Specified by:

getEncountersByPatient in interface EncounterService

Returns:

List<Encounter> encounters (not voided) for a patient. Should not get voided encounters Should throw error when given null parameter

Throws:

APIException

See Also:

EncounterService.getEncountersByPatient(org.openmrs.Patient)

getEncountersByPatient

@Transactional(readOnly=true)
public List<Encounter> getEncountersByPatient(String query)
                                                                     throws APIException

Description copied from interface: EncounterService

Search for encounters by patient name or patient identifier.

Specified by:

getEncountersByPatient in interface EncounterService

Parameters:

query - patient name or identifier

Returns:

list of encounters for the given patient

Throws:

APIException

See Also:

EncounterService.getEncountersByPatient(String)

getEncountersByPatientId

@Transactional(readOnly=true)
public List<Encounter> getEncountersByPatientId(Integer patientId)
                                                                       throws APIException

Description copied from interface: EncounterService

Get encounters for a patientId

Specified by:

getEncountersByPatientId in interface EncounterService

Returns:

all encounters (not voided) for the given patient identifier

Throws:

APIException - Should not get voided encounters Should throw error if given a null parameter

See Also:

EncounterService.getEncountersByPatientId(java.lang.Integer)

getEncountersByPatientIdentifier

@Transactional(readOnly=true)
public List<Encounter> getEncountersByPatientIdentifier(String identifier)
                                                                               throws APIException

Description copied from interface: EncounterService

Get encounters (not voided) for a patient identifier

Specified by:

getEncountersByPatientIdentifier in interface EncounterService

Returns:

all encounters (not retired) for the given patient identifier

Throws:

APIException - Should not get voided encounters Should throw error if given null parameter

See Also:

EncounterService.getEncountersByPatientIdentifier(java.lang.String)

getEncounters

@Deprecated
 @Transactional(readOnly=true)
public List<Encounter> getEncounters(Patient who,
                                                                                Location loc,
                                                                                Date fromDate,
                                                                                Date toDate,
                                                                                Collection<Form> enteredViaForms,
                                                                                Collection<EncounterType> encounterTypes,
                                                                                Collection<Provider> providers,
                                                                                Collection<VisitType> visitTypes,
                                                                                Collection<Visit> visits,
                                                                                boolean includeVoided)

Deprecated. As of 2.0, replaced by getEncounters(EncounterSearchCriteria)

Description copied from interface: EncounterService

Get all encounters that match a variety of (nullable) criteria. Each extra value for a parameter that is provided acts as an "and" and will reduce the number of results returned

Specified by:

getEncounters in interface EncounterService

Parameters:

who - the patient the encounter is for

loc - the location this encounter took place

fromDate - the minimum date (inclusive) this encounter took place

toDate - the maximum date (exclusive) this encounter took place

enteredViaForms - the form that entered this encounter must be in this list

encounterTypes - the type of encounter must be in this list

providers - the provider of this encounter must be in this list

visitTypes - the visit types of this encounter must be in this list

visits - the visits of this encounter must be in this list

includeVoided - true/false to include the voided encounters or not

Returns:

a list of encounters ordered by increasing encounterDatetime

See Also:

EncounterService.getEncounters(org.openmrs.Patient, org.openmrs.Location, java.util.Date, java.util.Date, java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection, boolean)

getEncounters

public List<Encounter> getEncounters(EncounterSearchCriteria encounterSearchCriteria)

Description copied from interface: EncounterService

Get all encounters that match a variety of (nullable) criteria contained in the parameter object. Each extra value for a parameter that is provided acts as an "and" and will reduce the number of results returned

Specified by:

getEncounters in interface EncounterService

Parameters:

encounterSearchCriteria - the object containing search parameters

Returns:

a list of encounters ordered by increasing encounterDatetime

See Also:

EncounterService.getEncounters(org.openmrs.parameter.EncounterSearchCriteria)

voidEncounter

public Encounter voidEncounter(Encounter encounter,
                               String reason)

Description copied from interface: EncounterService

Voiding a encounter essentially removes it from circulation

Specified by:

voidEncounter in interface EncounterService

Parameters:

encounter - Encounter object to void

reason - String reason that it's being voided Should void encounter and set attributes Should cascade to obs Should cascade to orders Should throw error with null reason parameter Should not void providers Should fail if user is not supposed to edit encounters of type of given encounter

See Also:

EncounterService.voidEncounter(org.openmrs.Encounter, java.lang.String)

unvoidEncounter

public Encounter unvoidEncounter(Encounter encounter)
                          throws APIException

Description copied from interface: EncounterService

Unvoid encounter record

Specified by:

unvoidEncounter in interface EncounterService

Parameters:

encounter - Encounter to be revived Should cascade unvoid to obs Should cascade unvoid to orders Should unvoid and unmark all attributes Should fail if user is not supposed to edit encounters of type of given encounter

Throws:

APIException

See Also:

EncounterService.unvoidEncounter(org.openmrs.Encounter)

purgeEncounter

public void purgeEncounter(Encounter encounter)
                    throws APIException

Description copied from interface: EncounterService

Completely remove an encounter from database. For super users only. If dereferencing encounters, use voidEncounter(org.openmrs.Encounter)

Specified by:

purgeEncounter in interface EncounterService

Parameters:

encounter - encounter object to be purged Should purgeEncounter Should fail if user is not supposed to edit encounters of type of given encounter

Throws:

APIException

See Also:

EncounterService.purgeEncounter(org.openmrs.Encounter)

purgeEncounter

public void purgeEncounter(Encounter encounter,
                           boolean cascade)
                    throws APIException

Description copied from interface: EncounterService

Completely remove an encounter from database. For super users only. If dereferencing encounters, use voidEncounter(org.openmrs.Encounter)

Specified by:

purgeEncounter in interface EncounterService

Parameters:

encounter - encounter object to be purged

cascade - Purge any related observations as well? Should cascade purge to obs and orders Should fail if user is not supposed to edit encounters of type of given encounter

Throws:

APIException

See Also:

EncounterService.purgeEncounter(Encounter, boolean)

saveEncounterType

public EncounterType saveEncounterType(EncounterType encounterType)

Description copied from interface: EncounterService

Save a new Encounter Type or update an existing Encounter Type.

Specified by:

saveEncounterType in interface EncounterService

Parameters:

encounterType - Should save encounter type Should not overwrite creator Should not overwrite creator or date created Should not overwrite date created Should update an existing encounter type name Should throw error when trying to save encounter type when encounter types are locked

See Also:

EncounterService.saveEncounterType(org.openmrs.EncounterType)

getEncounterType

@Transactional(readOnly=true)
public EncounterType getEncounterType(Integer encounterTypeId)
                                                             throws APIException

Description copied from interface: EncounterService

Get encounterType by internal identifier

Specified by:

getEncounterType in interface EncounterService

Parameters:

encounterTypeId - Integer

Returns:

encounterType with given internal identifier

Throws:

APIException - Should throw error if given null parameter

See Also:

EncounterService.getEncounterType(java.lang.Integer)

getEncounterType

@Transactional(readOnly=true)
public EncounterType getEncounterType(String name)
                                                             throws APIException

Description copied from interface: EncounterService

Get encounterType by exact name

Specified by:

getEncounterType in interface EncounterService

Parameters:

name - string to match to an Encounter.name

Returns:

EncounterType that is not retired

Throws:

APIException - Should not get retired types Should return null if only retired type found Should not get by inexact name Should return null with null name parameter

See Also:

EncounterService.getEncounterType(java.lang.String)

getAllEncounterTypes

@Transactional(readOnly=true)
public List<EncounterType> getAllEncounterTypes()
                                                                       throws APIException

Description copied from interface: EncounterService

Get all encounter types (including retired)

Specified by:

getAllEncounterTypes in interface EncounterService

Returns:

encounter types list

Throws:

APIException - Should not return retired types

See Also:

EncounterService.getAllEncounterTypes()

getAllEncounterTypes

@Transactional(readOnly=true)
public List<EncounterType> getAllEncounterTypes(boolean includeRetired)
                                                                       throws APIException

Description copied from interface: EncounterService

Get all encounter types. If includeRetired is true, also get retired encounter types.

Specified by:

getAllEncounterTypes in interface EncounterService

Returns:

encounter types list

Throws:

APIException - Should not return retired types Should include retired types with true includeRetired parameter

See Also:

EncounterService.getAllEncounterTypes(boolean)

findEncounterTypes

@Transactional(readOnly=true)
public List<EncounterType> findEncounterTypes(String name)
                                                                     throws APIException

Description copied from interface: EncounterService

Find Encounter Types with name matching the beginning of the search string. Search strings are case insensitive so that "NaMe".equals("name") is true. Includes retired EncounterTypes.

Specified by:

findEncounterTypes in interface EncounterService

Parameters:

name - of the encounter type to find

Returns:

List<EncounterType> matching encounters

Throws:

APIException - Should return types by partial name match Should return types by partial case insensitive match Should include retired types in the results Should not partial match name on internal substrings Should return types ordered on name and nonretired first

See Also:

EncounterService.findEncounterTypes(java.lang.String)

retireEncounterType

public EncounterType retireEncounterType(EncounterType encounterType,
                                         String reason)
                                  throws APIException

Description copied from interface: EncounterService

Retire an EncounterType. This essentially marks the given encounter type as a non-current type that shouldn't be used anymore.

Specified by:

retireEncounterType in interface EncounterService

Parameters:

encounterType - the encounter type to retire

reason - required non-null purpose for retiring this encounter type

Throws:

APIException - Should retire type and set attributes Should throw error if given null reason parameter Should should throw error when trying to retire encounter type when encounter types are locked

See Also:

EncounterService.retireEncounterType(EncounterType, String)

unretireEncounterType

public EncounterType unretireEncounterType(EncounterType encounterType)
                                    throws APIException

Description copied from interface: EncounterService

Unretire an EncounterType. This brings back the given encounter type and says that it can be used again

Specified by:

unretireEncounterType in interface EncounterService

Parameters:

encounterType - the encounter type to unretire

Throws:

APIException - Should unretire type and unmark attributes Should should throw error when trying to unretire encounter type when encounter types are locked

See Also:

EncounterService.unretireEncounterType(org.openmrs.EncounterType)

purgeEncounterType

public void purgeEncounterType(EncounterType encounterType)
                        throws APIException

Description copied from interface: EncounterService

Completely remove an encounter type from database.

Specified by:

purgeEncounterType in interface EncounterService

Throws:

APIException - Should purge type Should should throw error when trying to delete encounter type when encounter types are locked

See Also:

EncounterService.purgeEncounterType(org.openmrs.EncounterType)

getEncounterByUuid

@Transactional(readOnly=true)
public Encounter getEncounterByUuid(String uuid)
                                                           throws APIException

Description copied from interface: EncounterService

Get Encounter by its UUID

Specified by:

getEncounterByUuid in interface EncounterService

Returns:

encounter or null Should find object given valid uuid Should return null if no object found with given uuid

Throws:

APIException

See Also:

EncounterService.getEncounterByUuid(java.lang.String)

getEncounterTypeByUuid

@Transactional(readOnly=true)
public EncounterType getEncounterTypeByUuid(String uuid)
                                                                   throws APIException

Description copied from interface: EncounterService

Get EncounterType by its UUID

Specified by:

getEncounterTypeByUuid in interface EncounterService

Returns:

encounter type or null Should find object given valid uuid Should return null if no object found with given uuid

Throws:

APIException

See Also:

EncounterService.getEncounterTypeByUuid(java.lang.String)

getAllEncounters

@Transactional(readOnly=true)
public Map<Integer,List<Encounter>> getAllEncounters(Cohort patients)

Description copied from interface: EncounterService

Get all encounters for a cohort of patients

Specified by:

getAllEncounters in interface EncounterService

Parameters:

patients - Cohort of patients to search

Returns:

Map of all encounters for specified patients. Should get all encounters for a cohort of patients

See Also:

EncounterService.getAllEncounters(org.openmrs.Cohort)

getEncounters

@Transactional(readOnly=true)
public List<Encounter> getEncounters(String query,
                                                                   Integer start,
                                                                   Integer length,
                                                                   boolean includeVoided)
                                                            throws APIException

Description copied from interface: EncounterService

Search for encounters by patient name or patient identifier and returns a specific number of them from the specified starting position. If start and length are not specified, then all matches are returned

Specified by:

getEncounters in interface EncounterService

Parameters:

query - patient name or identifier

start - beginning index for the batch

length - number of encounters to return in the batch

includeVoided - Specifies whether voided encounters should be included

Returns:

list of encounters for the given patient based on batch settings

Throws:

APIException

See Also:

EncounterService.getEncounters(java.lang.String, java.lang.Integer, java.lang.Integer, boolean)

getEncounters

@Transactional(readOnly=true)
public List<Encounter> getEncounters(String query,
                                                                   Integer patientId,
                                                                   Integer start,
                                                                   Integer length,
                                                                   boolean includeVoided)
                                                            throws APIException

Description copied from interface: EncounterService

Searches for encounters by patient id, provider identifier, location, encounter type, provider, form or provider name. It returns a specific number of them from the specified starting position. If start and length are not specified, then all matches are returned

Specified by:

getEncounters in interface EncounterService

Parameters:

query - provider identifier, location, encounter type, provider, form or provider name

patientId - the patient id

start - beginning index for the batch

length - number of encounters to return in the batch

includeVoided - Specifies whether voided encounters should be included

Returns:

list of encounters for the given patient based on batch settings

Throws:

APIException

See Also:

EncounterService.getEncounters(java.lang.String, java.lang.Integer, java.lang.Integer, java.lang.Integer, boolean)

getCountOfEncounters

@Transactional(readOnly=true)
public Integer getCountOfEncounters(String query,
                                                                  boolean includeVoided)

Description copied from interface: EncounterService

Return the number of encounters matching a patient name or patient identifier

Specified by:

getCountOfEncounters in interface EncounterService

Parameters:

query - patient name or identifier

includeVoided - Specifies whether voided encounters should be included

Returns:

the number of encounters matching the given search phrase

See Also:

EncounterService.getCountOfEncounters(java.lang.String, boolean)

getEncountersByVisit

@Transactional(readOnly=true)
public List<Encounter> getEncountersByVisit(Visit visit,
                                                                          boolean includeVoided)

Description copied from interface: EncounterService

Gets all encounters grouped within a given visit.

Specified by:

getEncountersByVisit in interface EncounterService

Parameters:

visit - the visit.

includeVoided - whether voided encounters should be returned

Returns:

list of encounters in the given visit. Should get active encounters by visit Should include voided encounters when includeVoided is true

See Also:

EncounterService.getEncountersByVisit(Visit, boolean)

getEncounterVisitHandlers

@Transactional(readOnly=true)
public List<EncounterVisitHandler> getEncounterVisitHandlers()

Specified by:

getEncounterVisitHandlers in interface EncounterService

Returns:

list of handlers for determining if an encounter should go into a visit. If none are found, an empty list.

See Also:

EncounterVisitHandler

getActiveEncounterVisitHandler

@Transactional(readOnly=true)
public EncounterVisitHandler getActiveEncounterVisitHandler()
                                                                                   throws APIException

Description copied from interface: EncounterService

Gets the active handler for assigning visits to encounters.

Specified by:

getActiveEncounterVisitHandler in interface EncounterService

Returns:

the active handler class.

Throws:

APIException - thrown if something goes wrong during the retrieval of the handler.

See Also:

EncounterService.getActiveEncounterVisitHandler()

saveEncounterRole

public EncounterRole saveEncounterRole(EncounterRole encounterRole)
                                throws APIException

Description copied from interface: EncounterService

Saves a new encounter role or updates an existing encounter role.

Specified by:

saveEncounterRole in interface EncounterService

Parameters:

encounterRole - to be saved

Returns:

EncounterRole

Throws:

APIException

See Also:

EncounterService.saveEncounterRole(org.openmrs.EncounterRole)

getEncounterRole

@Transactional(readOnly=true)
public EncounterRole getEncounterRole(Integer encounterRoleId)
                                                             throws APIException

Description copied from interface: EncounterService

Gets an encounter role when and internal encounter role id is provided.

Specified by:

getEncounterRole in interface EncounterService

Parameters:

encounterRoleId - to be retrieved

Returns:

EncounterRole

Throws:

APIException

See Also:

EncounterService.getEncounterRole(Integer)

purgeEncounterRole

public void purgeEncounterRole(EncounterRole encounterRole)
                        throws APIException

Description copied from interface: EncounterService

Completely remove an encounter role from database. For super users only. If dereferencing encounter roles, use retireEncounterRole(org.openmrs.Encounter, java.lang.String)

Specified by:

purgeEncounterRole in interface EncounterService

Parameters:

encounterRole - encounter role object to be purged

Throws:

APIException

See Also:

EncounterService.purgeEncounterRole(org.openmrs.EncounterRole)

getAllEncounterRoles

@Transactional(readOnly=true)
public List<EncounterRole> getAllEncounterRoles(boolean includeRetired)

Description copied from interface: EncounterService

Get all encounter roles based on includeRetired flag

Specified by:

getAllEncounterRoles in interface EncounterService

Returns:

List of all encounter roles

See Also:

EncounterService.getAllEncounterRoles(boolean)

getEncounterRoleByUuid

@Transactional(readOnly=true)
public EncounterRole getEncounterRoleByUuid(String uuid)
                                                                   throws APIException

Description copied from interface: EncounterService

Get EncounterRole by its UUID

Specified by:

getEncounterRoleByUuid in interface EncounterService

Returns:

EncounterRole

Throws:

APIException

See Also:

EncounterService.getEncounterRoleByUuid(String)

getEncounterRoleByName

public EncounterRole getEncounterRoleByName(String name)

Description copied from interface: EncounterService

Get EncounterRole by name

Specified by:

getEncounterRoleByName in interface EncounterService

Returns:

EncounterRole object by name

See Also:

EncounterService.getEncounterRoleByName(String)

retireEncounterRole

public EncounterRole retireEncounterRole(EncounterRole encounterRole,
                                         String reason)
                                  throws APIException

Description copied from interface: EncounterService

Retire an EncounterRole. This essentially marks the given encounter role as a non-current type that shouldn't be used anymore.

Specified by:

retireEncounterRole in interface EncounterService

Parameters:

encounterRole - the encounter role to retire

reason - required non-null purpose for retiring this encounter role

Throws:

APIException

See Also:

EncounterService.retireEncounterRole(org.openmrs.EncounterRole, String)

unretireEncounterRole

public EncounterRole unretireEncounterRole(EncounterRole encounterRole)
                                    throws APIException

Description copied from interface: EncounterService

Unretire an EncounterRole. This brings back the given encounter role and says that it can be used again

Specified by:

unretireEncounterRole in interface EncounterService

Parameters:

encounterRole - the encounter role to unretire

Throws:

APIException

See Also:

EncounterService.unretireEncounterRole(org.openmrs.EncounterRole)

getEncountersNotAssignedToAnyVisit

@Transactional(readOnly=true)
public List<Encounter> getEncountersNotAssignedToAnyVisit(Patient patient)
                                                                                 throws APIException

Description copied from interface: EncounterService

Gets the unvoided encounters for the specified patient that are not assigned to any visit. Note that this method will return a maximum of 100 encounters.

Specified by:

getEncountersNotAssignedToAnyVisit in interface EncounterService

Parameters:

patient - the patient to match against

Returns:

a list of Encounters

Throws:

APIException - Should return the unvoided encounters not assigned to any visit

See Also:

EncounterService.getEncountersNotAssignedToAnyVisit(org.openmrs.Patient)

getEncountersByVisitsAndPatient

@Transactional(readOnly=true)
public List<Encounter> getEncountersByVisitsAndPatient(Patient patient,
                                                                                     boolean includeVoided,
                                                                                     String query,
                                                                                     Integer start,
                                                                                     Integer length)
                                                                              throws APIException

Description copied from interface: EncounterService

Gets encounters for the given patient. It populates results with empty encounters to include visits that have no assigned encounters.

The empty encounters have only visit set.

Specified by:

getEncountersByVisitsAndPatient in interface EncounterService

Parameters:

patient - the patient to match

includeVoided - if voided encounters or visits should be included

query - filters results (defaults to return all results if null)

start - index to start with (defaults to 0 if null)

length - number of results to return (default to return all results if null)

Returns:

encounters and empty encounters with only visit set

Throws:

APIException

See Also:

EncounterService.getEncountersByVisitsAndPatient(org.openmrs.Patient, boolean, java.lang.String, java.lang.Integer, java.lang.Integer)

getEncountersByVisitsAndPatientCount

@Transactional(readOnly=true)
public Integer getEncountersByVisitsAndPatientCount(Patient patient,
                                                                                  boolean includeVoided,
                                                                                  String query)
                                                                           throws APIException

Description copied from interface: EncounterService

Returns result count for EncounterService.getEncountersByVisitsAndPatient(Patient, boolean, String, Integer, Integer).

Specified by:

getEncountersByVisitsAndPatientCount in interface EncounterService

Returns:

number of results

Throws:

APIException

See Also:

EncounterService.getEncountersByVisitsAndPatientCount(org.openmrs.Patient, boolean, java.lang.String)

filterEncountersByViewPermissions

@Transactional(readOnly=true)
public List<Encounter> filterEncountersByViewPermissions(List<Encounter> encounters,
                                                                                       User user)

Description copied from interface: EncounterService

Filters out all encounters to which given user does not have access. If user is not specified then implementations should treat authenticated user from context as given user by default

Specified by:

filterEncountersByViewPermissions in interface EncounterService

Parameters:

encounters - the list of encounters to be filtered

user - the user instance to filter "visible" encounters for

Returns:

list, that does not include encounters, which can not be shown to given user due to permissions check Should filter encounters if user is not allowed to see some encounters Should not filter all encounters when the encounter type's view privilege column is null

See Also:

EncounterService.filterEncountersByViewPermissions(java.util.List, org.openmrs.User)

canViewAllEncounterTypes

@Transactional(readOnly=true)
public boolean canViewAllEncounterTypes(User subject)

Description copied from interface: EncounterService

Determines whether given user is granted to view all encounter types or not

Specified by:

canViewAllEncounterTypes in interface EncounterService

Parameters:

subject - the user whose permission to view all encounter types will be checked

Returns:

true if user has access to view all types of encounters Should return true if user is granted to view all encounters Should return true when the encounter type's view privilege column is null

See Also:

EncounterService.canViewAllEncounterTypes(org.openmrs.User)

canEditAllEncounterTypes

@Transactional(readOnly=true)
public boolean canEditAllEncounterTypes(User subject)

Description copied from interface: EncounterService

Determines whether given user is granted to edit all encounter types or not

Specified by:

canEditAllEncounterTypes in interface EncounterService

Parameters:

subject - the user whose permission to edit all encounter types will be checked

Returns:

true if user has access to edit all types of encounters Should return true if user is granted to edit all encounters Should return true when the encounter type's edit privilege column is null

See Also:

EncounterService.canEditAllEncounterTypes(org.openmrs.User)

canEditEncounter

public boolean canEditEncounter(Encounter encounter,
                                User user)

Description copied from interface: EncounterService

Checks if passed in user can edit given encounter. If user is not specified, then authenticated user will be taken by default

Specified by:

canEditEncounter in interface EncounterService

Parameters:

encounter - the encounter instance to be checked

user - the user, who requests edit access

Returns:

true if user has privilege denoted by editPrivilege given on encounter type Should return true if user can edit encounter Should return false if user can not edit encounter Should fail if encounter is null

See Also:

EncounterService.canEditEncounter(org.openmrs.Encounter, org.openmrs.User)

canViewEncounter

public boolean canViewEncounter(Encounter encounter,
                                User user)

Description copied from interface: EncounterService

Checks if passed in user can view given encounter. If user is not specified, then authenticated user will be taken by default

Specified by:

canViewEncounter in interface EncounterService

Parameters:

encounter - the encounter instance to be checked

user - the user, who requests view access

Returns:

true if user has privilege denoted by viewPrivilege given on encounter type Should return true if user can view encounter Should return false if user can not view encounter Should fail if encounter is null

See Also:

EncounterService.canViewEncounter(org.openmrs.Encounter, org.openmrs.User)

checkIfEncounterTypesAreLocked

@Transactional(readOnly=true)
public void checkIfEncounterTypesAreLocked()

Description copied from interface: EncounterService

Check if the encounter types are locked, and if so, throw exception during manipulation of encounter type

Specified by:

checkIfEncounterTypesAreLocked in interface EncounterService

See Also:

EncounterService.checkIfEncounterTypesAreLocked()

getEncounterRolesByName

public List<EncounterRole> getEncounterRolesByName(String name)

Description copied from interface: EncounterService

Get EncounterRoles by name

Specified by:

getEncounterRolesByName in interface EncounterService

Returns:

List of EncounterRole objects

See Also:

EncounterService.getEncounterRolesByName(String)

transferEncounter

public Encounter transferEncounter(Encounter encounter,
                                   Patient patient)

Description copied from interface: EncounterService

Transfer encounter to another patient

Specified by:

transferEncounter in interface EncounterService

Returns:

transferred encounter