org.openmrs.api.impl

Class VisitServiceImpl

java.lang.Object

org.openmrs.api.impl.BaseOpenmrsService

org.openmrs.api.impl.VisitServiceImpl

All Implemented Interfaces:

OpenmrsService, VisitService

@Transactional
public class VisitServiceImpl
extends BaseOpenmrsService
implements VisitService

Default implementation of the VisitService. This class should not be used on its own. The current OpenMRS implementation should be fetched from the Context.

Since:

1.9

Constructor Summary

Constructors

Constructor and Description
VisitServiceImpl()

Method Summary

Modifier and Type	Method and Description
Visit	endVisit(Visit visit, Date stopDate) Sets the stopDate of a given visit.
List<Visit>	getActiveVisitsByPatient(Patient patient) Convenience method that delegates to getVisitsByPatient(patient, false, false)
List<VisitAttributeType>	getAllVisitAttributeTypes()
List<Visit>	getAllVisits() Gets all unvoided visits in the database.
List<VisitType>	getAllVisitTypes() Gets all visit types.
List<VisitType>	getAllVisitTypes(boolean includeRetired) Get all visit types based on includeRetired flag
Visit	getVisit(Integer visitId) Gets a visit by its visit id.
VisitAttribute	getVisitAttributeByUuid(String uuid)
VisitAttributeType	getVisitAttributeType(Integer id)
VisitAttributeType	getVisitAttributeTypeByUuid(String uuid)
Visit	getVisitByUuid(String uuid) Gets a visit by its UUID.
VisitDAO	getVisitDAO()
List<Visit>	getVisits(Collection<VisitType> visitTypes, Collection<Patient> patients, Collection<Location> locations, Collection<Concept> indications, Date minStartDatetime, Date maxStartDatetime, Date minEndDatetime, Date maxEndDatetime, Map<VisitAttributeType,Object> attributeValues, boolean includeInactive, boolean includeVoided) Gets the visits matching the specified arguments
List<Visit>	getVisits(VisitSearchCriteria visitSearchCriteria) Gets the visits matching the specified search criteria
List<Visit>	getVisitsByPatient(Patient patient) Gets all unvoided visits for the specified patient
List<Visit>	getVisitsByPatient(Patient patient, boolean includeInactive, boolean includeVoided) Gets all visits for the specified patient
VisitType	getVisitType(Integer visitTypeId) Gets a visit type by its visit type id.
VisitType	getVisitTypeByUuid(String uuid) Gets a visit type by its UUID.
List<VisitType>	getVisitTypes(String fuzzySearchPhrase) Gets all visit types whose names are similar to or contain the given search phrase.
void	purgeVisit(Visit visit) Completely erases a visit from the database.
void	purgeVisitAttributeType(VisitAttributeType visitAttributeType) Completely removes a visit attribute type from the database
void	purgeVisitType(VisitType visitType) Completely removes a visit type from the database.
VisitAttributeType	retireVisitAttributeType(VisitAttributeType visitAttributeType, String reason) Retires the given visit attribute type in the database
VisitType	retireVisitType(VisitType visitType, String reason) Retires a given visit type.
Visit	saveVisit(Visit visit) Creates or updates the given visit in the database.
VisitAttributeType	saveVisitAttributeType(VisitAttributeType visitAttributeType) Creates or updates the given visit attribute type in the database
VisitType	saveVisitType(VisitType visitType) Creates or updates the given visit type in the database.
void	setVisitDAO(VisitDAO dao) Method used to inject the visit data access object.
void	stopVisits(Date maximumStartDate) Stops all active visits started before or on the specified date which match any of the visit types specified by the OpenmrsConstants.GP_VISIT_TYPES_TO_AUTO_CLOSE global property.
VisitAttributeType	unretireVisitAttributeType(VisitAttributeType visitAttributeType) Restores a visit attribute type that was previous retired in the database
VisitType	unretireVisitType(VisitType visitType) Unretires a visit type.
Visit	unvoidVisit(Visit visit) Unvoids the given visit.
Visit	voidVisit(Visit visit, String reason) Voids the given visit.

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

