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, java.util.Date stopDate) Sets the stopDate of a given visit.
java.util.List<Visit>	getActiveVisitsByPatient(Patient patient) Convenience method that delegates to getVisitsByPatient(patient, false, false)
java.util.List<VisitAttributeType>	getAllVisitAttributeTypes()
java.util.List<Visit>	getAllVisits() Gets all unvoided visits in the database.
java.util.List<VisitType>	getAllVisitTypes() Gets all visit types.
Visit	getVisit(java.lang.Integer visitId) Gets a visit by its visit id.
VisitAttribute	getVisitAttributeByUuid(java.lang.String uuid)
VisitAttributeType	getVisitAttributeType(java.lang.Integer id)
VisitAttributeType	getVisitAttributeTypeByUuid(java.lang.String uuid)
Visit	getVisitByUuid(java.lang.String uuid) Gets a visit by its UUID.
java.util.List<Visit>	getVisits(java.util.Collection<VisitType> visitTypes, java.util.Collection<Patient> patients, java.util.Collection<Location> locations, java.util.Collection<Concept> indications, java.util.Date minStartDatetime, java.util.Date maxStartDatetime, java.util.Date minEndDatetime, java.util.Date maxEndDatetime, java.util.Map<VisitAttributeType,java.lang.Object> attributeValues, boolean includeInactive, boolean includeVoided) Gets the visits matching the specified arguments
java.util.List<Visit>	getVisitsByPatient(Patient patient) Gets all unvoided visits for the specified patient
java.util.List<Visit>	getVisitsByPatient(Patient patient, boolean includeInactive, boolean includeVoided) Gets all visits for the specified patient
VisitType	getVisitType(java.lang.Integer visitTypeId) Gets a visit type by its visit type id.
VisitType	getVisitTypeByUuid(java.lang.String uuid) Gets a visit type by its UUID.
java.util.List<VisitType>	getVisitTypes(java.lang.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, java.lang.String reason) Retires the given visit attribute type in the database
VisitType	retireVisitType(VisitType visitType, java.lang.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(java.util.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, java.lang.String reason) Voids the given visit.

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Method Detail

getAllVisitTypes

@Authorized(value="View Visit Types")
java.util.List<VisitType> getAllVisitTypes()

Gets all visit types.

Returns:

a list of visit type objects.

getVisitType

@Authorized(value="View Visit Types")
VisitType getVisitType(java.lang.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.

getVisitTypeByUuid

@Authorized(value="View Visit Types")
VisitType getVisitTypeByUuid(java.lang.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.

getVisitTypes

@Authorized(value="View Visit Types")
java.util.List<VisitType> getVisitTypes(java.lang.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

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.

Throws:

APIException

retireVisitType

@Authorized(value="Manage Visit Types")
VisitType retireVisitType(VisitType visitType,
                                                                  java.lang.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.

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

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.

getAllVisits

@Authorized(value="View Visits")
java.util.List<Visit> getAllVisits()
                                                             throws APIException

Gets all unvoided visits in the database.

Returns:

a list of visit objects.

Throws:

APIException

getVisit

@Authorized(value="View Visits")
Visit getVisit(java.lang.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="View Visits")
Visit getVisitByUuid(java.lang.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

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

endVisit

@Authorized(value="Edit Visits")
Visit endVisit(Visit visit,
                                                java.util.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

Throws:

APIException

voidVisit

@Authorized(value="Delete Visits")
Visit voidVisit(Visit visit,
                                                   java.lang.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

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

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

getVisits

@Authorized(value="View Visits")
java.util.List<Visit> getVisits(java.util.Collection<VisitType> visitTypes,
                                                                 java.util.Collection<Patient> patients,
                                                                 java.util.Collection<Location> locations,
                                                                 java.util.Collection<Concept> indications,
                                                                 java.util.Date minStartDatetime,
                                                                 java.util.Date maxStartDatetime,
                                                                 java.util.Date minEndDatetime,
                                                                 java.util.Date maxEndDatetime,
                                                                 java.util.Map<VisitAttributeType,java.lang.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

See Also:

getActiveVisitsByPatient(Patient)

getVisitsByPatient

@Authorized(value="View Visits")
java.util.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

getActiveVisitsByPatient

@Authorized(value="View Visits")
java.util.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="View Visits")
java.util.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

getAllVisitAttributeTypes

@Authorized(value="View Visit Attribute Types")
java.util.List<VisitAttributeType> getAllVisitAttributeTypes()

Returns:

all VisitAttributeTypes

getVisitAttributeType

@Authorized(value="View Visit Attribute Types")
VisitAttributeType getVisitAttributeType(java.lang.Integer id)

Parameters:

id -

Returns:

the VisitAttributeType with the given internal id

getVisitAttributeTypeByUuid

@Authorized(value="View Visit Attribute Types")
VisitAttributeType getVisitAttributeTypeByUuid(java.lang.String uuid)

Parameters:

uuid -

Returns:

the VisitAttributeType 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

retireVisitAttributeType

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

Retires the given visit attribute type in the database

Parameters:

visitAttributeType -

Returns:

the visitAttribute retired

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

purgeVisitAttributeType

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

Completely removes a visit attribute type from the database

Parameters:

visitAttributeType -

getVisitAttributeByUuid

@Authorized(value="View Visits")
VisitAttribute getVisitAttributeByUuid(java.lang.String uuid)

Parameters:

uuid -

Returns:

the VisitAttribute with the given uuid

stopVisits

@Authorized(value="Edit Visits")
void stopVisits(java.util.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