Encounter (OpenMRS 1.10.7-SNAPSHOT API)

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

All Implemented Interfaces:

java.io.Serializable, Auditable, OpenmrsData, OpenmrsObject, Voidable
```
public class Encounter
extends BaseOpenmrsData
implements java.io.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(java.lang.Integer encounterId)

Constructors
Constructor and Description
`Encounter()` default constructor
`Encounter(java.lang.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
`void`	`addProvider(EncounterRole role, Provider provider)` Adds a new provider for the encounter, with the given role.
`java.util.Set<EncounterProvider>`	`getActiveEncounterProviders()` Returns only the non-voided encounter providers for this encounter.
`java.util.Set<Obs>`	`getAllObs()` Convenience method to call `getAllObs(boolean)` with a false parameter
`java.util.Set<Obs>`	`getAllObs(boolean includeVoided)` Returns all Obs where Obs.encounterId = Encounter.encounterId In practice, this method should not be used very often...
`java.util.Date`	`getEncounterDatetime()`
`java.lang.Integer`	`getEncounterId()`
`java.util.Set<EncounterProvider>`	`getEncounterProviders()` Basic property accessor for encounterProviders.
`EncounterType`	`getEncounterType()`
`Form`	`getForm()`
`java.lang.Integer`	`getId()`
`Location`	`getLocation()`
`java.util.Set<Obs>`	`getObs()`
`java.util.Set<Obs>`	`getObsAtTopLevel(boolean includeVoided)` Returns a Set of all root-level Obs of an Encounter, including obsGroups
`java.util.Set<Order>`	`getOrders()`
`Patient`	`getPatient()`
`java.lang.Integer`	`getPatientId()` Deprecated. due to duplication. Use Encounter.Patient instead
`Person`	`getProvider()` Deprecated. since 1.9, use `getProvidersByRole(EncounterRole)`
`java.util.Set<Provider>`	`getProvidersByRole(EncounterRole role)` Gets unvoided providers who had the given role in this encounter.
`java.util.Set<Provider>`	`getProvidersByRole(EncounterRole role, boolean includeVoided)` Gets providers who had the given role in this encounter.
`java.util.Map<EncounterRole,java.util.Set<Provider>>`	`getProvidersByRoles()` Gets all unvoided providers, grouped by role.
`java.util.Map<EncounterRole,java.util.Set<Provider>>`	`getProvidersByRoles(boolean includeVoided)` Gets all providers, grouped by role.
`Visit`	`getVisit()` Gets the visit.
`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`	`removeProvider(EncounterRole role, Provider provider)` Removes the provider for a given role.
`void`	`setEncounterDatetime(java.util.Date encounterDatetime)`
`void`	`setEncounterId(java.lang.Integer encounterId)`
`void`	`setEncounterProviders(java.util.Set<EncounterProvider> encounterProviders)` Basic property setter for encounterProviders.
`void`	`setEncounterType(EncounterType encounterType)`
`void`	`setForm(Form form)`
`void`	`setId(java.lang.Integer id)`
`void`	`setLocation(Location location)`
`void`	`setObs(java.util.Set<Obs> obs)`
`void`	`setOrders(java.util.Set<Order> orders)`
`void`	`setPatient(Patient patient)`
`void`	`setPatientId(java.lang.Integer patientId)` Deprecated. due to duplication. Use Encounter.Patient instead
`void`	`setProvider(EncounterRole role, Provider provider)` Sets the provider for the given role.
`void`	`setProvider(Person provider)` Deprecated. since 1.9, use `setProvider(EncounterRole, Provider)`
`void`	`setProvider(User provider)` Deprecated. use `setProvider(Person)`
`void`	`setVisit(Visit visit)` Sets the visit
`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.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.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(java.lang.Integer encounterId)
```
    Parameters:
    
    encounterId -
- Method Detail
  - getEncounterDatetime
```
public java.util.Date getEncounterDatetime()
```
    Returns:
    
    Returns the encounterDatetime.
  - setEncounterDatetime
```
public void setEncounterDatetime(java.util.Date encounterDatetime)
```
    Parameters:
    
    encounterDatetime - The encounterDatetime to set.
  - getEncounterId
```
public java.lang.Integer getEncounterId()
```
    Returns:
    
    Returns the encounterId.
  - setEncounterId
```
public void setEncounterId(java.lang.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 java.util.Set<Obs> getObs()
```
    Returns:
    
    Returns a Set of all non-voided, non-obsGroup children Obs of this Encounter
  - getAllObs
```
public java.util.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.
  - getAllObs
```
public java.util.Set<Obs> getAllObs()
```
    Convenience method to call getAllObs(boolean) with a false parameter
    
    Returns:
    
    all non-voided obs
  - getObsAtTopLevel
```
public java.util.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
  - setObs
```
public void setObs(java.util.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
  - removeObs
```
public void removeObs(Obs observation)
```
    Remove the given observation from the list of obs for this Encounter
    
    Parameters:
    
    observation -
  - getOrders
```
public java.util.Set<Order> getOrders()
```
    Returns:
    
    Returns the orders
  - setOrders
```
public void setOrders(java.util.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 -
  - removeOrder
```
public void removeOrder(Order order)
```
    Remove the given observation from the list of orders for this Encounter
    
    Parameters:
    
    order -
  - getPatient
```
public Patient getPatient()
```
    Returns:
    
    Returns the patient.
  - setPatient
```
public void setPatient(Patient patient)
```
    Parameters:
    
    patient - The patient to set.
  - getPatientId
```
@Deprecated
public java.lang.Integer getPatientId()
```
    Deprecated. due to duplication. Use Encounter.Patient instead
    
    Returns:
    
    the patientId
  - setPatientId
```
@Deprecated
public void setPatientId(java.lang.Integer patientId)
```
    Deprecated. due to duplication. Use Encounter.Patient instead
    
    Parameters:
    
    patientId - the patientId to set
  - getEncounterProviders
```
public java.util.Set<EncounterProvider> getEncounterProviders()
```
    Basic property accessor for encounterProviders. The convenience methods getProvidersByRoles and getProvidersByRole are the preferred methods for getting providers. This getter is provided as a convenience for treating this like a DTO
    
    Returns:
    
    list of all existing providers on this encounter
    
    Since:
    
    1.9.1
    
    See Also:
    
    getProvidersByRole(EncounterRole), getProvidersByRoles()
  - setEncounterProviders
```
public void setEncounterProviders(java.util.Set<EncounterProvider> encounterProviders)
```
    Basic property setter for encounterProviders. The convenience methods addProvider, removeProvider, and setProvider are the preferred methods for adding/removing providers. This setter is provided as a convenience for treating this like a DTO
    
    Parameters:
    
    encounterProviders - the list of EncounterProvider objects to set. Overwrites list as normal setter is inclined to do
    
    Since:
    
    1.9.1
    
    See Also:
    
    addProvider(EncounterRole, Provider), removeProvider(EncounterRole, Provider), setProvider(EncounterRole, Provider)
  - getActiveEncounterProviders
```
public java.util.Set<EncounterProvider> getActiveEncounterProviders()
```
    Returns only the non-voided encounter providers for this encounter. If you want all encounter providers, use getEncounterProviders()
    
    Returns:
    
    list of non-voided encounter providers for this encounter
    
    See Also:
    
    getEncounterProviders()
  - getProvider
```
public Person getProvider()
```
    Deprecated. since 1.9, use getProvidersByRole(EncounterRole)
    
    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)
```
    Deprecated. since 1.9, use setProvider(EncounterRole, 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 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()
  - getId
```
public java.lang.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(java.lang.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)
  - getVisit
```
public Visit getVisit()
```
    Gets the visit.
    
    Returns:
    
    the visit.
    
    Since:
    
    1.9
  - setVisit
```
public void setVisit(Visit visit)
```
    Sets the visit
    
    Parameters:
    
    visit - the visit to set.
    
    Since:
    
    1.9
  - getProvidersByRoles
```
public java.util.Map<EncounterRole,java.util.Set<Provider>> getProvidersByRoles()
```
    Gets all unvoided providers, grouped by role.
    
    Returns:
    
    map of unvoided providers keyed by roles
    
    Since:
    
    1.9
  - getProvidersByRoles
```
public java.util.Map<EncounterRole,java.util.Set<Provider>> getProvidersByRoles(boolean includeVoided)
```
    Gets all providers, grouped by role.
    
    Parameters:
    
    includeVoided - set to true to include voided providers, else set to false
    
    Returns:
    
    map of providers keyed by roles
    
    Since:
    
    1.9
  - getProvidersByRole
```
public java.util.Set<Provider> getProvidersByRole(EncounterRole role)
```
    Gets unvoided providers who had the given role in this encounter.
    
    Parameters:
    
    role -
    
    Returns:
    
    unvoided providers or empty set if none was found
    
    Since:
    
    1.9
  - getProvidersByRole
```
public java.util.Set<Provider> getProvidersByRole(EncounterRole role,
                                                  boolean includeVoided)
```
    Gets providers who had the given role in this encounter.
    
    Parameters:
    
    role -
    
    includeVoided - set to true to include voided providers, else set to false
    
    Returns:
    
    providers or empty set if none was found
    
    Since:
    
    1.9
  - addProvider
```
public void addProvider(EncounterRole role,
                        Provider provider)
```
    Adds a new provider for the encounter, with the given role.
    
    Parameters:
    
    role -
    
    provider -
    
    Since:
    
    1.9
  - setProvider
```
public void setProvider(EncounterRole role,
                        Provider provider)
```
    Sets the provider for the given role.
    If the encounter already had any providers for the given role, those are removed.
    
    Parameters:
    
    role -
    
    provider -
    
    Since:
    
    1.9
  - removeProvider
```
public void removeProvider(EncounterRole role,
                           Provider provider)
```
    Removes the provider for a given role.
    
    Parameters:
    
    role - the role.
    
    provider - the provider.
    
    Since:
    
    1.9

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

getEncounterDatetime

setEncounterDatetime

getEncounterId

setEncounterId

getEncounterType

setEncounterType

getLocation

setLocation

getObs

getAllObs

getAllObs

getObsAtTopLevel

setObs

addObs

removeObs

getOrders

setOrders

addOrder

removeOrder

getPatient

setPatient

getPatientId

setPatientId

getEncounterProviders

setEncounterProviders

getActiveEncounterProviders

getProvider

setProvider

setProvider

getForm

setForm

toString

getId

setId

getVisit

setVisit

getProvidersByRoles

getProvidersByRoles

getProvidersByRole

getProvidersByRole

addProvider

setProvider

removeProvider