VisitServiceImpl

public VisitServiceImpl()

Method Detail

setVisitDAO

public void setVisitDAO(VisitDAO dao)

Method used to inject the visit data access object.

Parameters:

dao - the visit data access object.

getVisitDAO

public VisitDAO getVisitDAO()

getAllVisitTypes

@Transactional(readOnly=true)
public List<VisitType> getAllVisitTypes()

Description copied from interface: VisitService

Gets all visit types.

Specified by:

getAllVisitTypes in interface VisitService

Returns:

a list of visit type objects. Should get all visit types

See Also:

VisitService.getAllVisitTypes()

getAllVisitTypes

@Transactional(readOnly=true)
public List<VisitType> getAllVisitTypes(boolean includeRetired)

Description copied from interface: VisitService

Get all visit types based on includeRetired flag

Specified by:

getAllVisitTypes in interface VisitService

Returns:

List of all visit types

See Also:

VisitService.getAllVisitTypes(boolean)

getVisitType

@Transactional(readOnly=true)
public VisitType getVisitType(Integer visitTypeId)

Description copied from interface: VisitService

Gets a visit type by its visit type id.

Specified by:

getVisitType in interface VisitService

Parameters:

visitTypeId - the visit type id.

Returns:

the visit type object found with the given id, else null. Should get correct visit type

See Also:

VisitService.getVisitType(java.lang.Integer)

getVisitTypeByUuid

@Transactional(readOnly=true)
public VisitType getVisitTypeByUuid(String uuid)

Description copied from interface: VisitService

Gets a visit type by its UUID.

Specified by:

getVisitTypeByUuid in interface VisitService

Parameters:

uuid - the visit type UUID.

Returns:

the visit type object found with the given uuid, else null. Should get correct visit type

See Also:

VisitService.getVisitTypeByUuid(java.lang.String)

getVisitTypes

@Transactional(readOnly=true)
public List<VisitType> getVisitTypes(String fuzzySearchPhrase)

Description copied from interface: VisitService

Gets all visit types whose names are similar to or contain the given search phrase.

Specified by:

getVisitTypes in interface VisitService

Parameters:

fuzzySearchPhrase - the search phrase to use.

Returns:

a list of all visit types with names similar to or containing the given phrase Should get correct visit types

See Also:

VisitService.getVisitTypes(java.lang.String)

saveVisitType

public VisitType saveVisitType(VisitType visitType)
                        throws APIException

Description copied from interface: VisitService

Creates or updates the given visit type in the database.

Specified by:

saveVisitType in interface VisitService

Parameters:

visitType - the visit type to create or update.

Returns:

the created or updated visit type. Should save new visit type Should save edited visit type Should throw error when name is null Should throw error when name is empty string

Throws:

APIException

See Also:

VisitService.saveVisitType(org.openmrs.VisitType)

retireVisitType

public VisitType retireVisitType(VisitType visitType,
                                 String reason)

Description copied from interface: VisitService

Retires a given visit type.

Specified by:

retireVisitType in interface VisitService

Parameters:

visitType - the visit type to retire.

reason - the reason why the visit type is retired.

Returns:

the visit type that has been retired. Should retire given visit type

See Also:

VisitService.retireVisitType(org.openmrs.VisitType, java.lang.String)

unretireVisitType

public VisitType unretireVisitType(VisitType visitType)

Description copied from interface: VisitService

Unretires a visit type.

Specified by:

unretireVisitType in interface VisitService

Parameters:

visitType - the visit type to unretire.

Returns:

the unretired visit type Should unretire given visit type

See Also:

VisitService.unretireVisitType(org.openmrs.VisitType)

purgeVisitType

public void purgeVisitType(VisitType visitType)

Description copied from interface: VisitService

