Encounter (OpenMRS 2.7.0-SNAPSHOT API)

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

All Implemented Interfaces:

Serializable, Auditable, Changeable, Creatable, OpenmrsData, OpenmrsObject, Voidable
```
@Entity
public class Encounter
extends BaseChangeableOpenmrsData
```
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
Modifier and Type	Method and Description
`void`	`addAllergy(Allergy allergy)` Add the given allergy to the set of allergies for this encounter.
`void`	`addCondition(Condition condition)` Add the given condition to the set of conditions for this encounter.
`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.
`Encounter`	`copyAndAssignToAnotherPatient(Patient patient)` Copied encounter will not have visit field copied.
`Set<EncounterProvider>`	`getActiveEncounterProviders()` Returns only the non-voided encounter providers for this encounter.
`Set<Allergy>`	`getAllergies()` Basic property getter for the encounter's non-voided allergies.
`Set<Allergy>`	`getAllergies(boolean includeVoided)` Returns all allergies where 'Allergy.encounterId = Encounter.encounterId'.
`Set<Obs>`	`getAllFlattenedObs(boolean includeVoided)` Returns all encounter obs as a flatten list(Set) of obs.
`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...
`Set<Condition>`	`getConditions()` Basic property getter for the encounter's non-voided conditions.
`Set<Condition>`	`getConditions(boolean includeVoided)` Returns all conditions where 'Condition.encounterId = Encounter.encounterId'.
`Set<Diagnosis>`	`getDiagnoses()` Gets the set of diagnoses
`Date`	`getEncounterDatetime()`
`Integer`	`getEncounterId()`
`Set<EncounterProvider>`	`getEncounterProviders()` Basic property accessor for encounterProviders.
`EncounterType`	`getEncounterType()`
`Form`	`getForm()`
`Integer`	`getId()`
`Location`	`getLocation()`
`Set<Obs>`	`getObs()`
`Set<Obs>`	`getObsAtTopLevel(boolean includeVoided)` Returns a Set<Obs> of all root-level Obs of an Encounter, including obsGroups
`List<OrderGroup>`	`getOrderGroups()` Takes in a list of orders and pulls out the orderGroups within them
`Set<Order>`	`getOrders()`
`List<Order>`	`getOrdersWithoutOrderGroups()` Takes in a list of orders and filters out the orders which have orderGroups
`Patient`	`getPatient()`
`Set<Provider>`	`getProvidersByRole(EncounterRole role)` Gets unvoided providers who had the given role in this encounter.
`Set<Provider>`	`getProvidersByRole(EncounterRole role, boolean includeVoided)` Gets providers who had the given role in this encounter.
`Map<EncounterRole,Set<Provider>>`	`getProvidersByRoles()` Gets all unvoided providers, grouped by role.
`Map<EncounterRole,Set<Provider>>`	`getProvidersByRoles(boolean includeVoided)` Gets all providers, grouped by role.
`Visit`	`getVisit()` Gets the visit.
`Boolean`	`hasDiagnosis(Diagnosis diagnosis)` Check if encounter has a particular diagnosis
`void`	`removeAllergy(Allergy allergy)` Remove the given allergy from the set of allergies for this encounter.
`void`	`removeCondition(Condition condition)` Remove the given condition from the set of conditions for this encounter.
`void`	`removeObs(Obs observation)` Remove the given observation from the list of obs for this Encounter
`void`	`removeOrder(Order order)` Remove the given order from the list of orders for this Encounter
`void`	`removeProvider(EncounterRole role, Provider provider)` Removes the provider for a given role.
`void`	`setAllergies(Set<Allergy> allergies)` Basic property setter for allergies
`void`	`setConditions(Set<Condition> conditions)` Basic property setter for conditions
`void`	`setDiagnoses(Set<Diagnosis> diagnoses)` Sets a set of diagnoses for the current Encounter
`void`	`setEncounterDatetime(Date encounterDatetime)`
`void`	`setEncounterId(Integer encounterId)`
`void`	`setEncounterProviders(Set<EncounterProvider> encounterProviders)` Basic property setter for encounterProviders.
`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`	`setProvider(EncounterRole role, Provider provider)` Sets the provider for the given role.
`void`	`setVisit(Visit visit)` Sets the visit
`String`	`toString()` Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}

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(Integer encounterId)
```
    Parameters:
    
    encounterId - Should set encounter id
- Method Detail
  - 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<Obs> of all non-voided, non-obsGroup children Obs of this Encounter Should not return null with null obs set Should get obs Should not get voided obs Should only get child obs Should not get child obs if child also on encounter Should get both child and parent obs after removing child from parent grouping Should get obs with two levels of hierarchy Should get obs with three levels of hierarchy Should 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 Should get obs Should get both parent and child obs Should get both parent and child with child directly on encounter Should 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
  - getAllFlattenedObs
```
public Set<Obs> getAllFlattenedObs(boolean includeVoided)
```
    Returns all encounter obs as a flatten list(Set) of obs.
    
    Parameters:
    
    includeVoided - indicates whether or not to include voided obs
    
    Returns:
    
    a Set of all encounter' Obs
  - getObsAtTopLevel
```
public Set<Obs> getObsAtTopLevel(boolean includeVoided)
```
    Returns a Set<Obs> 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 Should get obs Should not get voided obs Should only get parents obs Should only return the grouped top level obs Should 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 Should not fail with null obs Should set encounter attribute on obs Should add obs to non null initial obs set Should add encounter attrs to obs if attributes are null Should add encounter attrs to obs groupMembers 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 Should not throw error when removing null obs from empty set Should 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 Should not fail with null obs passed to add order Should set encounter attribute Should add order to non null initial order set Should add order to encounter when adding order to set returned from getOrders
  - removeOrder
```
public void removeOrder(Order order)
```
    Remove the given order from the list of orders for this Encounter
    
    Parameters:
    
    order - Should remove order from encounter Should not fail when removing null order Should 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.
  - getDiagnoses
```
public Set<Diagnosis> getDiagnoses()
```
    Gets the set of diagnoses
    
    Returns:
    
    diagnoses - the set of diagnoses.
    
    Since:
    
    2.2
  - setDiagnoses
```
public void setDiagnoses(Set<Diagnosis> diagnoses)
```
    Sets a set of diagnoses for the current Encounter
    
    Parameters:
    
    diagnoses - the set of Diagnosis to set.
    
    Since:
    
    2.2
  - getConditions
```
public Set<Condition> getConditions()
```
    Basic property getter for the encounter's non-voided conditions.
    
    Returns:
    
    all non-voided conditions
    
    Since:
    
    2.4.0, 2.3.1
  - getConditions
```
public Set<Condition> getConditions(boolean includeVoided)
```
    Returns all conditions where 'Condition.encounterId = Encounter.encounterId'.
    
    Parameters:
    
    includeVoided - - Specifies whether or not to include voided conditions.
    
    Returns:
    
    The set of conditions, or an empty set if there are no conditions to return.
    
    Since:
    
    2.3.3, 2.4.0, 2.5.0
  - setConditions
```
public void setConditions(Set<Condition> conditions)
```
    Basic property setter for conditions
    
    Parameters:
    
    conditions - - set of conditions
    
    Since:
    
    2.4.0, 2.3.1
  - addCondition
```
public void addCondition(Condition condition)
```
    Add the given condition to the set of conditions for this encounter.
    
    Parameters:
    
    condition - - the condition to add
  - removeCondition
```
public void removeCondition(Condition condition)
```
    Remove the given condition from the set of conditions for this encounter. In practise the condition is not removed but rather voided.
    
    Parameters:
    
    condition - - the condition to remove
  - getEncounterProviders
```
public 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(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 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()
  - getForm
```
public Form getForm()
```
    Returns:
    
    Returns the form.
  - setForm
```
public void setForm(Form form)
```
    Parameters:
    
    form - The form to set.
  - 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:
    
    Should not fail with empty object
  - getId
```
public Integer getId()
```
    Returns:
    
    id - The unique Identifier for the object
    
    Since:
    
    1.5
    
    See Also:
    
    OpenmrsObject.getId()
  - setId
```
public void setId(Integer id)
```
    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 Map<EncounterRole,Set<Provider>> getProvidersByRoles()
```
    Gets all unvoided providers, grouped by role.
    
    Returns:
    
    map of unvoided providers keyed by roles
    
    Since:
    
    1.9 Should return empty map if no unvoided providers Should return all roles and unvoided providers
  - getProvidersByRoles
```
public Map<EncounterRole,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 Should return empty map if no providers Should return all roles and providers
  - getProvidersByRole
```
public 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 Should return unvoided providers for role Should return empty set for no role Should return empty set for null role
  - getProvidersByRole
```
public 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 Should return providers for role Should return empty set for no role Should return empty set for null role
  - 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 Should add provider for new role Should add second provider for role Should not add same provider twice for role
  - 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 Should set provider for new role Should clear providers and set provider for role Should void existing EncounterProvider
  - 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 Should void existing EncounterProvider
  - copyAndAssignToAnotherPatient
```
public Encounter copyAndAssignToAnotherPatient(Patient patient)
```
    Copied encounter will not have visit field copied.
    
    Parameters:
    
    patient - the Patient that will be assign to copied Encounter
    
    Returns:
    
    copied encounter Should copy all Encounter data except visit and assign copied Encounter to given Patient
  - getOrderGroups
```
public List<OrderGroup> getOrderGroups()
```
    Takes in a list of orders and pulls out the orderGroups within them
    
    Returns:
    
    list of orderGroups
    
    Since:
    
    1.12
  - getOrdersWithoutOrderGroups
```
public List<Order> getOrdersWithoutOrderGroups()
```
    Takes in a list of orders and filters out the orders which have orderGroups
    
    Returns:
    
    list of orders not having orderGroups
    
    Since:
    
    1.12
  - hasDiagnosis
```
public Boolean hasDiagnosis(Diagnosis diagnosis)
```
    Check if encounter has a particular diagnosis
    
    Parameters:
    
    diagnosis - the diagnosis to check if it belongs to this given encounter
    
    Returns:
    
    true if this encounter has the given diagnosis, else false
    
    Since:
    
    2.2
  - getAllergies
```
public Set<Allergy> getAllergies()
```
    Basic property getter for the encounter's non-voided allergies.
    
    Returns:
    
    all non-voided allergies
    
    Since:
    
    2.5.0
  - getAllergies
```
public Set<Allergy> getAllergies(boolean includeVoided)
```
    Returns all allergies where 'Allergy.encounterId = Encounter.encounterId'.
    
    Parameters:
    
    includeVoided - - Specifies whether or not to include voided allergies.
    
    Returns:
    
    The set of allergies, or an empty set if there are no allergies to return.
    
    Since:
    
    2.5.0
  - setAllergies
```
public void setAllergies(Set<Allergy> allergies)
```
    Basic property setter for allergies
    
    Parameters:
    
    allergies - - set of allergies
    
    Since:
    
    2.5.0
  - addAllergy
```
public void addAllergy(Allergy allergy)
```
    Add the given allergy to the set of allergies for this encounter.
    
    Parameters:
    
    allergy - - the allergy to add
  - removeAllergy
```
public void removeAllergy(Allergy allergy)
```
    Remove the given allergy from the set of allergies for this encounter. In practice the allergy is not removed but rather voided.
    
    Parameters:
    
    allergy - - the allergy to remove

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

getAllFlattenedObs

getObsAtTopLevel

setObs

addObs

removeObs

getOrders

setOrders

addOrder

removeOrder

getPatient

setPatient

getDiagnoses

setDiagnoses

getConditions

getConditions

setConditions

addCondition

removeCondition

getEncounterProviders

setEncounterProviders

getActiveEncounterProviders

getForm

setForm

toString

getId

setId

getVisit

setVisit

getProvidersByRoles

getProvidersByRoles

getProvidersByRole

getProvidersByRole

addProvider

setProvider

removeProvider

copyAndAssignToAnotherPatient

getOrderGroups

getOrdersWithoutOrderGroups

hasDiagnosis

getAllergies

getAllergies

setAllergies

addAllergy

removeAllergy