EncounterService (OpenMRS 1.9.13-SNAPSHOT API)

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

EncounterServiceImpl
```
@Transactional
public interface EncounterService
extends OpenmrsService
```
Services for Encounters and Encounter Types

Version:

1.0

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
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. replaced by `LocationService.getLocations(String)`
`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. use `getEncounters(Patient, Location, Date, Date, Collection, Collection, boolean)`
`java.util.Collection<Encounter>`	`getEncounters(Location loc, java.util.Date fromDate, java.util.Date toDate)` Deprecated. use `getEncounters(Patient, Location, Date, Date, Collection, Collection, boolean)`
`java.util.List<Encounter>`	`getEncounters(Patient who)` Deprecated. replaced by `getEncountersByPatient(Patient)`
`java.util.List<Encounter>`	`getEncounters(Patient who, boolean includeVoided)` Deprecated. replaced by `getEncountersByPatient(Patient)`
`java.util.List<Encounter>`	`getEncounters(Patient who, java.util.Date fromDate, java.util.Date toDate)` Deprecated. use `getEncounters(Patient, Location, Date, Date, Collection, Collection, boolean)`
`java.util.List<Encounter>`	`getEncounters(Patient who, Location where)` Deprecated. use `getEncounters(Patient, Location, Date, Date, 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 `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. replaced by `LocationService.getLocation(Integer)`
`Location`	`getLocationByName(java.lang.String name)` Deprecated. replaced by `LocationService.getLocation(String)`
`java.util.List<Location>`	`getLocations()` Deprecated. replaced by `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 encounterType)` 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 interface org.openmrs.api.OpenmrsService
onShutdown, onStartup

Method Detail

setEncounterDAO
```
void setEncounterDAO(EncounterDAO dao)
```
Set the given dao on this encounter service. The dao will act as the conduit through with all encounter calls get to the database

Parameters:

dao -

saveEncounter
```
@Authorized(value={"Add Encounters","Edit Encounters"})
Encounter saveEncounter(Encounter encounter)
                                                                         throws APIException
```
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

Parameters:

encounter - to be saved

Throws:

APIException

getEncounter

@Transactional(readOnly=true)
 @Authorized(value="View Encounters")
Encounter getEncounter(java.lang.Integer encounterId)
                                                                                    throws APIException

Get encounter by internal identifier

Parameters:: encounterId - encounter id
Returns:: encounter with given internal identifier
Throws:: APIException

getEncounterByUuid

@Transactional(readOnly=true)
 @Authorized(value="View Encounters")
Encounter getEncounterByUuid(java.lang.String uuid)
                                                                                          throws APIException

Get Encounter by its UUID

Parameters:: uuid -
Returns:
Throws:: APIException

getEncountersByPatient
```
@Transactional(readOnly=true)
 @Authorized(value="View Encounters")
java.util.List<Encounter> getEncountersByPatient(Patient patient)
```
Get all encounters (not voided) for a patient, sorted by encounterDatetime ascending.

Parameters:

patient -

Returns:

List encounters (not voided) for a patient.

getEncountersByPatientId

@Transactional(readOnly=true)
 @Authorized(value="View Encounters")
java.util.List<Encounter> getEncountersByPatientId(java.lang.Integer patientId)
                                                                                                                throws APIException

Get encounters for a patientId

Parameters:: patientId -
Returns:: all encounters (not voided) for the given patient identifier
Throws:: APIException

getEncountersByPatientIdentifier

@Transactional(readOnly=true)
 @Authorized(value="View Encounters")
java.util.List<Encounter> getEncountersByPatientIdentifier(java.lang.String identifier)
                                                                                                                        throws APIException

Get encounters (not voided) for a patient identifier

Parameters:: identifier -
Returns:: all encounters (not retired) for the given patient identifer
Throws:: APIException

getEncounters

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Encounters")
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)

getEncounters

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Encounters")
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)

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

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
Since:: 1.5

getEncounters

@Transactional(readOnly=true)
 @Authorized(value="View Encounters")
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. Each extra value for a parameter that is provided acts as an "and" and will reduce the number of results returned

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
Since:: 1.9

voidEncounter

@Authorized(value="Edit Encounters")
Encounter voidEncounter(Encounter encounter,
                                                             java.lang.String reason)

Voiding a encounter essentially removes it from circulation

Parameters:: encounter - Encounter object to void; reason - String reason that it's being voided

unvoidEncounter

@Authorized(value="Edit Encounters")
Encounter unvoidEncounter(Encounter encounter)
                                                        throws APIException

Unvoid encounter record

Parameters:: encounter - Encounter to be revived
Throws:: APIException

purgeEncounter
```
@Authorized(value="Purge Encounters")
void purgeEncounter(Encounter encounter)
                                                   throws APIException