Completely removes a visit type from the database. This is not reversible.

Specified by:

purgeVisitType in interface VisitService

Parameters:

visitType - the visit type to delete from the database. Should delete given visit type

See Also:

VisitService.purgeVisitType(org.openmrs.VisitType)

getAllVisits

@Transactional(readOnly=true)
public List<Visit> getAllVisits()
                                                       throws APIException

Description copied from interface: VisitService

Gets all unvoided visits in the database.

Specified by:

getAllVisits in interface VisitService

Returns:

a list of visit objects.

Throws:

APIException - Should return all unvoided visits

See Also:

VisitService.getAllVisits()

getVisit

@Transactional(readOnly=true)
public Visit getVisit(Integer visitId)
                                             throws APIException

Description copied from interface: VisitService

Gets a visit by its visit id.

Specified by:

getVisit in interface VisitService

Parameters:

visitId - the visit id.

Returns:

the visit object found with the given id, else null.

Throws:

APIException

See Also:

VisitService.getVisit(java.lang.Integer)

getVisitByUuid

@Transactional(readOnly=true)
public Visit getVisitByUuid(String uuid)
                                                   throws APIException

Description copied from interface: VisitService

Gets a visit by its UUID.

Specified by:

getVisitByUuid in interface VisitService

Parameters:

uuid - the visit UUID.

Returns:

the visit object found with the given uuid, else null.

Throws:

APIException - Should return a visit matching the specified uuid

See Also:

VisitService.getVisitByUuid(java.lang.String)

saveVisit

public Visit saveVisit(Visit visit)
                throws APIException

Description copied from interface: VisitService

Creates or updates the given visit in the database.

Specified by:

saveVisit in interface VisitService

Parameters:

visit - the visit to create or update.

Returns:

the created or updated visit.

Throws:

APIException - Should add a new visit to the database Should update an existing visit in the database Should fail if validation errors are found Should pass if no validation errors are found Should be able to add an attribute to a visit Should void an attribute if max occurs is 1 and same attribute type already exists Should save a visit though changedBy and dateCreated are not set for VisitAttribute explicitly Should should save new visit with encounters successfully

See Also:

VisitService.saveVisit(org.openmrs.Visit)

endVisit

public Visit endVisit(Visit visit,
                      Date stopDate)

Description copied from interface: VisitService

Sets the stopDate of a given visit.

Specified by:

endVisit in interface VisitService

Parameters:

visit - the visit whose stopDate is to be set

stopDate - the date and time the visit is ending. if null, current date is used

Returns:

the visit that was ended Should set the stopDateTime of visit Should set stopdatetime as current date if stopdate is null Should not fail if no validation errors are found Should fail if validation errors are found

See Also:

VisitService.endVisit(org.openmrs.Visit, java.util.Date)

voidVisit

public Visit voidVisit(Visit visit,
                       String reason)
                throws APIException

Description copied from interface: VisitService

Voids the given visit.

Specified by:

voidVisit in interface VisitService

Parameters:

visit - the visit to void.

reason - the reason why the visit is voided

Returns:

the visit that has been voided

Throws:

APIException - Should void the visit and set the voidReason Should void encounters with visit

See Also:

VisitService.voidVisit(org.openmrs.Visit, java.lang.String)

unvoidVisit

public Visit unvoidVisit(Visit visit)
                  throws APIException

Description copied from interface: VisitService

Unvoids the given visit.

Specified by:

unvoidVisit in interface VisitService

Parameters:

visit - the visit to unvoid

Returns:

the unvoided visit

Throws:

APIException - Should unvoid the visit and unset all the void related fields Should unvoid encounters voided with visit

See Also:

VisitService.unvoidVisit(org.openmrs.Visit)

purgeVisit

public void purgeVisit(Visit visit)
                throws APIException

Description copied from interface: VisitService

Completely erases a visit from the database. This is not reversible.

Specified by:

