org.openmrs

Class Visit

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsData

org.openmrs.BaseCustomizableData<VisitAttribute>

org.openmrs.Visit

All Implemented Interfaces:

java.io.Serializable, Auditable, Customizable<VisitAttribute>, OpenmrsData, OpenmrsObject, Voidable

public class Visit
extends BaseCustomizableData<VisitAttribute>
implements Auditable, Customizable<VisitAttribute>

A 'visit' is a contiguous time period where encounters occur between patients and healthcare providers. This can function as a grouper for encounters

Since:

1.9

See Also:

Serialized Form

Field Summary

Fields inherited from class org.openmrs.BaseOpenmrsData

creator

Constructor Summary

Constructors

Constructor and Description
Visit() Default Constructor
Visit(java.lang.Integer visitId) Constructor that takes in a visitId
Visit(Patient patient, VisitType visitType, java.util.Date startDatetime) Convenience constructor that takes in the required fields i.e Patient, VisitType and dateStarted

Method Summary

Modifier and Type	Method and Description
void	addEncounter(Encounter encounter) adds an individual encounter to a visit
java.util.Set<Encounter>	getEncounters()
java.lang.Integer	getId()
Concept	getIndication()
Location	getLocation()
Patient	getPatient()
java.util.Date	getStartDatetime()
java.util.Date	getStopDatetime()
java.lang.Integer	getVisitId()
VisitType	getVisitType()
void	setEncounters(java.util.Set<Encounter> encounters)
void	setId(java.lang.Integer id)
void	setIndication(Concept indication)
void	setLocation(Location location)
void	setPatient(Patient patient)
void	setStartDatetime(java.util.Date startDatetime)
void	setStopDatetime(java.util.Date stopDatetime)
void	setVisitId(java.lang.Integer visitId)
void	setVisitType(VisitType visitType)
java.lang.String	toString() Returns a string consisting of the name of the class of which the object is an instance and the uuid field surrounded by [ and ].

Methods inherited from class org.openmrs.BaseCustomizableData

addAttribute, getActiveAttributes, getActiveAttributes, getAttributes, setAttribute, setAttributes

Methods inherited from class org.openmrs.BaseOpenmrsData

getChangedBy, getCreator, getDateChanged, getDateCreated, getDateVoided, getVoided, getVoidedBy, getVoidReason, isVoided, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateVoided, setVoided, setVoidedBy, setVoidReason

Methods inherited from class org.openmrs.BaseOpenmrsObject

equals, getUuid, hashCode, setUuid

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openmrs.Auditable

getChangedBy, getCreator, getDateChanged, getDateCreated, setChangedBy, setCreator, setDateChanged, setDateCreated

Methods inherited from interface org.openmrs.OpenmrsObject

getUuid, setUuid

Methods inherited from interface org.openmrs.customdatatype.Customizable

addAttribute, getActiveAttributes, getActiveAttributes, getAttributes

Constructor Detail

Visit

public Visit()

Default Constructor

Visit

public Visit(java.lang.Integer visitId)

Constructor that takes in a visitId

Parameters:

visitId -

Visit

public Visit(Patient patient,
             VisitType visitType,
             java.util.Date startDatetime)

Convenience constructor that takes in the required fields i.e Patient, VisitType and dateStarted

Parameters:

patient - the patient asscociated to this visit

visitType - The type of visit

startDatetime - the date this visit was started

See Also:

VisitType

Method Detail

getVisitId

public java.lang.Integer getVisitId()

Returns:

the visitId

setVisitId

public void setVisitId(java.lang.Integer visitId)

Parameters:

visitId - the visitId to set

getPatient

public Patient getPatient()

Returns:

the patient

setPatient

public void setPatient(Patient patient)

Parameters:

patient - the patient to set

getVisitType

public VisitType getVisitType()

Returns:

the visitType

setVisitType

public void setVisitType(VisitType visitType)

Parameters:

visitType - the visitType to set

getIndication

public Concept getIndication()

Returns:

the indication

setIndication

public void setIndication(Concept indication)

Parameters:

indication - the indication to set

getLocation

public Location getLocation()

Returns:

the location

setLocation

public void setLocation(Location location)

Parameters:

location - the location to set

getStartDatetime

public java.util.Date getStartDatetime()

Returns:

the startDatetime

setStartDatetime

public void setStartDatetime(java.util.Date startDatetime)

Parameters:

startDatetime - the startDatetime to set

getStopDatetime

public java.util.Date getStopDatetime()

Returns:

the stopDatetime

setStopDatetime

public void setStopDatetime(java.util.Date stopDatetime)

Parameters:

stopDatetime - the stopDatetime to set

getId

public java.lang.Integer getId()

Specified by:

getId in interface OpenmrsObject

Returns:

id - The unique Identifier for the object

See Also:

OpenmrsObject.getId()

setId

public void setId(java.lang.Integer id)

Specified by:

setId in interface OpenmrsObject

Parameters:

id - - The unique Identifier for the object

See Also:

OpenmrsObject.setId(java.lang.Integer)

toString

public java.lang.String toString()

Description copied from class: BaseOpenmrsObject

Returns a string consisting of the name of the class of which the object is an instance and the uuid field surrounded by [ and ]. In other words, this method returns a string equal to the value of:

 getClass().getName() + '[' + uuid + ']'
 

If the uuid field is null, it delegates to Object.toString()

Overrides:

toString in class BaseOpenmrsObject

See Also:

Object.toString()

getEncounters

public java.util.Set<Encounter> getEncounters()

Returns:

the encounters

setEncounters

public void setEncounters(java.util.Set<Encounter> encounters)

Parameters:

encounters - the encounters to set

addEncounter

public void addEncounter(Encounter encounter)

adds an individual encounter to a visit

Parameters:

encounter - the encounter to add

Since:

1.9.2, 1.10.0