org.openmrs.api.db

Interface EncounterDAO

All Known Implementing Classes:

HibernateEncounterDAO

public interface EncounterDAO

Encounter-related database functions

Method Summary

Modifier and Type	Method and Description
void	deleteEncounter(Encounter encounter) Purge an encounter from database.
void	deleteEncounterRole(EncounterRole encounterRole) Purge an encounter role from database.
void	deleteEncounterType(EncounterType encounterType) Purge encounter type from database.
List<EncounterType>	findEncounterTypes(String name) Find Encounter Types matching the given name.
List<EncounterRole>	getAllEncounterRoles(boolean includeRetired) Get all encounter roles and optionally specify whether to include retired encountered roles
Map<Integer,List<Encounter>>	getAllEncounters(Cohort patients)
List<EncounterType>	getAllEncounterTypes(Boolean includeVoided) Get all encounter types
Long	getCountOfEncounters(String query, Integer patientId, boolean includeVoided) Return the number of encounters matching a patient name or patient identifier
Encounter	getEncounter(Integer encounterId) Get encounter by internal identifier
Encounter	getEncounterByUuid(String uuid) Find Encounter matching a uuid
EncounterRole	getEncounterRole(Integer encounterRoleId) Get encounter role by internal identifier
EncounterRole	getEncounterRoleByName(String name)
EncounterRole	getEncounterRoleByUuid(String uuid) Find EncounterRole matching a uuid
List<EncounterRole>	getEncounterRolesByName(String name) Get encounter roles by name
List<Encounter>	getEncounters(EncounterSearchCriteria encounterSearchCriteria)
List<Encounter>	getEncounters(String query, Integer patientId, Integer start, Integer length, boolean includeVoided) Get a list of Encounter by Patient name or identifier based on batch settings
List<Encounter>	getEncountersByPatientId(Integer patientId)
List<Encounter>	getEncountersByVisit(Visit visit, boolean includeVoided)
List<Encounter>	getEncountersByVisitsAndPatient(Patient patient, boolean includeVoided, String query, Integer start, Integer length)
Integer	getEncountersByVisitsAndPatientCount(Patient patient, boolean includeVoided, String query)
List<Encounter>	getEncountersNotAssignedToAnyVisit(Patient patient)
EncounterType	getEncounterType(Integer encounterTypeId) Get encounterType by internal identifier
EncounterType	getEncounterType(String name) Get encounterType by name
EncounterType	getEncounterTypeByUuid(String uuid) Find EncounterType matching a uuid
Date	getSavedEncounterDatetime(Encounter encounter) Gets the value of encounterDatetime currently saved in the database for the given encounter, bypassing any caches.
Location	getSavedEncounterLocation(Encounter encounter) Gets the location of the encounter
Encounter	saveEncounter(Encounter encounter) Saves an encounter
EncounterRole	saveEncounterRole(EncounterRole encounterRole) Saves an encounter role
EncounterType	saveEncounterType(EncounterType encounterType) Save an Encounter Type

Method Detail

saveEncounter

Encounter saveEncounter(Encounter encounter)
                 throws DAOException

Saves an encounter

Parameters:

encounter - to be saved

Throws:

DAOException

deleteEncounter

void deleteEncounter(Encounter encounter)
              throws DAOException

Purge an encounter from database.

Parameters:

encounter - encounter object to be purged

Throws:

DAOException

getEncounter

Encounter getEncounter(Integer encounterId)
                throws DAOException

Get encounter by internal identifier

Parameters:

encounterId - encounter id

Returns:

encounter with given internal identifier

Throws:

DAOException

getEncountersByPatientId

List<Encounter> getEncountersByPatientId(Integer patientId)
                                  throws DAOException

Parameters:

patientId -

Returns:

all encounters for the given patient identifier

Throws:

DAOException

getEncounters

List<Encounter> getEncounters(EncounterSearchCriteria encounterSearchCriteria)

See Also:

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

saveEncounterType

EncounterType saveEncounterType(EncounterType encounterType)

Save an Encounter Type

Parameters:

encounterType -

deleteEncounterType

void deleteEncounterType(EncounterType encounterType)
                  throws DAOException

Purge encounter type from database.

Parameters:

encounterType -

Throws:

DAOException

getEncounterType

EncounterType getEncounterType(Integer encounterTypeId)
                        throws DAOException

Get encounterType by internal identifier

Parameters:

encounterTypeId - Internal Integer identifier for an EncounterType

Returns:

EncounterType with given internal identifier

Throws:

DAOException

getEncounterType

EncounterType getEncounterType(String name)
                        throws DAOException

Get encounterType by name

Parameters:

name - String representation of an encounterType

Returns:

EncounterType

Throws:

DAOException

getAllEncounterTypes

List<EncounterType> getAllEncounterTypes(Boolean includeVoided)
                                  throws DAOException

