Obs (OpenMRS 2.7.0-SNAPSHOT API)

java.lang.Object
- org.openmrs.BaseOpenmrsObject
- - org.openmrs.BaseOpenmrsData
  - - org.openmrs.BaseChangeableOpenmrsData
    - - org.openmrs.BaseFormRecordableOpenmrsData
      - org.openmrs.Obs

All Implemented Interfaces:

Serializable, Auditable, Changeable, Creatable, FormRecordable, OpenmrsData, OpenmrsObject, Voidable
```
public class Obs
extends BaseFormRecordableOpenmrsData
```
An observation is a single unit of clinical information.

Observations are collected and grouped together into one Encounter (one visit). Obs can be grouped in a hierarchical fashion.

The getObsGroup() method returns an optional parent. That parent object is also an Obs. The parent Obs object knows about its child objects through the getGroupMembers() method.

(Multi-level hierarchies are achieved by an Obs parent object being a member of another Obs (grand)parent object) Read up on the obs table: http://openmrs.org/wiki/Obs_Table_Primer In an OpenMRS installation, there may be an occasion need to change an Obs.

For example, a site may decide to replace a concept in the dictionary with a more specific set of concepts. An observation is part of the official record of an encounter. There may be legal, ethical, and auditing consequences from altering a record. It is recommended that you create a new Obs and void the old one:
Obs newObs = Obs.newInstance(oldObs); //copies values from oldObs newObs.setPreviousVersion(oldObs); Context.getObsService().saveObs(newObs,"Your reason for the change here"); Context.getObsService().voidObs(oldObs, "Your reason for the change here");

See Also:

Encounter, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Obs.Interpretation

static class Obs.Status

Nested Classes
Modifier and Type	Class and Description
`static class`	`Obs.Interpretation`
`static class`	`Obs.Status`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`accessionNumber`
`protected String`	`comment`
`protected ComplexData`	`complexData`
`protected Concept`	`concept`
`protected Encounter`	`encounter`
`protected Set<Obs>`	`groupMembers` The list of obs grouped under this obs.
`protected Location`	`location`
`protected Date`	`obsDatetime`
`protected Obs`	`obsGroup` The "parent" of this obs.
`protected Integer`	`obsId`
`protected Order`	`order`
`protected Person`	`person`
`protected Integer`	`personId`
`static long`	`serialVersionUID`
`protected Concept`	`valueCoded`
`protected ConceptName`	`valueCodedName`
`protected String`	`valueComplex`
`protected Date`	`valueDatetime`
`protected Drug`	`valueDrug`
`protected Integer`	`valueGroupId`
`protected String`	`valueModifier`
`protected Double`	`valueNumeric`
`protected String`	`valueText`

Fields inherited from class org.openmrs.BaseFormRecordableOpenmrsData
FORM_NAMESPACE_PATH_MAX_LENGTH, FORM_NAMESPACE_PATH_SEPARATOR, formNamespaceAndPath

Fields inherited from class org.openmrs.BaseOpenmrsData
creator

Constructor Summary

