Encounter (OpenMRS 1.8.5-SNAPSHOT API)

java.lang.Object
- org.openmrs.BaseOpenmrsObject
- - org.openmrs.BaseOpenmrsData
  - - org.openmrs.Encounter

All Implemented Interfaces:

Serializable, Auditable, OpenmrsData, OpenmrsObject, Voidable
```
public class Encounter
extends BaseOpenmrsData
implements Serializable
```
An Encounter represents one visit or interaction of a patient with a healthcare worker. Every encounter can have 0 to n Observations associated with it Every encounter can have 0 to n Orders associated with it The patientId attribute should be equal to patient.patientId and is only included this second time for performance increases on bulk calls.

See Also:

Obs, Order, Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static long serialVersionUID
- Fields inherited from class org.openmrs.BaseOpenmrsData
  creator

Fields
Modifier and Type	Field and Description
`static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description

Encounter()
default constructor

Encounter(Integer encounterId)

Constructors
Constructor and Description
`Encounter()` default constructor
`Encounter(Integer encounterId)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addObs(Obs observation)` Add the given Obs to the list of obs for this Encounter.
`void`	`addOrder(Order order)` Add the given Order to the list of orders for this Encounter
`boolean`	`equals(Object obj)` Compares two Encounter objects for similarity
`Set<Obs>`	`getAllObs()` Convenience method to call `getAllObs(boolean)` with a false parameter
`Set<Obs>`	`getAllObs(boolean includeVoided)` Returns all Obs where Obs.encounterId = Encounter.encounterId In practice, this method should not be used very often...
`Date`	`getEncounterDatetime()`
`Integer`	`getEncounterId()`
`EncounterType`	`getEncounterType()`
`Form`	`getForm()`
`Integer`	`getId()`
`Location`	`getLocation()`
`Set<Obs>`	`getObs()`
`Set<Obs>`	`getObsAtTopLevel(boolean includeVoided)` Returns a Set of all root-level Obs of an Encounter, including obsGroups
`Set<Order>`	`getOrders()`
`Patient`	`getPatient()`
`Integer`	`getPatientId()`
`Person`	`getProvider()`
`int`	`hashCode()`
`void`	`removeObs(Obs observation)` Remove the given observation from the list of obs for this Encounter
`void`	`removeOrder(Order order)` Remove the given observation from the list of orders for this Encounter
`void`	`setEncounterDatetime(Date encounterDatetime)`
`void`	`setEncounterId(Integer encounterId)`
`void`	`setEncounterType(EncounterType encounterType)`
`void`	`setForm(Form form)`
`void`	`setId(Integer id)`
`void`	`setLocation(Location location)`
`void`	`setObs(Set<Obs> obs)`
`void`	`setOrders(Set<Order> orders)`
`void`	`setPatient(Patient patient)`
`void`	`setPatientId(Integer patientId)`
`void`	`setProvider(Person provider)`
`void`	`setProvider(User provider)` Deprecated. use `setProvider(Person)`
`String`	`toString()`

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
getUuid, setUuid

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openmrs.OpenmrsObject
getUuid, setUuid

- Field Detail
  - serialVersionUID
```
public static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Encounter
```
public Encounter()
```
    default constructor
  - Encounter
```
public Encounter(Integer encounterId)
```
    Parameters:
    
    encounterId -
    
    Should:
    
    set encounter id
- Method Detail
  - equals
```
public boolean equals(Object obj)
```
    Compares two Encounter objects for similarity
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - Encounter object to compare to
    
    Returns:
    
    boolean true/false whether or not they are the same objects
    
    See Also:
    
    Object.equals(java.lang.Object)
    
    Should:
    
    equal encounter with same encounter id, not equal encounter with different encounter id, not equal on null, have equal encounter objects with no encounter ids, not have equal encounter objects when one has null encounter id
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
    
    See Also:
    
    Object.hashCode()
    
    Should:
    
    have same hashcode when equal, have different hash code when not equal, get hash code with null attributes
  - getEncounterDatetime
```
public Date getEncounterDatetime()
```
    Returns:
    
    Returns the encounterDatetime.
  - setEncounterDatetime
```
public void setEncounterDatetime(Date encounterDatetime)
```
    Parameters:
    
    encounterDatetime - The encounterDatetime to set.
  - getEncounterId
```
public Integer getEncounterId()
```
    Returns:
    
    Returns the encounterId.
  - setEncounterId
```
public void setEncounterId(Integer encounterId)
```
    Parameters:
    
    encounterId - The encounterId to set.
  - getEncounterType
```
public EncounterType getEncounterType()
```
    Returns:
    
    Returns the encounterType.
  - setEncounterType
```
public void setEncounterType(EncounterType encounterType)
```
    Parameters:
    
    encounterType - The encounterType to set.
  - getLocation
```
public Location getLocation()
```
    Returns:
    
    Returns the location.
  - setLocation
```
public void setLocation(Location location)
```
    Parameters:
    
    location - The location to set.
  - getObs
```
public Set<Obs> getObs()
```
    Returns:
    
    Returns a Set of all non-voided, non-obsGroup children Obs of this Encounter
    
    Should:
    
    not return null with null obs set, get obs, not get voided obs, only get child obs, not get child obs if child also on encounter, get both child and parent obs after removing child from parent grouping, get obs with two levels of hierarchy, get obs with three levels of hierarchy, not get voided obs with three layers of hierarchy
  - getAllObs