Get all encounter types

Returns:

encounter types list

Throws:

DAOException

findEncounterTypes

List<EncounterType> findEncounterTypes(String name)
                                throws DAOException

Find Encounter Types matching the given name. Search string is case insensitive, so that "NaMe".equals("name") is true.

Parameters:

name -

Returns:

all EncounterTypes that match

Throws:

DAOException

getSavedEncounterDatetime

Date getSavedEncounterDatetime(Encounter encounter)

Gets the value of encounterDatetime currently saved in the database for the given encounter, bypassing any caches. This is used prior to saving an encounter so that we can change the obs if need be

Parameters:

encounter - the Encounter go the the encounterDatetime of

Returns:

the encounterDatetime currently in the database for this encounter Should get saved encounter datetime from database

getEncounterByUuid

Encounter getEncounterByUuid(String uuid)

Find Encounter matching a uuid

Parameters:

uuid -

Returns:

Encounter

getEncounterTypeByUuid

EncounterType getEncounterTypeByUuid(String uuid)

Find EncounterType matching a uuid

Parameters:

uuid -

Returns:

EncounterType

getEncounters

List<Encounter> getEncounters(String query,
                              Integer patientId,
                              Integer start,
                              Integer length,
                              boolean includeVoided)

Get a list of Encounter by Patient name or identifier based on batch settings

Parameters:

query - patient name or identifier

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 Encounter based on batch settings

See Also:

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

getSavedEncounterLocation

Location getSavedEncounterLocation(Encounter encounter)

Gets the location of the encounter

Parameters:

encounter - to be retrieved from the database

Returns:

Location

getAllEncounters

Map<Integer,List<Encounter>> getAllEncounters(Cohort patients)

See Also:

EncounterService.getAllEncounters(Cohort)

getCountOfEncounters

Long getCountOfEncounters(String query,
                          Integer patientId,
                          boolean includeVoided)

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

Parameters:

query - patient name or identifier

patientId - the patient id

includeVoided - Specifies whether voided encounters should be included

Returns:

the number of encounters matching the given search phrase

See Also:

EncounterService.getCountOfEncounters(String, boolean)

getEncountersByVisit

List<Encounter> getEncountersByVisit(Visit visit,
                                     boolean includeVoided)

See Also:

EncounterService.getEncountersByVisit(Visit, boolean)

saveEncounterRole

EncounterRole saveEncounterRole(EncounterRole encounterRole)
                         throws DAOException

Saves an encounter role

Parameters:

encounterRole - role to be saved

Throws:

DAOException

deleteEncounterRole

void deleteEncounterRole(EncounterRole encounterRole)
                  throws DAOException

Purge an encounter role from database.

Parameters:

encounterRole - encounter role object to be purged

Throws:

DAOException

getEncounterRole

EncounterRole getEncounterRole(Integer encounterRoleId)
                        throws DAOException

Get encounter role by internal identifier

Parameters:

encounterRoleId - encounter role id

Returns:

encounter role with given internal identifier

Throws:

DAOException

getEncounterRoleByUuid

EncounterRole getEncounterRoleByUuid(String uuid)

Find EncounterRole matching a uuid

Parameters:

uuid -

Returns:

EncounterRole

getAllEncounterRoles

List<EncounterRole> getAllEncounterRoles(boolean includeRetired)
                                  throws DAOException

Get all encounter roles and optionally specify whether to include retired encountered roles

Parameters:

includeRetired - include retired

Returns:

enconter roles

Throws:

DAOException

See Also:

EncounterService.getAllEncounterRoles(boolean)

getEncounterRoleByName

EncounterRole getEncounterRoleByName(String name)
                              throws DAOException

Throws:

DAOException

See Also:

EncounterService.getEncounterRoleByName(String name)

getEncountersNotAssignedToAnyVisit

List<Encounter> getEncountersNotAssignedToAnyVisit(Patient patient)
                                            throws DAOException

Throws:

DAOException

See Also:

EncounterService.getEncountersNotAssignedToAnyVisit(Patient)

getEncountersByVisitsAndPatient

List<Encounter> getEncountersByVisitsAndPatient(Patient patient,
                                                boolean includeVoided,
                                                String query,
                                                Integer start,
                                                Integer length)

See Also:

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

getEncountersByVisitsAndPatientCount

Integer getEncountersByVisitsAndPatientCount(Patient patient,
                                             boolean includeVoided,
                                             String query)

See Also:

EncounterService.getEncountersByVisitsAndPatientCount(Patient, boolean, String)

getEncounterRolesByName

List<EncounterRole> getEncounterRolesByName(String name)
                                     throws DAOException

Get encounter roles by name

Parameters:

name - encounter role name

Returns:

encounter roles

Throws:

DAOException

See Also:

EncounterService.getEncounterRolesByName(String name)