Constructors
Constructor and Description
`Obs()` default constructor
`Obs(Integer obsId)` constructor with id
`Obs(Person person, Concept question, Date obsDatetime, Location location)` Required parameters constructor A value is also required, but that can be one of: valueCoded, valueDrug, valueNumeric, or valueText

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGroupMember(Obs member)` Convenience method to add the given `obs` to this grouping.
`String`	`getAccessionNumber()`
`String`	`getComment()`
`ComplexData`	`getComplexData()` Get the ComplexData.
`Concept`	`getConcept()`
`ConceptDescription`	`getConceptDescription()` Get the concept description that is tied to the concept name that was used when making this observation
`Encounter`	`getEncounter()`
`Set<Obs>`	`getGroupMembers()` Get the non-voided members of the obs group, if this obs is a group.
`Set<Obs>`	`getGroupMembers(boolean includeVoided)` Get the group members of this obs group, if this obs is a group.
`Integer`	`getId()`
`Obs.Interpretation`	`getInterpretation()` Similar to FHIR's Observation.interpretation.
`Location`	`getLocation()`
`Date`	`getObsDatetime()`
`Obs`	`getObsGroup()` An obs grouping occurs when the question (#getConcept()) is a set.
`Integer`	`getObsId()`
`Order`	`getOrder()`
`Person`	`getPerson()` Get the person object that this obs is acting on.
`Integer`	`getPersonId()` The person id of the person on this object.
`Obs`	`getPreviousVersion()` When ObsService updates an obs, it voids the old version, creates a new Obs with the updates, and adds a reference to the previousVersion in the new Obs. getPreviousVersion returns the last version of this Obs.
`Set<Obs>`	`getRelatedObservations()` Convenience method that returns related Obs If the Obs argument is not an ObsGroup: a Set<Obs> will be returned containing all of the children of this Obs' parent that are not ObsGroups themselves.
`Obs.Status`	`getStatus()` Similar to FHIR's Observation.status.
`Boolean`	`getValueAsBoolean()` Coerces a value to a Boolean representation
`String`	`getValueAsString(Locale locale)` Convenience method for obtaining the observation's value as a string If the Obs is complex, returns the title of the complexData denoted by the section of getValueComplex() before the first bar '\|' character; or returns the entire getValueComplex() if the bar '\|' character is missing.
`Boolean`	`getValueBoolean()` Returns the boolean value if the concept of this obs is of boolean datatype
`Concept`	`getValueCoded()`
`ConceptName`	`getValueCodedName()` Gets the specific name used for the coded value.
`String`	`getValueComplex()` Get the value for the ComplexData.
`Date`	`getValueDate()`
`Date`	`getValueDatetime()`
`Drug`	`getValueDrug()`
`Integer`	`getValueGroupId()`
`String`	`getValueModifier()`
`Double`	`getValueNumeric()`
`String`	`getValueText()`
`Date`	`getValueTime()`
`boolean`	`hasGroupMembers()` A convenience method to check for nullity and length to determine if this obs has group members.
`boolean`	`hasGroupMembers(boolean includeVoided)` Convenience method that checks for nullity and length to determine if this obs has group members.
`Boolean`	`hasPreviousVersion()`
`boolean`	`isComplex()`
`boolean`	`isDirty()` Returns true if any change has been made to an Obs instance.
`boolean`	`isObsGrouping()` Convenience method that checks for if this obs has 1 or more group members (either voided or non-voided) Note this method differs from hasGroupMembers(), as that method excludes voided obs; logic is that while a obs that has only voided group members should be seen as "having no group members" it still should be considered an "obs grouping" NOTE: This method could also be called "isObsGroup" for a little less confusion on names.
`protected void`	`markAsDirty(Object oldValue, Object newValue)`
`static Obs`	`newInstance(Obs obsToCopy)` This is an equivalent to a copy constructor.
`void`	`removeGroupMember(Obs member)` Convenience method to remove an Obs from this grouping This also removes the link in the given `obs`object to this obs grouper
`void`	`setAccessionNumber(String accessionNumber)`
`void`	`setComment(String comment)`
`void`	`setComplexData(ComplexData complexData)` Set the ComplexData for this Obs.
`void`	`setConcept(Concept concept)`
`void`	`setCreator(User creator)`
`void`	`setDateCreated(Date dateCreated)`
`void`	`setEncounter(Encounter encounter)`
`void`	`setFormField(String namespace, String formFieldPath)` Sets the namespace and path of the form field that was used to capture the obs details in the form.
`void`	`setGroupMembers(Set<Obs> groupMembers)` Set the members of the obs group, if this obs is a group.
`void`	`setId(Integer id)`
`void`	`setInterpretation(Obs.Interpretation interpretation)`
`void`	`setLocation(Location location)`
`void`	`setObsDatetime(Date obsDatetime)`
`void`	`setObsGroup(Obs obsGroup)` This method does NOT add this current obs to the list of obs in obsGroup.getGroupMembers().
`void`	`setObsId(Integer obsId)`
`void`	`setOrder(Order order)`
`void`	`setPerson(Person person)` Set the person object to this obs object.
`protected void`	`setPersonId(Integer personId)` Set the person id on this obs object.
`void`	`setPreviousVersion(Obs previousVersion)` A previousVersion indicates that this Obs replaces an earlier one.
`void`	`setStatus(Obs.Status status)`
`void`	`setValueAsString(String s)` Sets the value for the obs from a string depending on the datatype of the question concept
`void`	`setValueBoolean(Boolean valueBoolean)` Sets the value of this obs to the specified valueBoolean if this obs has a boolean concept.
`void`	`setValueCoded(Concept valueCoded)`
`void`	`setValueCodedName(ConceptName valueCodedName)` Sets the specific name used for the coded value.
`void`	`setValueComplex(String valueComplex)` Set the value for the ComplexData.
`void`	`setValueDate(Date valueDate)`
`void`	`setValueDatetime(Date valueDatetime)`
`void`	`setValueDrug(Drug valueDrug)`
`void`	`setValueGroupId(Integer valueGroupId)`
`void`	`setValueModifier(String valueModifier)`
`void`	`setValueNumeric(Double valueNumeric)`
`void`	`setValueText(String valueText)`
`void`	`setValueTime(Date valueTime)`
`String`	`toString()` Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}

Methods inherited from class org.openmrs.BaseFormRecordableOpenmrsData
getFormFieldNamespace, getFormFieldNamespace, getFormFieldPath, getFormFieldPath, getFormNamespaceAndPath, getFormNamespaceAndPath, setFormNamespaceAndPath

Methods inherited from class org.openmrs.BaseOpenmrsData
getChangedBy, getCreator, getDateChanged, getDateCreated, getDateVoided, getVoided, getVoidedBy, getVoidReason, isVoided, setChangedBy, setDateChanged, 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
  - obsId
```
protected Integer obsId
```
  - concept
```
protected Concept concept
```
  - obsDatetime
```
protected Date obsDatetime
```
  - accessionNumber
```
protected String accessionNumber
```
  - obsGroup
```
protected Obs obsGroup
```
    The "parent" of this obs. It is the grouping that brings other obs together. note: obsGroup.getConcept().isSet() should be true This will be non-null if this obs is a member of another groupedObs
    
    See Also:
    
    (??)
  - groupMembers
```
@AllowDirectAccess
protected Set<Obs> groupMembers
```
    The list of obs grouped under this obs.
  - valueCoded
```
protected Concept valueCoded
```
  - valueCodedName
```
protected ConceptName valueCodedName
```
  - valueDrug
```
protected Drug valueDrug
```
  - valueGroupId
```
protected Integer valueGroupId
```
  - valueDatetime
```
protected Date valueDatetime
```
  - valueNumeric
```
protected Double valueNumeric
```
  - valueModifier
```
protected String valueModifier
```
  - valueText
```
protected String valueText
```
  - valueComplex
```
protected String valueComplex
```
  - complexData
```
protected transient ComplexData complexData
```
  - comment
```
protected String comment
```
  - personId
```
protected transient Integer personId
```
  - person
```
protected Person person
```
  - order
```
protected Order order
```
  - location
```
protected Location location
```
  - encounter
```
protected Encounter encounter
```
- Constructor Detail
  - Obs
```
public Obs()
```
    default constructor
  - Obs
```
public Obs(Person person,
           Concept question,
           Date obsDatetime,
           Location location)