```
Completely remove an encounter from database. For super users only. If dereferencing encounters, use voidEncounter(org.openmrs.Encounter)

Parameters:

encounter - encounter object to be purged

Throws:

APIException

purgeEncounter
```
@Authorized(value="Purge Encounters")
void purgeEncounter(Encounter encounter,
                                                          boolean cascade)
                                                   throws APIException
```
Completely remove an encounter from database. For super users only. If dereferencing encounters, use voidEncounter(org.openmrs.Encounter)

Parameters:

encounter - encounter object to be purged

cascade - Purge any related observations as well?

Throws:

APIException

saveEncounterType

@Authorized(value="Manage Encounter Types")
EncounterType saveEncounterType(EncounterType encounterType)
                                                                     throws APIException

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

Parameters:: encounterType -
Throws:: APIException

getEncounterType

@Transactional(readOnly=true)
 @Authorized(value="View Encounter Types")
EncounterType getEncounterType(java.lang.Integer encounterTypeId)
                                                                                                 throws APIException

Get encounterType by internal identifier

Parameters:: encounterTypeId - Integer
Returns:: encounterType with given internal identifier
Throws:: APIException

getEncounterTypeByUuid

@Transactional(readOnly=true)
 @Authorized(value="View Encounter Types")
EncounterType getEncounterTypeByUuid(java.lang.String uuid)
                                                                                                       throws APIException

Get EncounterType by its UUID

Parameters:: uuid -
Returns:
Throws:: APIException

getEncounterType

@Transactional(readOnly=true)
 @Authorized(value="View Encounter Types")
EncounterType getEncounterType(java.lang.String name)
                                                                                                 throws APIException

Get encounterType by exact name

Parameters:: name - string to match to an Encounter.name
Returns:: EncounterType that is not retired
Throws:: APIException

getAllEncounterTypes

@Transactional(readOnly=true)
 @Authorized(value="View Encounter Types")
java.util.List<EncounterType> getAllEncounterTypes()
                                                                                                                     throws APIException

Get all encounter types (including retired)

Returns:: encounter types list
Throws:: APIException

getAllEncounterTypes

@Transactional(readOnly=true)
 @Authorized(value="View Encounter Types")
java.util.List<EncounterType> getAllEncounterTypes(boolean includeRetired)
                                                                                                                     throws APIException

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

Parameters:: includeRetired -
Returns:: encounter types list
Throws:: APIException

findEncounterTypes
```
@Transactional(readOnly=true)
 @Authorized(value="View Encounter Types")
java.util.List<EncounterType> findEncounterTypes(java.lang.String name)
                                                                                                                   throws APIException
```
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.

Parameters:

name - of the encounter type to find

Returns:

List matching encounters

Throws:

APIException

retireEncounterType

@Authorized(value="Manage Encounter Types")
EncounterType retireEncounterType(EncounterType encounterType,
                                                                              java.lang.String reason)
                                                                       throws APIException

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

Parameters:: encounterType - the encounter type to retire; reason - required non-null purpose for retiring this encounter type
Throws:: APIException

unretireEncounterType

@Authorized(value="Manage Encounter Types")
EncounterType unretireEncounterType(EncounterType encounterType)
                                                                         throws APIException

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

Parameters:: encounterType - the encounter type to unretire
Throws:: APIException

purgeEncounterType

@Authorized(value="Purge Encounter Types")
void purgeEncounterType(EncounterType encounterType)
                                                            throws APIException

Completely remove an encounter type from database.

Parameters:: encounterType -
Throws:: APIException

createEncounter

@Deprecated
 @Authorized(value="Add Encounters")
void createEncounter(Encounter encounter)
                                                               throws APIException

Deprecated. replaced by saveEncounter(Encounter)

Creates a new encounter

Parameters:: encounter - to be created
Throws:: APIException

updateEncounter
```
@Deprecated
 @Authorized(value="Edit Encounters")
void updateEncounter(Encounter encounter)
                                                                throws APIException