purgeVisit in interface VisitService

Parameters:

visit - the visit to delete from the database.

Throws:

APIException - Should erase the visit from the database Should fail if the visit has encounters associated to it

See Also:

VisitService.purgeVisit(org.openmrs.Visit)

getVisits

@Transactional(readOnly=true)
public List<Visit> getVisits(Collection<VisitType> visitTypes,
                                                           Collection<Patient> patients,
                                                           Collection<Location> locations,
                                                           Collection<Concept> indications,
                                                           Date minStartDatetime,
                                                           Date maxStartDatetime,
                                                           Date minEndDatetime,
                                                           Date maxEndDatetime,
                                                           Map<VisitAttributeType,Object> attributeValues,
                                                           boolean includeInactive,
                                                           boolean includeVoided)
                                                    throws APIException

Description copied from interface: VisitService

Gets the visits matching the specified arguments

Specified by:

getVisits in interface VisitService

Parameters:

visitTypes - a list of visit types to match against

locations - a list of locations to match against

indications - a list of indication concepts to match against

minStartDatetime - the minimum visit start date to match against

maxStartDatetime - the maximum visit start date to match against

minEndDatetime - the minimum visit end date to match against

maxEndDatetime - the maximum visit end date to match against

includeInactive - if false, the min/maxEndDatetime parameters are ignored and only open visits are returned

includeVoided - specifies if voided visits should also be returned

Returns:

a list of visits

Throws:

APIException - Should get visits by visit type Should get visits by patients Should get visits by locations Should get visits by indications Should get visits started between the given start dates Should get visits ended between the given end dates Should get visits that are still open even if minStartDatetime is specified Should return all visits if includeVoided is set to true Should get all visits with given attribute values Should not find any visits if none have given attribute values

See Also:

VisitService.getVisits(Collection, Collection, Collection, Collection, Date, Date, Date, Date, Map, boolean, boolean)

getVisits

public List<Visit> getVisits(VisitSearchCriteria visitSearchCriteria)
                      throws APIException

Description copied from interface: VisitService

Gets the visits matching the specified search criteria

Specified by:

getVisits in interface VisitService

Returns:

Throws:

APIException

See Also:

VisitService.getVisits(VisitSearchCriteria)

getVisitsByPatient

@Transactional(readOnly=true)
public List<Visit> getVisitsByPatient(Patient patient)
                                                             throws APIException

Description copied from interface: VisitService

Gets all unvoided visits for the specified patient

Specified by:

getVisitsByPatient in interface VisitService

Parameters:

patient - the patient whose visits to get

Returns:

a list of visits

Throws:

APIException - Should return all unvoided visits for the specified patient

See Also:

VisitService.getVisitsByPatient(org.openmrs.Patient)

getActiveVisitsByPatient

@Transactional(readOnly=true)
public List<Visit> getActiveVisitsByPatient(Patient patient)
                                                                   throws APIException

Description copied from interface: VisitService

Convenience method that delegates to getVisitsByPatient(patient, false, false)

Specified by:

getActiveVisitsByPatient in interface VisitService

Parameters:

patient - the patient whose visits to get

Returns:

a list of visits

Throws:

APIException

See Also:

VisitService.getActiveVisitsByPatient(org.openmrs.Patient)

getVisitsByPatient

@Transactional(readOnly=true)
public List<Visit> getVisitsByPatient(Patient patient,
                                                                    boolean includeInactive,
                                                                    boolean includeVoided)
                                                             throws APIException

Description copied from interface: VisitService

Gets all visits for the specified patient

Specified by:

getVisitsByPatient in interface VisitService

Parameters:

patient - the patient whose visits to get

Returns:

a list of visits

Throws:

APIException - Should return all active unvoided visits for the specified patient Should return all unvoided visits for the specified patient Should return all active visits for the specified patient

See Also:

VisitService.getVisitsByPatient(org.openmrs.Patient, boolean, boolean)