```
    Required parameters constructor A value is also required, but that can be one of: valueCoded, valueDrug, valueNumeric, or valueText
    
    Parameters:
    
    person - The Person this obs is acting on
    
    question - The question concept this obs is related to
    
    obsDatetime - The time this obs took place
    
    location - The location this obs took place
  - Obs
```
public Obs(Integer obsId)
```
    constructor with id
- Method Detail
  - newInstance
```
public static Obs newInstance(Obs obsToCopy)
```
    This is an equivalent to a copy constructor. Creates a new copy of the given obsToCopy with a null obs id
    
    Parameters:
    
    obsToCopy - The Obs that is going to be copied
    
    Returns:
    
    a new Obs object with all the same attributes as the given obs
  - getComment
```
public String getComment()
```
    Returns:
    
    Returns the comment.
  - setComment
```
public void setComment(String comment)
```
    Parameters:
    
    comment - The comment to set.
  - getConcept
```
public Concept getConcept()
```
    Returns:
    
    Returns the concept.
  - setConcept
```
public void setConcept(Concept concept)
```
    Parameters:
    
    concept - The concept to set.
  - getConceptDescription
```
public ConceptDescription getConceptDescription()
```
    Get the concept description that is tied to the concept name that was used when making this observation
    
    Returns:
    
    ConceptDescription the description used
  - getEncounter
```
public Encounter getEncounter()
```
    Returns:
    
    Returns the encounter.
  - setEncounter
```
public void setEncounter(Encounter encounter)
```
    Parameters:
    
    encounter - The encounter to set.
  - getLocation
```
public Location getLocation()
```
    Returns:
    
    Returns the location.
  - setLocation
```
public void setLocation(Location location)
```
    Parameters:
    
    location - The location to set.
  - getObsDatetime
```
public Date getObsDatetime()
```
    Returns:
    
    Returns the obsDatetime.
  - setObsDatetime
```
public void setObsDatetime(Date obsDatetime)
```
    Parameters:
    
    obsDatetime - The obsDatetime to set.
  - getObsGroup
```
public Obs getObsGroup()
```
    An obs grouping occurs when the question (#getConcept()) is a set. (@link org.openmrs.Concept#isSet()) If this is non-null, it means the current Obs is in the list returned by obsGroup.getGroupMembers()
    
    Returns:
    
    the Obs that is the grouping factor
  - setObsGroup
```
public void setObsGroup(Obs obsGroup)
```
    This method does NOT add this current obs to the list of obs in obsGroup.getGroupMembers(). That must be done (and should be done) manually. (I am not doing it here for fear of screwing up the normal loading and creation of this object via hibernate/spring)
    
    Parameters:
    
    obsGroup - the obsGroup to set
  - isObsGrouping
```
public boolean isObsGrouping()
```
    Convenience method that checks for if this obs has 1 or more group members (either voided or non-voided) Note this method differs from hasGroupMembers(), as that method excludes voided obs; logic is that while a obs that has only voided group members should be seen as "having no group members" it still should be considered an "obs grouping"
    NOTE: This method could also be called "isObsGroup" for a little less confusion on names. However, jstl in a web layer (or any psuedo-getter) access isn't good with both an "isObsGroup" method and a "getObsGroup" method. Which one should be returned with a simplified jstl call like ${obs.obsGroup} ? With this setup, ${obs.obsGrouping} returns a boolean of whether this obs is a parent and has members. ${obs.obsGroup} returns the parent object to this obs if this obs is a group member of some other group.
    
    Returns:
    
    true if this is the parent group of other obs
  - hasGroupMembers
```
public boolean hasGroupMembers()
```
    A convenience method to check for nullity and length to determine if this obs has group members. By default, this ignores voided-objects. To include voided, use hasGroupMembers(boolean) with value true.
    
    Returns:
    
    true if this is the parent group of other obs Should not include voided obs
  - hasGroupMembers
```
public boolean hasGroupMembers(boolean includeVoided)
```
    Convenience method that checks for nullity and length to determine if this obs has group members. The parameter specifies if this method whether or not voided obs should be considered.
    
    Parameters:
    
    includeVoided - determines if Voided members should be considered as group members.
    
    Returns:
    
    true if this is the parent group of other Obs Should return true if this obs has group members based on parameter
  - getGroupMembers
```
public Set<Obs> getGroupMembers()
```
    Get the non-voided members of the obs group, if this obs is a group. By default this method only returns non-voided group members. To get all group members, use getGroupMembers(boolean) with value true.
    If it's not a group (i.e. getConcept().Concept.getSet() is not true, then this returns null.
    
    Returns:
    
    a Set<Obs> of the members of this group.
    
    See Also:
    
    addGroupMember(Obs), hasGroupMembers()
  - getGroupMembers
```
public Set<Obs> getGroupMembers(boolean includeVoided)
```
    Get the group members of this obs group, if this obs is a group. This method will either return all group members, or only non-voided group members, depending on if the argument is set to be true or false respectively.
    
    Parameters:
    
    includeVoided -
    
    Returns:
    
    the set of group members in this obs group Should Get all group members if passed true, and non-voided if passed false
  - setGroupMembers
```
public void setGroupMembers(Set<Obs> groupMembers)
```
    Set the members of the obs group, if this obs is a group.
    If it's not a group (i.e. getConcept().Concept.getSet() is not true, then this returns null.
    
    Parameters:
    
    groupMembers - the groupedObs to set
    
    See Also:
    
    addGroupMember(Obs), Should mark the obs as dirty when the set is changed from null to a non empty one Should not mark the obs as dirty when the set is changed from null to an empty one Should mark the obs as dirty when the set is replaced with another with different members Should not mark the obs as dirty when the set is replaced with another with same members
  - addGroupMember
```
public void addGroupMember(Obs member)
```
    Convenience method to add the given obs to this grouping. Will implicitly make this obs an ObsGroup.
    
    Parameters:
    
    member - Obs to add to this group
    
    See Also:
    
    setGroupMembers(Set), Should return true when a new obs is added as a member Should return false when a duplicate obs is added as a member
  - removeGroupMember
```
public void removeGroupMember(Obs member)
```
    Convenience method to remove an Obs from this grouping This also removes the link in the given obsobject to this obs grouper
    
    Parameters:
    
    member - Obs to remove from this group
    
    See Also:
    
    setGroupMembers(Set), Should return true when an obs is removed Should return false when a non existent obs is removed
  - getRelatedObservations
```
public Set<Obs> getRelatedObservations()
```
    Convenience method that returns related Obs If the Obs argument is not an ObsGroup: a Set<Obs> will be returned containing all of the children of this Obs' parent that are not ObsGroups themselves. This will include this Obs by default, unless getObsGroup() returns null, in which case an empty set is returned. If the Obs argument is an ObsGroup: a Set<Obs> will be returned containing 1. all of this Obs' group members, and 2. all ancestor Obs that are not themselves obsGroups.
    
    Returns:
    
    Set<Obs>
  - getObsId
```
public Integer getObsId()
```
    Returns:
    
    Returns the obsId.
  - setObsId
```
public void setObsId(Integer obsId)
```
    Parameters:
    
    obsId - The obsId to set.
  - getOrder
```
public Order getOrder()
```
    Returns:
    
    Returns the order.
  - setOrder
```
public void setOrder(Order order)
```
    Parameters:
    
    order - The order to set.
  - getPersonId
```
public Integer getPersonId()
```
    The person id of the person on this object. This should be the same as getPerson().getPersonId(). It is duplicated here for speed and simplicity reasons
    
    Returns:
    
    the integer person id of the person this obs is acting on
  - setPersonId
```
protected void setPersonId(Integer personId)
```
    Set the person id on this obs object. This method is here for convenience, but really the setPerson(Person) method should be used like setPerson(new Person(personId))
    
    Parameters:
    
    personId -
    
    See Also:
    
    setPerson(Person)
  - getPerson
```
public Person getPerson()
```
    Get the person object that this obs is acting on.
    
    Returns:
    
    the person object
    
    See Also:
    
    getPersonId()
  - setPerson
```
public void setPerson(Person person)
```
    Set the person object to this obs object. This will also set the personId on this obs object
    
    Parameters:
    
    person - the Patient/Person object that this obs is acting on
    
    See Also:
    
    setPersonId(Integer)
  - setValueBoolean
```
public void setValueBoolean(Boolean valueBoolean)
```
    Sets the value of this obs to the specified valueBoolean if this obs has a boolean concept.
    
    Parameters:
    
    valueBoolean - the boolean value matching the boolean coded concept to set to
  - getValueAsBoolean
```
public Boolean getValueAsBoolean()
```
    Coerces a value to a Boolean representation
    
    Returns:
    
    Boolean representation of the obs value Should return true for value_numeric concepts if value is 1 Should return false for value_numeric concepts if value is 0 Should return null for value_numeric concepts if value is neither 1 nor 0
  - getValueBoolean
```
public Boolean getValueBoolean()
```
    Returns the boolean value if the concept of this obs is of boolean datatype
    
    Returns:
    
    true or false if value is set otherwise null Should return true if value coded answer concept is true concept Should return false if value coded answer concept is false concept
  - getValueCoded
```
public Concept getValueCoded()
```
    Returns:
    
    Returns the valueCoded.
  - setValueCoded
```
public void setValueCoded(Concept valueCoded)
```
    Parameters:
    
    valueCoded - The valueCoded to set.
  - getValueCodedName
```
public ConceptName getValueCodedName()
```
    Gets the specific name used for the coded value.
    
    Returns:
    
    the name of the coded value
  - setValueCodedName
```
public void setValueCodedName(ConceptName valueCodedName)
```
    Sets the specific name used for the coded value.
    
    Parameters:
    
    valueCodedName - the name of the coded value
  - getValueDrug
```
public Drug getValueDrug()
```
    Returns:
    
    Returns the valueDrug
  - setValueDrug
```
public void setValueDrug(Drug valueDrug)
```
    Parameters:
    
    valueDrug - The valueDrug to set.
  - getValueDatetime
```
public Date getValueDatetime()
```
    Returns:
    
    Returns the valueDatetime.
  - setValueDatetime
```
public void setValueDatetime(Date valueDatetime)
```
    Parameters:
    
    valueDatetime - The valueDatetime to set.
  - getValueDate
```
public Date getValueDate()
```
    Returns:
    
    the value of this obs as a Date. Note that this uses a java.util.Date, so it includes a time component, that should be ignored.
    
    Since:
    
    1.9
  - setValueDate
```
public void setValueDate(Date valueDate)
```
    Parameters:
    
    valueDate - The date value to set.
    
    Since:
    
    1.9
  - getValueTime
```
public Date getValueTime()
```
    Returns:
    
    the time value of this obs. Note that this uses a java.util.Date, so it includes a date component, that should be ignored.
    
    Since:
    
    1.9
  - setValueTime
```
public void setValueTime(Date valueTime)
```
    Parameters:
    
    valueTime - the time value to set
    
    Since:
    
    1.9
  - getValueGroupId
```
public Integer getValueGroupId()
```
    Returns:
    
    Returns the valueGroupId.
  - setValueGroupId
```
public void setValueGroupId(Integer valueGroupId)
```
    Parameters:
    
    valueGroupId - The valueGroupId to set.
  - getValueModifier
```
public String getValueModifier()
```
    Returns:
    
    Returns the valueModifier.
  - setValueModifier
```
public void setValueModifier(String valueModifier)
```
    Parameters:
    
    valueModifier - The valueModifier to set.
  - getValueNumeric
```
public Double getValueNumeric()
```
    Returns:
    
    Returns the valueNumeric.
  - setValueNumeric
```
public void setValueNumeric(Double valueNumeric)
```
    Parameters:
    
    valueNumeric - The valueNumeric to set.
  - getValueText
```
public String getValueText()
```
    Returns:
    
    Returns the valueText.
  - setValueText
```
public void setValueText(String valueText)
```
    Parameters:
    
    valueText - The valueText to set.
  - isComplex
```
public boolean isComplex()
```
    Returns:
    
    Returns true if this Obs is complex.
    
    Since:
    
    1.5 Should return true if the concept is complex
  - getValueComplex
```
public String getValueComplex()
```
    Get the value for the ComplexData. This method is used by the ComplexObsHandler. The valueComplex has two parts separated by a bar '|' character: part A) the title; and part B) the URI. The title is the readable description of the valueComplex that is returned by getValueAsString(java.util.Locale). The URI is the location where the ComplexData is stored.
    
    Returns:
    
    readable title and URI for the location of the ComplexData binary object.
    
    Since:
    
    1.5
  - setValueComplex
```
public void setValueComplex(String valueComplex)
```
    Set the value for the ComplexData. This method is used by the ComplexObsHandler. The valueComplex has two parts separated by a bar '|' character: part A) the title; and part B) the URI. The title is the readable description of the valueComplex that is returned by getValueAsString(java.util.Locale). The URI is the location where the ComplexData is stored.
    
    Parameters:
    
    valueComplex - readable title and URI for the location of the ComplexData binary object.
    
    Since:
    
    1.5
  - setComplexData
```
public void setComplexData(ComplexData complexData)
```
    Set the ComplexData for this Obs. The ComplexData is stored in the file system or elsewhere, but is not persisted to the database.
    
    ComplexObsHandlers that are registered to ConceptComplexs will persist the ComplexData.getData() object to the correct place for the given concept.
    
    Parameters:
    
    complexData -
    
    Since:
    
    1.5
  - getComplexData
```
public ComplexData getComplexData()
```
    Get the ComplexData. This is retrieved by the ComplexObsHandler from the file system or another location, not from the database.
    
    This will be null unless you call:
```
 Obs obsWithComplexData =
 Context.getObsService().getComplexObs(obsId, OpenmrsConstants.RAW_VIEW);
 
 