```
Deprecated. replaced by saveEncounter(Encounter)

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

Parameters:

encounter -

Throws:

APIException

deleteEncounter
```
@Deprecated
 @Authorized(value="Delete Encounters")
void deleteEncounter(Encounter encounter)
                                                                  throws APIException
```
Deprecated. replaced by purgeEncounter(Encounter)

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

Parameters:

encounter - encounter object to be deleted

Throws:

APIException

getEncountersByPatientId

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Encounters")
java.util.List<Encounter> getEncountersByPatientId(java.lang.Integer patientId,
                                                                                                                                    boolean includeVoided)
                                                                                                                             throws APIException

Deprecated. replaced by getEncountersByPatientId(Integer)

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

Parameters:: patientId -; includeVoided - No longer supported
Returns:: all encounters for the given patient identifer
Throws:: APIException

getEncountersByPatientIdentifier

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Encounters")
java.util.List<Encounter> getEncountersByPatientIdentifier(java.lang.String identifier,
                                                                                                                                            boolean includeVoided)
                                                                                                                                     throws APIException

Deprecated. replaced by getEncountersByPatientIdentifier(String)

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

Parameters:: identifier -; includeVoided - No longer supported.
Returns:: all encounters for the given patient identifer
Throws:: APIException

getEncounters
```
@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Encounters")
java.util.List<Encounter> getEncounters(Patient who)
```
Deprecated. replaced by getEncountersByPatient(Patient)

Get all encounters (not voided) for a patient

Parameters:

who -

Returns:

List encounters (not voided) for a patient

getEncounters
```
@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Encounters")
java.util.List<Encounter> getEncounters(Patient who,
                                                                                                                         boolean includeVoided)
```
Deprecated. replaced by getEncountersByPatient(Patient)

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

Parameters:

who -

includeVoided - No longer supported.

Returns:

List object of non-voided Encounters

getEncounters

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Encounters")
java.util.List<Encounter> getEncounters(Patient who,
                                                                                                                         Location where)

Deprecated. use getEncounters(Patient, Location, Date, Date, Collection, Collection, boolean)

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

Parameters:: who -; where -
Returns:: List object of all encounters with this patient in specified location

getEncounters

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Encounters")
java.util.List<Encounter> getEncounters(Patient who,
                                                                                                                         java.util.Date fromDate,
                                                                                                                         java.util.Date toDate)

Deprecated. use getEncounters(Patient, Location, Date, Date, Collection, Collection, boolean)

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

Parameters:: who -; fromDate -; toDate -
Returns:: List object of all encounters with this patient in specified date range

getEncounters

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Encounters")
java.util.Collection<Encounter> getEncounters(java.util.Date fromDate,
                                                                                                                               java.util.Date toDate)

Deprecated. use getEncounters(Patient, Location, Date, Date, Collection, Collection, boolean)

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

Parameters:: fromDate -; toDate -
Returns:: Encounters from specified date range

getEncounters

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Encounters")
java.util.Collection<Encounter> getEncounters(Location loc,
                                                                                                                               java.util.Date fromDate,
                                                                                                                               java.util.Date toDate)

Deprecated. use getEncounters(Patient, Location, Date, Date, Collection, Collection, boolean)

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

Parameters:: loc - Location; fromDate -; toDate -
Returns:: Encounters from specified location and date range

getEncounterTypes

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Encounter Types")
java.util.List<EncounterType> getEncounterTypes()
                                                                                                                               throws APIException

Deprecated. replaced by getAllEncounterTypes()

Get all encounter types (not retired)

Returns:: A List object of all non-retired EncounterTypes
Throws:: APIException

getLocations

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Locations")
java.util.List<Location> getLocations()
                                                                                                               throws APIException

Deprecated. replaced by LocationService.getAllLocations()

Get all locations

Returns:: location list
Throws:: APIException

getLocation

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Locations")
Location getLocation(java.lang.Integer locationId)
                                                                                              throws APIException

Deprecated. replaced by LocationService.getLocation(Integer)

Get location by internal identifier

Parameters:: locationId -
Returns:: location with given internal identifier
Throws:: APIException

getLocationByName

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Locations")
Location getLocationByName(java.lang.String name)
                                                                                                    throws APIException

Deprecated. replaced by LocationService.getLocation(String)

Get location by name

Parameters:: name - location's name
Returns:: location with given name
Throws:: APIException

findLocations

@Deprecated
 @Transactional(readOnly=true)
 @Authorized(value="View Locations")
java.util.List<Location> findLocations(java.lang.String name)
                                                                                                                throws APIException

Deprecated. replaced by LocationService.getLocations(String)

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

Parameters:: name - location's name
Returns:: list of locations with similar name
Throws:: APIException

getEncountersByPatient
```
@Authorized(value="View Encounters")
java.util.List<Encounter> getEncountersByPatient(java.lang.String query)
                                                                               throws APIException
