org.openmrs.api.impl

Class EncounterServiceImpl

java.lang.Object

org.openmrs.api.impl.BaseOpenmrsService

org.openmrs.api.impl.EncounterServiceImpl

All Implemented Interfaces:

EncounterService, OpenmrsService

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
void	checkIfEncounterTypesAreLocked() Check if the encounter types are locked, and if so, throw exception during manipulation of encounter type
void	createEncounter(Encounter encounter) Deprecated. replaced by saveEncounter(Encounter)
void	deleteEncounter(Encounter encounter) Deprecated. Replaced by purgeEncounter(Encounter)
java.util.List<EncounterType>	findEncounterTypes(java.lang.String name) Find Encounter Types with name matching the beginning of the search string.
java.util.List<Location>	findLocations(java.lang.String name) Deprecated. use LocationService.getLocations(name)
EncounterVisitHandler	getActiveEncounterVisitHandler() Gets the active handler for assigning visits to encounters.
java.util.List<EncounterRole>	getAllEncounterRoles(boolean includeRetired) Get all encounter roles based on includeRetired flag
java.util.Map<java.lang.Integer,java.util.List<Encounter>>	getAllEncounters(Cohort patients) Get all encounters for a cohort of patients
java.util.List<EncounterType>	getAllEncounterTypes() Get all encounter types (including retired)
java.util.List<EncounterType>	getAllEncounterTypes(boolean includeRetired) Get all encounter types.
java.lang.Integer	getCountOfEncounters(java.lang.String query, boolean includeVoided) Return the number of encounters matching a patient name or patient identifier
Encounter	getEncounter(java.lang.Integer encounterId) Get encounter by internal identifier
Encounter	getEncounterByUuid(java.lang.String uuid) Get Encounter by its UUID
EncounterRole	getEncounterRole(java.lang.Integer encounterRoleId) Gets an encounter role when and internal encounter role id is provided.
EncounterRole	getEncounterRoleByUuid(java.lang.String uuid) Get EncounterRole by its UUID
java.util.Collection<Encounter>	getEncounters(java.util.Date fromDate, java.util.Date toDate) Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)
java.util.List<Encounter>	getEncounters(Location loc, java.util.Date fromDate, java.util.Date toDate) Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)
java.util.List<Encounter>	getEncounters(Patient who) Deprecated. replaced by getEncountersByPatient(Patient patient)
java.util.List<Encounter>	getEncounters(Patient who, boolean includeVoided) Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)
java.util.List<Encounter>	getEncounters(Patient who, java.util.Date fromDate, java.util.Date toDate) Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)
java.util.List<Encounter>	getEncounters(Patient who, Location where) Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)
java.util.List<Encounter>	getEncounters(Patient who, Location loc, java.util.Date fromDate, java.util.Date toDate, java.util.Collection<Form> enteredViaForms, java.util.Collection<EncounterType> encounterTypes, boolean includeVoided) Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)
java.util.List<Encounter>	getEncounters(Patient who, Location loc, java.util.Date fromDate, java.util.Date toDate, java.util.Collection<Form> enteredViaForms, java.util.Collection<EncounterType> encounterTypes, java.util.Collection<Provider> providers, java.util.Collection<VisitType> visitTypes, java.util.Collection<Visit> visits, boolean includeVoided) Get all encounters that match a variety of (nullable) criteria.
java.util.List<Encounter>	getEncounters(Patient who, Location loc, java.util.Date fromDate, java.util.Date toDate, java.util.Collection<Form> enteredViaForms, java.util.Collection<EncounterType> encounterTypes, java.util.Collection<User> providers, boolean includeVoided) Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, Collection, Collection, boolean)
java.util.List<Encounter>	getEncounters(java.lang.String query, java.lang.Integer start, java.lang.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.
java.util.List<Encounter>	getEncounters(java.lang.String query, java.lang.Integer patientId, java.lang.Integer start, java.lang.Integer length, boolean includeVoided) Searches for encounters by patient id, provider identifier, location, encounter type, provider, form or provider name.
java.util.List<Encounter>	getEncountersByPatient(Patient patient) Get all encounters (not voided) for a patient, sorted by encounterDatetime ascending.
java.util.List<Encounter>	getEncountersByPatient(java.lang.String query) Search for encounters by patient name or patient identifier.
java.util.List<Encounter>	getEncountersByPatient(java.lang.String query, boolean includeVoided) Search for encounters by patient name or patient identifier.
java.util.List<Encounter>	getEncountersByPatientId(java.lang.Integer patientId) Get encounters for a patientId
java.util.List<Encounter>	getEncountersByPatientId(java.lang.Integer patientId, boolean includeVoided) Deprecated. replaced by getEncountersByPatientId(Integer)
java.util.List<Encounter>	getEncountersByPatientIdentifier(java.lang.String identifier) Get encounters (not voided) for a patient identifier
java.util.List<Encounter>	getEncountersByPatientIdentifier(java.lang.String identifier, boolean includeVoided) Deprecated. replaced by getEncountersByPatientIdentifier(String)
java.util.List<Encounter>	getEncountersByVisit(Visit visit, boolean includeVoided) Gets all encounters grouped within a given visit.
java.util.List<Encounter>	getEncountersByVisitsAndPatient(Patient patient, boolean includeVoided, java.lang.String query, java.lang.Integer start, java.lang.Integer length) Gets encounters for the given patient.
java.lang.Integer	getEncountersByVisitsAndPatientCount(Patient patient, boolean includeVoided, java.lang.String query) Returns result count for EncounterService.getEncountersByVisitsAndPatient(Patient, boolean, String, Integer, Integer).
java.util.List<Encounter>	getEncountersNotAssignedToAnyVisit(Patient patient) Gets the unvoided encounters for the specified patient that are not assigned to any visit.
EncounterType	getEncounterType(java.lang.Integer encounterTypeId) Get encounterType by internal identifier
EncounterType	getEncounterType(java.lang.String name) Get encounterType by exact name
EncounterType	getEncounterTypeByUuid(java.lang.String uuid) Get EncounterType by its UUID
java.util.List<EncounterType>	getEncounterTypes() Deprecated. replaced by getAllEncounterTypes()
java.util.List<EncounterVisitHandler>	getEncounterVisitHandlers()
Location	getLocation(java.lang.Integer locationId) Deprecated. use LocationService.getLocation(locationId)
Location	getLocationByName(java.lang.String name) Deprecated. use LocationService.getLocation(name)
java.util.List<Location>	getLocations() Deprecated. use LocationService.getAllLocations()
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, java.lang.String reason) Retire an EncounterRole.
EncounterType	retireEncounterType(EncounterType encounterType, java.lang.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.
EncounterRole	unretireEncounterRole(EncounterRole encounterRole) Unretire an EncounterRole.
EncounterType	unretireEncounterType(EncounterType encounterType) Unretire an EncounterType.
Encounter	unvoidEncounter(Encounter encounter) Unvoid encounter record
void	updateEncounter(Encounter encounter) Deprecated. replaced by saveEncounter(Encounter)
Encounter	voidEncounter(Encounter encounter, java.lang.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

public java.util.List<Encounter> getEncountersByPatient(java.lang.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

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

See Also:

EncounterService.saveEncounter(org.openmrs.Encounter)

getEncounter

public Encounter getEncounter(java.lang.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

See Also:

EncounterService.getEncounter(java.lang.Integer)

getEncountersByPatient

public java.util.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 encounters (not voided) for a patient.

Throws:

APIException

See Also:

EncounterService.getEncountersByPatient(org.openmrs.Patient)

getEncountersByPatient

public java.util.List<Encounter> getEncountersByPatient(java.lang.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

public java.util.List<Encounter> getEncountersByPatientId(java.lang.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

See Also:

EncounterService.getEncountersByPatientId(java.lang.Integer)

getEncountersByPatientIdentifier

public java.util.List<Encounter> getEncountersByPatientIdentifier(java.lang.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 identifer

Throws:

APIException

See Also:

EncounterService.getEncountersByPatientIdentifier(java.lang.String)

getEncounters

@Deprecated
public java.util.List<Encounter> getEncounters(Patient who,
                                                           Location loc,
                                                           java.util.Date fromDate,
                                                           java.util.Date toDate,
                                                           java.util.Collection<Form> enteredViaForms,
                                                           java.util.Collection<EncounterType> encounterTypes,
                                                           boolean includeVoided)

Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)

Specified by:

getEncounters in interface EncounterService

See Also:

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

getEncounters

@Deprecated
public java.util.List<Encounter> getEncounters(Patient who,
                                                           Location loc,
                                                           java.util.Date fromDate,
                                                           java.util.Date toDate,
                                                           java.util.Collection<Form> enteredViaForms,
                                                           java.util.Collection<EncounterType> encounterTypes,
                                                           java.util.Collection<User> providers,
                                                           boolean includeVoided)

Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, Collection, Collection, boolean)

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

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, boolean)

getEncounters

public java.util.List<Encounter> getEncounters(Patient who,
                                               Location loc,
                                               java.util.Date fromDate,
                                               java.util.Date toDate,
                                               java.util.Collection<Form> enteredViaForms,
                                               java.util.Collection<EncounterType> encounterTypes,
                                               java.util.Collection<Provider> providers,
                                               java.util.Collection<VisitType> visitTypes,
                                               java.util.Collection<Visit> visits,
                                               boolean includeVoided)

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, boolean)

voidEncounter

public Encounter voidEncounter(Encounter encounter,
                               java.lang.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

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

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

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?

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

See Also:

EncounterService.saveEncounterType(org.openmrs.EncounterType)

getEncounterType

public EncounterType getEncounterType(java.lang.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

See Also:

EncounterService.getEncounterType(java.lang.Integer)

getEncounterType

public EncounterType getEncounterType(java.lang.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

See Also:

EncounterService.getEncounterType(java.lang.String)

getAllEncounterTypes

public java.util.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

See Also:

EncounterService.getAllEncounterTypes()

getAllEncounterTypes

public java.util.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

See Also:

EncounterService.getAllEncounterTypes(boolean)

findEncounterTypes

public java.util.List<EncounterType> findEncounterTypes(java.lang.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 matching encounters

Throws:

APIException

See Also:

EncounterService.findEncounterTypes(java.lang.String)

retireEncounterType

public EncounterType retireEncounterType(EncounterType encounterType,
                                         java.lang.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

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

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

See Also:

EncounterService.purgeEncounterType(org.openmrs.EncounterType)

createEncounter

@Deprecated
public void createEncounter(Encounter encounter)
                                 throws APIException

Deprecated. replaced by saveEncounter(Encounter)

Description copied from interface: EncounterService

Creates a new encounter

Specified by:

createEncounter in interface EncounterService

Parameters:

encounter - to be created

Throws:

APIException

See Also:

EncounterService.createEncounter(org.openmrs.Encounter)

updateEncounter

@Deprecated
public void updateEncounter(Encounter encounter)
                                 throws APIException

Deprecated. replaced by saveEncounter(Encounter)

Description copied from interface: EncounterService

Save changes to encounter. Automatically applys encounter.patient to all encounter.obs.patient

Specified by:

updateEncounter in interface EncounterService

Throws:

APIException

See Also:

EncounterService.updateEncounter(org.openmrs.Encounter)

deleteEncounter

@Deprecated
public void deleteEncounter(Encounter encounter)
                                 throws APIException

Deprecated. Replaced by purgeEncounter(Encounter)

Description copied from interface: EncounterService

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

Specified by:

deleteEncounter in interface EncounterService

Parameters:

encounter - encounter object to be deleted

Throws:

APIException

See Also:

EncounterService.deleteEncounter(org.openmrs.Encounter)

getEncountersByPatientId

@Deprecated
public java.util.List<Encounter> getEncountersByPatientId(java.lang.Integer patientId,
                                                                      boolean includeVoided)
                                                               throws APIException

Deprecated. replaced by getEncountersByPatientId(Integer)

Description copied from interface: EncounterService

Get encounters for a patientId (not voided). To include voided Encounters use EncounterService.getEncounters(Patient, Location, Date, Date, Collection, Collection, boolean)

Specified by:

getEncountersByPatientId in interface EncounterService

includeVoided - No longer supported

Returns:

all encounters for the given patient identifer

Throws:

APIException

See Also:

EncounterService.getEncountersByPatientId(java.lang.Integer, boolean)

getEncountersByPatientIdentifier

@Deprecated
public java.util.List<Encounter> getEncountersByPatientIdentifier(java.lang.String identifier,
                                                                              boolean includeVoided)
                                                                       throws APIException

Deprecated. replaced by getEncountersByPatientIdentifier(String)

Description copied from interface: EncounterService

Get encounters (not voided) for a patient identifier. To include voided encounters use EncounterService.getEncounters(Patient, Location, Date, Date, Collection, Collection, boolean)

Specified by:

getEncountersByPatientIdentifier in interface EncounterService

includeVoided - No longer supported.

Returns:

all encounters for the given patient identifer

Throws:

APIException

See Also:

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

getEncounters

@Deprecated
public java.util.List<Encounter> getEncounters(Patient who)

Deprecated. replaced by getEncountersByPatient(Patient patient)

Description copied from interface: EncounterService

Get all encounters (not voided) for a patient

Specified by:

getEncounters in interface EncounterService

Returns:

List encounters (not voided) for a patient

See Also:

EncounterService.getEncounters(org.openmrs.Patient)

getEncounters

@Deprecated
public java.util.List<Encounter> getEncounters(Patient who,
                                                           boolean includeVoided)

Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)

Description copied from interface: EncounterService

Get all encounters (not voided) for a patient. To include voided encounters, use EncounterService.getEncounters(Patient, Location, Date, Date, Collection, Collection, boolean)

Specified by:

getEncounters in interface EncounterService

includeVoided - No longer supported.

Returns:

List object of non-voided Encounters

See Also:

EncounterService.getEncounters(org.openmrs.Patient, boolean)

getEncounters

@Deprecated
public java.util.List<Encounter> getEncounters(Patient who,
                                                           Location where)

Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)

Description copied from interface: EncounterService

Get all encounters for a patient that took place at a specific location

Specified by:

getEncounters in interface EncounterService

Returns:

List object of all encounters with this patient in specified location

See Also:

EncounterService.getEncounters(org.openmrs.Patient, org.openmrs.Location)

getEncounters

@Deprecated
public java.util.List<Encounter> getEncounters(Patient who,
                                                           java.util.Date fromDate,
                                                           java.util.Date toDate)

Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)

Description copied from interface: EncounterService

Get all encounters for a patient that took place between fromDate and toDate (both nullable and inclusive)

Specified by:

getEncounters in interface EncounterService

Returns:

List object of all encounters with this patient in specified date range

See Also:

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

getEncounters

@Deprecated
public java.util.Collection<Encounter> getEncounters(java.util.Date fromDate,
                                                                 java.util.Date toDate)

Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)

Description copied from interface: EncounterService

Get all encounters that took place between fromDate and toDate (both nullable and inclusive)

Specified by:

getEncounters in interface EncounterService

Returns:

Encounters from specified date range

See Also:

EncounterService.getEncounters(java.util.Date, java.util.Date)

getEncounters

@Deprecated
public java.util.List<Encounter> getEncounters(Location loc,
                                                           java.util.Date fromDate,
                                                           java.util.Date toDate)

Deprecated. replaced by getEncounters(Patient, Location, Date, Date, Collection, Collection, Collection, boolean)

Description copied from interface: EncounterService

Get all encounters that took place between fromDate and toDate (both nullable and inclusive) at the given location

Specified by:

getEncounters in interface EncounterService

Parameters:

loc - Location

Returns:

Encounters from specified location and date range

See Also:

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

getEncounterTypes

@Deprecated
public java.util.List<EncounterType> getEncounterTypes()

Deprecated. replaced by getAllEncounterTypes()

Description copied from interface: EncounterService

Get all encounter types (not retired)

Specified by:

getEncounterTypes in interface EncounterService

Returns:

A List object of all non-retired EncounterTypes

See Also:

EncounterService.getEncounterTypes()

getLocations

@Deprecated
public java.util.List<Location> getLocations()
                                                  throws APIException

Deprecated. use LocationService.getAllLocations()

Description copied from interface: EncounterService

Get all locations

Specified by:

getLocations in interface EncounterService

Returns:

location list

Throws:

APIException

See Also:

EncounterService.getLocations()

getLocation

@Deprecated
public Location getLocation(java.lang.Integer locationId)
                                 throws APIException

Deprecated. use LocationService.getLocation(locationId)

Description copied from interface: EncounterService

Get location by internal identifier

Specified by:

getLocation in interface EncounterService

Returns:

location with given internal identifier

Throws:

APIException

See Also:

EncounterService.getLocation(java.lang.Integer)

getLocationByName

@Deprecated
public Location getLocationByName(java.lang.String name)
                                       throws APIException

Deprecated. use LocationService.getLocation(name)

Description copied from interface: EncounterService

Get location by name

Specified by:

getLocationByName in interface EncounterService

Parameters:

name - location's name

Returns:

location with given name

Throws:

APIException

See Also:

EncounterService.getLocationByName(java.lang.String)

findLocations

@Deprecated
public java.util.List<Location> findLocations(java.lang.String name)
                                                   throws APIException

Deprecated. use LocationService.getLocations(name)

Description copied from interface: EncounterService

Search for locations by name. Matches returned match the given string at the beginning of the name

Specified by:

findLocations in interface EncounterService

Parameters:

name - location's name

Returns:

list of locations with similar name

Throws:

APIException

See Also:

EncounterService.findLocations(java.lang.String)

getEncounterByUuid

public Encounter getEncounterByUuid(java.lang.String uuid)
                             throws APIException

Description copied from interface: EncounterService

Get Encounter by its UUID

Specified by:

getEncounterByUuid in interface EncounterService

Returns:

Throws:

APIException

See Also:

EncounterService.getEncounterByUuid(java.lang.String)

getEncounterTypeByUuid

public EncounterType getEncounterTypeByUuid(java.lang.String uuid)
                                     throws APIException

Description copied from interface: EncounterService

Get EncounterType by its UUID

Specified by:

getEncounterTypeByUuid in interface EncounterService

Returns:

Throws:

APIException

See Also:

EncounterService.getEncounterTypeByUuid(java.lang.String)

getAllEncounters

public java.util.Map<java.lang.Integer,java.util.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.

See Also:

EncounterService.getAllEncounters(org.openmrs.Cohort)

getEncounters

public java.util.List<Encounter> getEncounters(java.lang.String query,
                                               java.lang.Integer start,
                                               java.lang.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 java.util.List<Encounter> getEncounters(java.lang.String query,
                                                                             java.lang.Integer patientId,
                                                                             java.lang.Integer start,
                                                                             java.lang.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

public java.lang.Integer getCountOfEncounters(java.lang.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

public java.util.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.

See Also:

EncounterService.getEncountersByVisit(Visit, boolean)

getEncounterVisitHandlers

public java.util.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

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

public EncounterRole getEncounterRole(java.lang.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

public java.util.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

public EncounterRole getEncounterRoleByUuid(java.lang.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)

retireEncounterRole

public EncounterRole retireEncounterRole(EncounterRole encounterRole,
                                         java.lang.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

Throws:

APIException

See Also:

EncounterService.unretireEncounterRole(org.openmrs.EncounterRole)

getEncountersNotAssignedToAnyVisit

public java.util.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

See Also:

EncounterService.getEncountersNotAssignedToAnyVisit(org.openmrs.Patient)

getEncountersByVisitsAndPatient

public java.util.List<Encounter> getEncountersByVisitsAndPatient(Patient patient,
                                                                 boolean includeVoided,
                                                                 java.lang.String query,
                                                                 java.lang.Integer start,
                                                                 java.lang.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

public java.lang.Integer getEncountersByVisitsAndPatientCount(Patient patient,
                                                              boolean includeVoided,
                                                              java.lang.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)

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()