```
    Returns:
    
    the complex data for this obs (if its a complex obs)
    
    Since:
    
    1.5
  - getAccessionNumber
```
public String getAccessionNumber()
```
    Returns:
    
    Returns the accessionNumber.
  - setAccessionNumber
```
public void setAccessionNumber(String accessionNumber)
```
    Parameters:
    
    accessionNumber - The accessionNumber to set.
  - getValueAsString
```
public String getValueAsString(Locale locale)
```
    Convenience method for obtaining the observation's value as a string If the Obs is complex, returns the title of the complexData denoted by the section of getValueComplex() before the first bar '|' character; or returns the entire getValueComplex() if the bar '|' character is missing.
    
    Parameters:
    
    locale - locale for locale-specific depictions of value Should return first part of valueComplex for complex obs Should return first part of valueComplex for non null valueComplexes Should return non precise values for NumericConcepts Should return date in correct format Should not return long decimal numbers as scientific notation Should use commas or decimal places depending on locale Should not use thousand separator Should return regular number for size of zero to or greater than ten digits Should return regular number if decimal places are as high as six
  - setValueAsString
```
public void setValueAsString(String s)
                      throws ParseException
```
    Sets the value for the obs from a string depending on the datatype of the question concept
    
    Parameters:
    
    s - the string to coerce to a boolean Should set value as boolean if the datatype of the question concept is boolean Should fail if the value of the string is null Should fail if the value of the string is empty
    
    Throws:
    
    ParseException
  - 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()
  - 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)
  - getPreviousVersion
```
public Obs getPreviousVersion()
```
    When ObsService updates an obs, it voids the old version, creates a new Obs with the updates, and adds a reference to the previousVersion in the new Obs. getPreviousVersion returns the last version of this Obs.
  - setPreviousVersion
```
public void setPreviousVersion(Obs previousVersion)
```
    A previousVersion indicates that this Obs replaces an earlier one.
    
    Parameters:
    
    previousVersion - the Obs that this Obs superceeds
  - hasPreviousVersion
```
public Boolean hasPreviousVersion()
```
  - setCreator
```
public void setCreator(User creator)
```
    Specified by:
    
    setCreator in interface Creatable
    
    Overrides:
    
    setCreator in class BaseOpenmrsData
    
    Parameters:
    
    creator -
    
    See Also:
    
    Creatable.setCreator(User)
  - setDateCreated
```
public void setDateCreated(Date dateCreated)
```
    Specified by:
    
    setDateCreated in interface Creatable
    
    Overrides:
    
    setDateCreated in class BaseOpenmrsData
    
    Parameters:
    
    dateCreated -
    
    See Also:
    
    Creatable.setDateCreated(Date)
  - setFormField
```
public void setFormField(String namespace,
                         String formFieldPath)
