org.openmrs

Class Visit

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsData

org.openmrs.BaseChangeableOpenmrsData

org.openmrs.BaseCustomizableData<VisitAttribute>

org.openmrs.Visit

All Implemented Interfaces:

Serializable, Auditable, Changeable, Creatable, Customizable<VisitAttribute>, OpenmrsData, OpenmrsObject, Voidable

@Entity
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(Integer visitId) Constructor that takes in a visitId
Visit(Patient patient, VisitType visitType, 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
Set<Encounter>	getEncounters()
Integer	getId()
Concept	getIndication()
Location	getLocation()
List<Encounter>	getNonVoidedEncounters() Gets a list of non voided encounters
Patient	getPatient()
Date	getStartDatetime()
Date	getStopDatetime()
Integer	getVisitId()
VisitType	getVisitType()
void	setEncounters(Set<Encounter> encounters)
void	setId(Integer id)
void	setIndication(Concept indication)
void	setLocation(Location location)
void	setPatient(Patient patient)
void	setStartDatetime(Date startDatetime)
void	setStopDatetime(Date stopDatetime)
void	setVisitId(Integer visitId)
void	setVisitType(VisitType visitType)
String	toString() Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}

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.Creatable

getCreator, getDateCreated, setCreator, setDateCreated

Methods inherited from interface org.openmrs.Changeable

getChangedBy, getDateChanged, setChangedBy, setDateChanged

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(Integer visitId)

Constructor that takes in a visitId

Parameters:

visitId -

Visit

public Visit(Patient patient,
             VisitType visitType,
             Date startDatetime)

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

Parameters:

patient - the patient associated to this visit

visitType - The type of visit

startDatetime - the date this visit was started

See Also:

VisitType

Method Detail

getVisitId

public Integer getVisitId()

Returns:

the visitId

setVisitId

public void setVisitId(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 Date getStartDatetime()

Returns:

the startDatetime

setStartDatetime

public void setStartDatetime(Date startDatetime)

Parameters:

startDatetime - the startDatetime to set

getStopDatetime

public Date getStopDatetime()

Returns:

the stopDatetime

setStopDatetime

public void setStopDatetime(Date stopDatetime)

Parameters:

stopDatetime - the stopDatetime to set

getId

public Integer getId()

Specified by:

getId in interface OpenmrsObject

Returns:

id - The unique Identifier for the object

See Also:

OpenmrsObject.getId()

setId

public void setId(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 String toString()

Description copied from class: BaseOpenmrsObject

Returns a string equal to the value of:

ClassName{hashCode=..., uuid=...}

If the uuid field is null, it returns:

ClassName{hashCode=...}

Should include hashCode if uuid is null Should include uuid if not null

Overrides:

toString in class BaseOpenmrsObject

See Also:

Object.toString()

getEncounters

public Set<Encounter> getEncounters()

Returns:

the encounters

setEncounters

public void setEncounters(Set<Encounter> encounters)

Parameters:

encounters - the encounters to set

getNonVoidedEncounters

public List<Encounter> getNonVoidedEncounters()

Gets a list of non voided encounters

Returns:

the non voided encounter list

Since:

1.11.0, 1.12.0

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