org.openmrs.api

Interface VisitService

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

VisitServiceImpl

public interface VisitService
extends OpenmrsService

This service contains methods relating to visits.

Since:

1.9

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.
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	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 interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Method Detail

getAllVisitTypes

@Authorized(value="Get Visit Types")
List<VisitType> getAllVisitTypes()

Gets all visit types.

Returns:

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

getAllVisitTypes

@Authorized(value="Manage Visit Types")
List<VisitType> getAllVisitTypes(boolean includeRetired)

Get all visit types based on includeRetired flag

Parameters:

includeRetired -

Returns:

List of all visit types

Since:

1.9 Should get all visit types based on include retired flag.

getVisitType

@Authorized(value="Get Visit Types")
VisitType getVisitType(Integer visitTypeId)

Gets a visit type by its visit type id.

Parameters:

visitTypeId - the visit type id.

Returns:

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

getVisitTypeByUuid

@Authorized(value="Get Visit Types")
VisitType getVisitTypeByUuid(String uuid)

Gets a visit type by its UUID.

Parameters:

uuid - the visit type UUID.

Returns:

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

getVisitTypes

@Authorized(value="Get Visit Types")
List<VisitType> getVisitTypes(String fuzzySearchPhrase)

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

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

saveVisitType

@Authorized(value="Manage Visit Types")
VisitType saveVisitType(VisitType visitType)
                                                         throws APIException

Creates or updates the given visit type in the database.

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

retireVisitType

@Authorized(value="Manage Visit Types")
VisitType retireVisitType(VisitType visitType,
                                                                  String reason)

Retires a given visit type.

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

unretireVisitType

@Authorized(value="Manage Visit Types")
VisitType unretireVisitType(VisitType visitType)

Unretires a visit type.

Parameters:

visitType - the visit type to unretire.

Returns:

the unretired visit type Should unretire given visit type

purgeVisitType

@Authorized(value="Manage Visit Types")
void purgeVisitType(VisitType visitType)

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

Parameters:

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

getAllVisits

@Authorized(value="Get Visits")
List<Visit> getAllVisits()
                                                  throws APIException

Gets all unvoided visits in the database.

Returns:

a list of visit objects.

Throws:

APIException - Should return all unvoided visits

getVisit

@Authorized(value="Get Visits")
Visit getVisit(Integer visitId)
                                        throws APIException

Gets a visit by its visit id.

Parameters:

visitId - the visit id.

Returns:

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

Throws:

APIException

getVisitByUuid

@Authorized(value="Get Visits")
Visit getVisitByUuid(String uuid)
                                              throws APIException

Gets a visit by its UUID.

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

saveVisit

@Authorized(value={"Add Visits","Edit Visits"})
Visit saveVisit(Visit visit)
                                                         throws APIException

Creates or updates the given visit in the database.

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

endVisit

@Authorized(value="Edit Visits")
Visit endVisit(Visit visit,
                                                Date stopDate)
                                         throws APIException

Sets the stopDate of a given visit.

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

Throws:

APIException

voidVisit

@Authorized(value="Delete Visits")
Visit voidVisit(Visit visit,
                                                   String reason)
                                            throws APIException

Voids the given visit.

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

unvoidVisit

@Authorized(value="Delete Visits")
Visit unvoidVisit(Visit visit)
                                              throws APIException

Unvoids the given visit.

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

purgeVisit

@Authorized(value="Purge Visits")
void purgeVisit(Visit visit)
                                           throws APIException

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

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

getVisits

@Authorized(value="Get Visits")
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

Gets the visits matching the specified arguments

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:

getActiveVisitsByPatient(Patient)

getVisits

@Authorized(value="Get Visits")
List<Visit> getVisits(VisitSearchCriteria visitSearchCriteria)
                                               throws APIException

Gets the visits matching the specified search criteria

Parameters:

visitSearchCriteria -

Returns:

Throws:

APIException

Since:

2.6.8, 2.7.0

getVisitsByPatient

@Authorized(value="Get Visits")
List<Visit> getVisitsByPatient(Patient patient)
                                                        throws APIException

Gets all unvoided visits for the specified patient

Parameters:

patient - the patient whose visits to get

Returns:

a list of visits

Throws:

APIException - Should return all unvoided visits for the specified patient

getActiveVisitsByPatient

@Authorized(value="Get Visits")
List<Visit> getActiveVisitsByPatient(Patient patient)
                                                              throws APIException

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

Parameters:

patient - the patient whose visits to get

Returns:

a list of visits

Throws:

APIException

getVisitsByPatient

@Authorized(value="Get Visits")
List<Visit> getVisitsByPatient(Patient patient,
                                                               boolean includeInactive,
                                                               boolean includeVoided)
                                                        throws APIException

Gets all visits for the specified patient

Parameters:

patient - the patient whose visits to get

includeInactive -

includeVoided -

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

getAllVisitAttributeTypes

@Authorized(value="Get Visit Attribute Types")
List<VisitAttributeType> getAllVisitAttributeTypes()

Returns:

all VisitAttributeTypes Should return all visit attribute types including retired ones

getVisitAttributeType

@Authorized(value="Get Visit Attribute Types")
VisitAttributeType getVisitAttributeType(Integer id)

Parameters:

id -

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

getVisitAttributeTypeByUuid

@Authorized(value="Get Visit Attribute Types")
VisitAttributeType getVisitAttributeTypeByUuid(String uuid)

Parameters:

uuid -

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

saveVisitAttributeType

@Authorized(value="Manage Visit Attribute Types")
VisitAttributeType saveVisitAttributeType(VisitAttributeType visitAttributeType)

Creates or updates the given visit attribute type in the database

Parameters:

visitAttributeType -

Returns:

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

retireVisitAttributeType

@Authorized(value="Manage Visit Attribute Types")
VisitAttributeType retireVisitAttributeType(VisitAttributeType visitAttributeType,
                                                                                              String reason)

Retires the given visit attribute type in the database

Parameters:

visitAttributeType -

Returns:

the visitAttribute retired Should retire a visit attribute type

unretireVisitAttributeType

@Authorized(value="Manage Visit Attribute Types")
VisitAttributeType unretireVisitAttributeType(VisitAttributeType visitAttributeType)

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

Parameters:

visitAttributeType -

Returns:

the VisitAttributeType unretired Should unretire a retired visit attribute type

purgeVisitAttributeType

@Authorized(value="Purge Visit Attribute Types")
void purgeVisitAttributeType(VisitAttributeType visitAttributeType)

Completely removes a visit attribute type from the database

Parameters:

visitAttributeType - Should completely remove a visit attribute type

getVisitAttributeByUuid

@Authorized(value="Get Visits")
VisitAttribute getVisitAttributeByUuid(String uuid)

Parameters:

uuid -

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

stopVisits

@Authorized(value="Edit Visits")
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. If startDatetime is null, the default will be end of the current day.

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