```
    Description copied from interface: FormRecordable
    
    Sets the namespace and path of the form field that was used to capture the obs details in the form.
    Note: Namespace and formFieldPath together must not exceed 254 characters in length, form applications can subtract the length of their namespace from 254 to determine the maximum length they can use for a form field path.
    
    Specified by:
    
    setFormField in interface FormRecordable
    
    Overrides:
    
    setFormField in class BaseFormRecordableOpenmrsData
    
    Parameters:
    
    namespace - the namespace of the form field
    
    formFieldPath - the path of the form field
    
    See Also:
    
    FormRecordable.setFormField(String,String)
  - isDirty
```
public boolean isDirty()
```
    Returns true if any change has been made to an Obs instance. In general, the only time isDirty() is going to return false is when a new Obs has just been instantiated or loaded from the database and no method that modifies it internally has been invoked.
    
    Returns:
    
    true if not changed otherwise false
    
    Since:
    
    2.0 Should return false when no change has been made Should return true when any immutable field has been changed Should return false when only mutable fields are changed Should return true when an immutable field is changed from a null to a non null value Should return true when an immutable field is changed from a non null to a null value
  - markAsDirty
```
protected void markAsDirty(Object oldValue,
                           Object newValue)
```
  - getInterpretation
```
public Obs.Interpretation getInterpretation()
```
    Similar to FHIR's Observation.interpretation. Supports a subset of FHIR's Observation Interpretation Codes. See https://www.hl7.org/fhir/valueset-observation-interpretation.html
    
    Since:
    
    2.1.0
  - setInterpretation
```
public void setInterpretation(Obs.Interpretation interpretation)
```
    Since:
    
    2.1.0
  - getStatus
```
public Obs.Status getStatus()
```
    Similar to FHIR's Observation.status. Supports a subset of FHIR's ObservationStatus values. At present OpenMRS does not support FHIR's REGISTERED and CANCELLED statuses, because we don't support obs with null values. See: https://www.hl7.org/fhir/valueset-observation-status.html
    
    Since:
    
    2.1.0
  - setStatus
```
public void setStatus(Obs.Status status)
```
    Since:
    
    2.1.0

Class Obs

Nested Class Summary

Field Summary

Fields inherited from class org.openmrs.BaseFormRecordableOpenmrsData

Fields inherited from class org.openmrs.BaseOpenmrsData

Constructor Summary

Method Summary

Methods inherited from class org.openmrs.BaseFormRecordableOpenmrsData

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

obsId

concept

obsDatetime

accessionNumber

obsGroup

groupMembers

valueCoded

valueCodedName

valueDrug

valueGroupId

valueDatetime

valueNumeric

valueModifier

valueText

valueComplex

complexData

comment

personId

person

order

location

encounter

Constructor Detail

Obs

Obs

Obs

Method Detail

newInstance

getComment

setComment

getConcept

setConcept

getConceptDescription

getEncounter

setEncounter

getLocation

setLocation

getObsDatetime

setObsDatetime

getObsGroup

setObsGroup

isObsGrouping

hasGroupMembers

hasGroupMembers

getGroupMembers

getGroupMembers

setGroupMembers

addGroupMember

removeGroupMember

getRelatedObservations

getObsId

setObsId

getOrder

setOrder

getPersonId

setPersonId

getPerson

setPerson

setValueBoolean

getValueAsBoolean

getValueBoolean

getValueCoded

setValueCoded

getValueCodedName

setValueCodedName

getValueDrug