```
Search for encounters by patient name or patient identifier.

Parameters:

query - patient name or identifier

Returns:

list of encounters for the given patient

Throws:

APIException

Since:

1.7

See Also:

EncounterService}{@link #getEncountersByPatient(String, boolean)}

getEncountersByPatient

@Authorized(value="View Encounters")
java.util.List<Encounter> getEncountersByPatient(java.lang.String query,
                                                                                      boolean includeVoided)
                                                                               throws APIException

Search for encounters by patient name or patient identifier.

Parameters:: query - patient name or identifier; includeVoided - Specifies whether voided encounters should be included
Returns:: list of encounters for the given patient
Throws:: APIException
Since:: 1.7

getEncounters

@Transactional(readOnly=true)
 @Authorized(value="View Encounters")
java.util.List<Encounter> getEncounters(java.lang.String query,
                                                                                                            java.lang.Integer start,
                                                                                                            java.lang.Integer length,
                                                                                                            boolean includeVoided)
                                                                                                     throws APIException

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

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
Since:: 1.8

getEncounters
```
@Authorized(value="View Encounters")
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
```
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

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

Since:

1.10

getAllEncounters
```
@Transactional(readOnly=true)
java.util.Map<java.lang.Integer,java.util.List<Encounter>> getAllEncounters(Cohort patients)
```
Get all encounters for a cohort of patients

Parameters:

patients - Cohort of patients to search

Returns:

Map of all encounters for specified patients.

Since:

1.8

getCountOfEncounters
```
@Transactional(readOnly=true)
 @Authorized(value="View Encounters")
java.lang.Integer getCountOfEncounters(java.lang.String query,
                                                                                                           boolean includeVoided)
```
Return the number of encounters matching a patient name or patient identifier

Parameters:

query - patient name or identifier

includeVoided - Specifies whether voided encounters should be included

Returns:

the number of encounters matching the given search phrase

Since:

1.8

getEncountersByVisit

@Transactional(readOnly=true)
 @Authorized(value="View Encounters")
java.util.List<Encounter> getEncountersByVisit(Visit visit,
                                                                                                                   boolean includeVoided)

Gets all encounters grouped within a given visit.

Parameters:: visit - the visit.; includeVoided - whether voided encounters should be returned
Returns:: list of encounters in the given visit.
Since:: 1.9

getEncounterVisitHandlers
```
@Transactional(readOnly=true)
java.util.List<EncounterVisitHandler> getEncounterVisitHandlers()
```
Returns:

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

Since:

1.9

See Also:

EncounterVisitHandler

getActiveEncounterVisitHandler
```
@Transactional(readOnly=true)
EncounterVisitHandler getActiveEncounterVisitHandler()
                                                                            throws APIException
```
Gets the active handler for assigning visits to encounters.

Returns:

the active handler class.

Throws:

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

Since:

1.9

See Also:

EncounterVisitHandler

saveEncounterRole

@Authorized(value="Manage Encounter Roles")
EncounterRole saveEncounterRole(EncounterRole encounterRole)
                                                                     throws APIException

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

Parameters:: encounterRole - to be saved
Returns:: EncounterRole
Throws:: APIException
Since:: 1.9

getEncounterRole

@Transactional(readOnly=true)
 @Authorized(value="View Encounter Roles")
EncounterRole getEncounterRole(java.lang.Integer encounterRoleId)
                                                                                                 throws APIException

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

Parameters:: encounterRoleId - to be retrieved
Returns:: EncounterRole
Throws:: APIException
Since:: 1.9

purgeEncounterRole
```
@Authorized(value="Purge Encounter Roles")
void purgeEncounterRole(EncounterRole encounterRole)
                                                            throws APIException