```
public Set<Obs> getAllObs(boolean includeVoided)
```
    Returns all Obs where Obs.encounterId = Encounter.encounterId In practice, this method should not be used very often...
    
    Parameters:
    
    includeVoided - specifies whether or not to include voided Obs
    
    Returns:
    
    Returns the all Obs.
    
    Should:
    
    not return null with null obs set, get obs, get both parent and child obs, get both parent and child with child directly on encounter, get both child and parent obs after removing child from parent grouping
  - getAllObs
```
public Set<Obs> getAllObs()
```
    Convenience method to call getAllObs(boolean) with a false parameter
    
    Returns:
    
    all non-voided obs
    
    Should:
    
    not get voided obs
  - getObsAtTopLevel
```
public Set<Obs> getObsAtTopLevel(boolean includeVoided)
```
    Returns a Set of all root-level Obs of an Encounter, including obsGroups
    
    Parameters:
    
    includeVoided - specifies whether or not to include voided Obs
    
    Returns:
    
    Returns all obs at top level -- will not be null
    
    Should:
    
    not return null with null obs set, get obs, not get voided obs, only get parents obs, only return the grouped top level obs, get both child and parent obs after removing child from parent grouping
  - setObs
```
public void setObs(Set<Obs> obs)
```
    Parameters:
    
    obs - The obs to set.
  - addObs
```
public void addObs(Obs observation)
```
    Add the given Obs to the list of obs for this Encounter.
    
    Parameters:
    
    observation - the Obs to add to this encounter
    
    Should:
    
    add obs with null values, not fail with null obs, set encounter attribute on obs, add obs to non null initial obs set, add encounter attrs to obs if attributes are null
  - removeObs
```
public void removeObs(Obs observation)
```
    Remove the given observation from the list of obs for this Encounter
    
    Parameters:
    
    observation -
    
    Should:
    
    remove obs successfully, not throw error when removing null obs from empty set, not throw error when removing null obs from non empty set
  - getOrders
```
public Set<Order> getOrders()
```
    Returns:
    
    Returns the orders
  - setOrders
```
public void setOrders(Set<Order> orders)
```
    Parameters:
    
    orders - The orders to set.
  - addOrder
```
public void addOrder(Order order)
```
    Add the given Order to the list of orders for this Encounter
    
    Parameters:
    
    order -
    
    Should:
    
    add order with null values, not fail with null obs passed to add order, set encounter attribute, add order to non nul initial order set
  - removeOrder
```
public void removeOrder(Order order)
```
    Remove the given observation from the list of orders for this Encounter
    
    Parameters:
    
    order -
    
    Should:
    
    remove order from encounter, not fail when removing null order, not fail when removing non existent order
  - getPatient
```
public Patient getPatient()
```
    Returns:
    
    Returns the patient.
  - setPatient
```
public void setPatient(Patient patient)
```
    Parameters:
    
    patient - The patient to set.
  - getPatientId
```
public Integer getPatientId()
```
    Returns:
    
    the patientId
  - setPatientId
```
public void setPatientId(Integer patientId)
```
    Parameters:
    
    patientId - the patientId to set
  - getProvider
```
public Person getProvider()
```
    Returns:
    
    Returns the provider.
    
    Since:
    
    1.6 (used to return User)
  - setProvider
```
public void setProvider(User provider)
```
    Deprecated. use setProvider(Person)
    
    Parameters:
    
    provider - The provider to set.
  - setProvider
```
public void setProvider(Person provider)
```
    Parameters:
    
    provider - The provider to set.
  - getForm
```
public Form getForm()
```
    Returns:
    
    Returns the form.
  - setForm
```
public void setForm(Form form)
```
    Parameters:
    
    form - The form to set.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()
    
    Should:
    
    not fail with empty object
  - getId
```
public Integer getId()
```
    Specified by:
    
    getId in interface OpenmrsObject
    
    Returns:
    
    id - The unique Identifier for the object
    
    Since:
    
    1.5
    
    See Also:
    
    OpenmrsObject.getId()
  - setId
```
public void setId(Integer id)
```
    Specified by:
    
    setId in interface OpenmrsObject
    
    Parameters:
    
    id - - The unique Identifier for the object
    
    Since:
    
    1.5
    
    See Also:
    
    OpenmrsObject.setId(java.lang.Integer)

Class Encounter

Field Summary

Fields inherited from class org.openmrs.BaseOpenmrsData

Constructor Summary

Method Summary

Methods inherited from class org.openmrs.BaseOpenmrsData

Methods inherited from class org.openmrs.BaseOpenmrsObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.openmrs.OpenmrsObject

Field Detail

serialVersionUID

Constructor Detail

Encounter

Encounter

Method Detail

equals

hashCode

getEncounterDatetime

setEncounterDatetime

getEncounterId

setEncounterId

getEncounterType

setEncounterType

getLocation

setLocation

getObs

getAllObs

getAllObs

getObsAtTopLevel

setObs

addObs

removeObs

getOrders

setOrders

addOrder

removeOrder

getPatient

setPatient

getPatientId

setPatientId

getProvider

setProvider

setProvider

getForm

setForm

toString

getId

setId