getAllVisitAttributeTypes

@Transactional(readOnly=true)
public List<VisitAttributeType> getAllVisitAttributeTypes()

Specified by:

getAllVisitAttributeTypes in interface VisitService

Returns:

all VisitAttributeTypes Should return all visit attribute types including retired ones

See Also:

VisitService.getAllVisitAttributeTypes()

getVisitAttributeType

@Transactional(readOnly=true)
public VisitAttributeType getVisitAttributeType(Integer id)

Specified by:

getVisitAttributeType in interface VisitService

Returns:

the VisitAttributeType with the given internal id Should return the visit attribute type with the given id Should return null if no visit attribute type exists with the given id

See Also:

VisitService.getVisitAttributeType(java.lang.Integer)

getVisitAttributeTypeByUuid

@Transactional(readOnly=true)
public VisitAttributeType getVisitAttributeTypeByUuid(String uuid)

Specified by:

getVisitAttributeTypeByUuid in interface VisitService

Returns:

the VisitAttributeType with the given uuid Should return the visit attribute type with the given uuid Should return null if no visit attribute type exists with the given uuid

See Also:

VisitService.getVisitAttributeTypeByUuid(java.lang.String)

saveVisitAttributeType

public VisitAttributeType saveVisitAttributeType(VisitAttributeType visitAttributeType)

Description copied from interface: VisitService

Creates or updates the given visit attribute type in the database

Specified by:

saveVisitAttributeType in interface VisitService

Returns:

the VisitAttributeType created/saved Should create a new visit attribute type Should edit an existing visit attribute type

See Also:

VisitService.saveVisitAttributeType(org.openmrs.VisitAttributeType)

retireVisitAttributeType

public VisitAttributeType retireVisitAttributeType(VisitAttributeType visitAttributeType,
                                                   String reason)

Description copied from interface: VisitService

Retires the given visit attribute type in the database

Specified by:

retireVisitAttributeType in interface VisitService

Returns:

the visitAttribute retired Should retire a visit attribute type

See Also:

VisitService.retireVisitAttributeType(org.openmrs.VisitAttributeType, java.lang.String)

unretireVisitAttributeType

public VisitAttributeType unretireVisitAttributeType(VisitAttributeType visitAttributeType)

Description copied from interface: VisitService

Restores a visit attribute type that was previous retired in the database

Specified by:

unretireVisitAttributeType in interface VisitService

Returns:

the VisitAttributeType unretired Should unretire a retired visit attribute type

See Also:

VisitService.unretireVisitAttributeType(org.openmrs.VisitAttributeType)

purgeVisitAttributeType

public void purgeVisitAttributeType(VisitAttributeType visitAttributeType)

Description copied from interface: VisitService

Completely removes a visit attribute type from the database

Specified by:

purgeVisitAttributeType in interface VisitService

Parameters:

visitAttributeType - Should completely remove a visit attribute type

See Also:

VisitService.purgeVisitAttributeType(org.openmrs.VisitAttributeType)

getVisitAttributeByUuid

@Transactional(readOnly=true)
public VisitAttribute getVisitAttributeByUuid(String uuid)

Specified by:

getVisitAttributeByUuid in interface VisitService

Returns:

the VisitAttribute with the given uuid Should get the visit attribute with the given uuid Should return null if no visit attribute has the given uuid

See Also:

VisitService.getVisitAttributeByUuid(java.lang.String)

stopVisits

public void stopVisits(Date maximumStartDate)

Description copied from interface: VisitService

Stops all active visits started before or on the specified date which match any of the visit types specified by the OpenmrsConstants.GP_VISIT_TYPES_TO_AUTO_CLOSE global property. If startDatetime is null, the default will be end of the current day.

Specified by:

stopVisits in interface VisitService

Parameters:

maximumStartDate - Visits started on or before this date time value will get stopped Should close all unvoided active visit matching the specified visit types

See Also:

VisitService.stopVisits(Date)