```
Completely remove an encounter role from database. For super users only. If dereferencing encounter roles, use retireEncounterRole(org.openmrs.Encounter, java.lang.String)

Parameters:

encounterRole - encounter role object to be purged

Throws:

APIException

Since:

1.9

getAllEncounterRoles

@Transactional(readOnly=true)
 @Authorized(value="Manage Encounter Roles")
java.util.List<EncounterRole> getAllEncounterRoles(boolean includeRetired)

Get all encounter roles based on includeRetired flag

Parameters:: includeRetired -
Returns:: List of all encounter roles
Since:: 1.9

getEncounterRoleByUuid

@Transactional(readOnly=true)
 @Authorized(value="Manage Encounter Roles")
EncounterRole getEncounterRoleByUuid(java.lang.String uuid)
                                                                                                         throws APIException

Get EncounterRole by its UUID

Parameters:: uuid -
Returns:: EncounterRole
Throws:: APIException
Since:: 1.9

retireEncounterRole

@Authorized(value="Manage Encounter Roles")
EncounterRole retireEncounterRole(EncounterRole encounterRole,
                                                                              java.lang.String reason)
                                                                       throws APIException

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

Parameters:: encounterRole - the encounter role to retire; reason - required non-null purpose for retiring this encounter role
Throws:: APIException
Since:: 1.9

unretireEncounterRole

@Authorized(value="Manage Encounter Roles")
EncounterRole unretireEncounterRole(EncounterRole encounterType)
                                                                         throws APIException

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

Parameters:: encounterRole - the encounter role to unretire
Throws:: APIException
Since:: 1.9

getEncountersNotAssignedToAnyVisit

@Transactional(readOnly=true)
 @Authorized(value="View Encounters")
java.util.List<Encounter> getEncountersNotAssignedToAnyVisit(Patient patient)
                                                                                                                          throws APIException

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.

Parameters:: patient - the patient to match against
Returns:: a list of Encounters
Throws:: APIException
Since:: 1.9

getEncountersByVisitsAndPatient

@Transactional(readOnly=true)
 @Authorized(value="View Visits")
java.util.List<Encounter> getEncountersByVisitsAndPatient(Patient patient,
                                                                                                                          boolean includeVoided,
                                                                                                                          java.lang.String query,
                                                                                                                          java.lang.Integer start,
                                                                                                                          java.lang.Integer length)
                                                                                                                   throws APIException

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.

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
Since:: 1.9







getEncountersByVisitsAndPatientCount
@Transactional(readOnly=true)
 @Authorized(value="View Visits")
java.lang.Integer getEncountersByVisitsAndPatientCount(Patient patient,
                                                                                                                       boolean includeVoided,
                                                                                                                       java.lang.String query)
                                                                                                                throws APIException
Returns result count for
 getEncountersByVisitsAndPatient(Patient, boolean, String, Integer, Integer).

Parameters:
patient - 
includeVoided - 
query - 
Returns:
number of results
Throws:
APIException
Since:
1.9








checkIfEncounterTypesAreLocked
void checkIfEncounterTypesAreLocked()
                             throws EncounterTypeLockedException
Check if the encounter types are locked, and if so, throw exception during manipulation of encounter type

Throws:
EncounterTypeLockedException

Interface EncounterService

Method Summary

Methods inherited from interface org.openmrs.api.OpenmrsService

Method Detail

setEncounterDAO

saveEncounter

getEncounter

getEncounterByUuid

getEncountersByPatient

getEncountersByPatientId

getEncountersByPatientIdentifier

getEncounters

getEncounters

getEncounters

voidEncounter

unvoidEncounter

purgeEncounter

purgeEncounter

saveEncounterType

getEncounterType

getEncounterTypeByUuid

getEncounterType

getAllEncounterTypes

getAllEncounterTypes

findEncounterTypes

retireEncounterType

unretireEncounterType

purgeEncounterType

createEncounter

updateEncounter

deleteEncounter

getEncountersByPatientId

getEncountersByPatientIdentifier

getEncounters

getEncounters

getEncounters

getEncounters

getEncounters

getEncounters

getEncounterTypes

getLocations

getLocation

getLocationByName

findLocations

getEncountersByPatient

getEncountersByPatient

getEncounters

getEncounters

getAllEncounters

getCountOfEncounters

getEncountersByVisit

getEncounterVisitHandlers

getActiveEncounterVisitHandler

saveEncounterRole

getEncounterRole

purgeEncounterRole

getAllEncounterRoles

getEncounterRoleByUuid

retireEncounterRole

unretireEncounterRole

getEncountersNotAssignedToAnyVisit

getEncountersByVisitsAndPatient

getEncountersByVisitsAndPatientCount

checkIfEncounterTypesAreLocked