Observation (HAPI FHIR Structures - HL7.org DSTU2 3.3.0 API)

java.lang.Object
- org.hl7.fhir.instance.model.Base
- - org.hl7.fhir.instance.model.BaseResource
  - - org.hl7.fhir.instance.model.Resource
    - - org.hl7.fhir.instance.model.DomainResource
      - org.hl7.fhir.instance.model.Observation

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
```
public class Observation
extends DomainResource
```
Measurements and simple assertions made about a patient, device or other subject.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Observation.ObservationComponentComponent`
`static class`	`Observation.ObservationReferenceRangeComponent`
`static class`	`Observation.ObservationRelatedComponent`
`static class`	`Observation.ObservationRelationshipType`
`static class`	`Observation.ObservationRelationshipTypeEnumFactory`
`static class`	`Observation.ObservationStatus`
`static class`	`Observation.ObservationStatusEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`protected CodeableConcept`	`bodySite` Indicates the site on the subject's body where the observation was made (i.e.
`protected CodeableConcept`	`category` A code that classifies the general type of observation being made.
`protected CodeableConcept`	`code` Describes what was observed.
`protected StringType`	`comments` May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.
`protected List<Observation.ObservationComponentComponent>`	`component` Some observations have multiple component observations.
`protected CodeableConcept`	`dataAbsentReason` Provides a reason why the expected value in the element Observation.value[x] is missing.
`protected Reference`	`device` The device used to generate the observation data.
`protected Resource`	`deviceTarget` The actual object that is the target of the reference (The device used to generate the observation data.)
`protected Type`	`effective` The time or time-period the observed value is asserted as being true.
`protected Reference`	`encounter` The healthcare event (e.g.
`protected Encounter`	`encounterTarget` The actual object that is the target of the reference (The healthcare event (e.g.
`protected List<Identifier>`	`identifier` A unique identifier for the simple observation instance.
`protected CodeableConcept`	`interpretation` The assessment made based on the result of the observation.
`protected InstantType`	`issued` The date and time this observation was made available to providers, typically after the results have been reviewed and verified.
`protected CodeableConcept`	`method` Indicates the mechanism used to perform the observation.
`protected List<Reference>`	`performer` Who was responsible for asserting the observed value as "true".
`protected List<Resource>`	`performerTarget` The actual objects that are the target of the reference (Who was responsible for asserting the observed value as "true".)
`protected List<Observation.ObservationReferenceRangeComponent>`	`referenceRange` Guidance on how to interpret the value by comparison to a normal or recommended range.
`protected List<Observation.ObservationRelatedComponent>`	`related` A reference to another resource (usually another Observation but could also be a QuestionnaireAnswer) whose relationship is defined by the relationship type code.
`static String`	`SP_CATEGORY`
`static String`	`SP_CODE`
`static String`	`SP_CODEVALUEX`
`static String`	`SP_COMPONENTCODE`
`static String`	`SP_COMPONENTCODEVALUEX`
`static String`	`SP_COMPONENTDATAABSENTREASON`
`static String`	`SP_COMPONENTVALUECONCEPT`
`static String`	`SP_COMPONENTVALUEQUANTITY`
`static String`	`SP_COMPONENTVALUESTRING`
`static String`	`SP_DATAABSENTREASON`
`static String`	`SP_DATE`
`static String`	`SP_DEVICE`
`static String`	`SP_ENCOUNTER`
`static String`	`SP_IDENTIFIER`
`static String`	`SP_PATIENT`
`static String`	`SP_PERFORMER`
`static String`	`SP_RELATED`
`static String`	`SP_RELATEDTARGET`
`static String`	`SP_RELATEDTYPE`
`static String`	`SP_SPECIMEN`
`static String`	`SP_STATUS`
`static String`	`SP_SUBJECT`
`static String`	`SP_VALUECONCEPT`
`static String`	`SP_VALUEDATE`
`static String`	`SP_VALUEQUANTITY`
`static String`	`SP_VALUESTRING`
`protected Reference`	`specimen` The specimen that was used when this observation was made.
`protected Specimen`	`specimenTarget` The actual object that is the target of the reference (The specimen that was used when this observation was made.)
`protected Enumeration<Observation.ObservationStatus>`	`status` The status of the result value.
`protected Reference`	`subject` The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed.
`protected Resource`	`subjectTarget` The actual object that is the target of the reference (The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed.
`protected Type`	`value` The information determined as a result of making the observation, if the information has a simple value.

Fields inherited from class org.hl7.fhir.instance.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.instance.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

Observation()

Observation(Enumeration<Observation.ObservationStatus> status, CodeableConcept code)

Constructors
Constructor and Description
`Observation()`
`Observation(Enumeration<Observation.ObservationStatus> status, CodeableConcept code)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Observation.ObservationComponentComponent`	`addComponent()`
`Observation`	`addComponent(Observation.ObservationComponentComponent t)`
`Identifier`	`addIdentifier()`
`Observation`	`addIdentifier(Identifier t)`
`Reference`	`addPerformer()`
`Observation`	`addPerformer(Reference t)`
`Observation.ObservationReferenceRangeComponent`	`addReferenceRange()`
`Observation`	`addReferenceRange(Observation.ObservationReferenceRangeComponent t)`
`Observation.ObservationRelatedComponent`	`addRelated()`
`Observation`	`addRelated(Observation.ObservationRelatedComponent t)`
`Observation`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`CodeableConcept`	`getBodySite()`
`CodeableConcept`	`getCategory()`
`CodeableConcept`	`getCode()`
`String`	`getComments()`
`StringType`	`getCommentsElement()`
`List<Observation.ObservationComponentComponent>`	`getComponent()`
`CodeableConcept`	`getDataAbsentReason()`
`Reference`	`getDevice()`
`Resource`	`getDeviceTarget()`
`Type`	`getEffective()`
`DateTimeType`	`getEffectiveDateTimeType()`
`Period`	`getEffectivePeriod()`
`Reference`	`getEncounter()`
`Encounter`	`getEncounterTarget()`
`List<Identifier>`	`getIdentifier()`
`CodeableConcept`	`getInterpretation()`
`Date`	`getIssued()`
`InstantType`	`getIssuedElement()`
`CodeableConcept`	`getMethod()`
`List<Reference>`	`getPerformer()`
`List<Resource>`	`getPerformerTarget()`
`List<Observation.ObservationReferenceRangeComponent>`	`getReferenceRange()`
`List<Observation.ObservationRelatedComponent>`	`getRelated()`
`ResourceType`	`getResourceType()`
`Reference`	`getSpecimen()`
`Specimen`	`getSpecimenTarget()`
`Observation.ObservationStatus`	`getStatus()`
`Enumeration<Observation.ObservationStatus>`	`getStatusElement()`
`Reference`	`getSubject()`
`Resource`	`getSubjectTarget()`
`Type`	`getValue()`
`Attachment`	`getValueAttachment()`
`CodeableConcept`	`getValueCodeableConcept()`
`DateTimeType`	`getValueDateTimeType()`
`Period`	`getValuePeriod()`
`Quantity`	`getValueQuantity()`
`Range`	`getValueRange()`
`Ratio`	`getValueRatio()`
`SampledData`	`getValueSampledData()`
`StringType`	`getValueStringType()`
`TimeType`	`getValueTimeType()`
`boolean`	`hasBodySite()`
`boolean`	`hasCategory()`
`boolean`	`hasCode()`
`boolean`	`hasComments()`
`boolean`	`hasCommentsElement()`
`boolean`	`hasComponent()`
`boolean`	`hasDataAbsentReason()`
`boolean`	`hasDevice()`
`boolean`	`hasEffective()`
`boolean`	`hasEffectiveDateTimeType()`
`boolean`	`hasEffectivePeriod()`
`boolean`	`hasEncounter()`
`boolean`	`hasIdentifier()`
`boolean`	`hasInterpretation()`
`boolean`	`hasIssued()`
`boolean`	`hasIssuedElement()`
`boolean`	`hasMethod()`
`boolean`	`hasPerformer()`
`boolean`	`hasReferenceRange()`
`boolean`	`hasRelated()`
`boolean`	`hasSpecimen()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasSubject()`
`boolean`	`hasValue()`
`boolean`	`hasValueAttachment()`
`boolean`	`hasValueCodeableConcept()`
`boolean`	`hasValueDateTimeType()`
`boolean`	`hasValuePeriod()`
`boolean`	`hasValueQuantity()`
`boolean`	`hasValueRange()`
`boolean`	`hasValueRatio()`
`boolean`	`hasValueSampledData()`
`boolean`	`hasValueStringType()`
`boolean`	`hasValueTimeType()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Observation`	`setBodySite(CodeableConcept value)`
`Observation`	`setCategory(CodeableConcept value)`
`Observation`	`setCode(CodeableConcept value)`
`Observation`	`setComments(String value)`
`Observation`	`setCommentsElement(StringType value)`
`Observation`	`setDataAbsentReason(CodeableConcept value)`
`Observation`	`setDevice(Reference value)`
`Observation`	`setDeviceTarget(Resource value)`
`Observation`	`setEffective(Type value)`
`Observation`	`setEncounter(Reference value)`
`Observation`	`setEncounterTarget(Encounter value)`
`Observation`	`setInterpretation(CodeableConcept value)`
`Observation`	`setIssued(Date value)`
`Observation`	`setIssuedElement(InstantType value)`
`Observation`	`setMethod(CodeableConcept value)`
`void`	`setProperty(String name, Base value)`
`Observation`	`setSpecimen(Reference value)`
`Observation`	`setSpecimenTarget(Specimen value)`
`Observation`	`setStatus(Observation.ObservationStatus value)`
`Observation`	`setStatusElement(Enumeration<Observation.ObservationStatus> value)`
`Observation`	`setSubject(Reference value)`
`Observation`	`setSubjectTarget(Resource value)`
`Observation`	`setValue(Type value)`
`protected Observation`	`typedCopy()`

Methods inherited from class org.hl7.fhir.instance.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.instance.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, getStructureFhirVersionEnum, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.instance.model.BaseResource
setId

Methods inherited from class org.hl7.fhir.instance.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINN

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    A unique identifier for the simple observation instance.
  - status
```
protected Enumeration<Observation.ObservationStatus> status
```
    The status of the result value.
  - category
```
protected CodeableConcept category
```
    A code that classifies the general type of observation being made. This is used for searching, sorting and display purposes.
  - code
```
protected CodeableConcept code
```
    Describes what was observed. Sometimes this is called the observation "name".
  - subject
```
protected Reference subject
```
    The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.
  - subjectTarget
```
protected Resource subjectTarget
```
    The actual object that is the target of the reference (The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.)
  - encounter
```
protected Reference encounter
```
    The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
  - encounterTarget
```
protected Encounter encounterTarget
```
    The actual object that is the target of the reference (The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.)
  - effective
```
protected Type effective
```
    The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
  - issued
```
protected InstantType issued
```
    The date and time this observation was made available to providers, typically after the results have been reviewed and verified.
  - performer
```
protected List<Reference> performer
```
    Who was responsible for asserting the observed value as "true".
  - performerTarget
```
protected List<Resource> performerTarget
```
    The actual objects that are the target of the reference (Who was responsible for asserting the observed value as "true".)
  - value
```
protected Type value
```
    The information determined as a result of making the observation, if the information has a simple value.
  - dataAbsentReason
```
protected CodeableConcept dataAbsentReason
```
    Provides a reason why the expected value in the element Observation.value[x] is missing.
  - interpretation
```
protected CodeableConcept interpretation
```
    The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.
  - comments
```
protected StringType comments
```
    May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.
  - bodySite
```
protected CodeableConcept bodySite
```
    Indicates the site on the subject's body where the observation was made (i.e. the target site).
  - method
```
protected CodeableConcept method
```
    Indicates the mechanism used to perform the observation.
  - specimen
```
protected Reference specimen
```
    The specimen that was used when this observation was made.
  - specimenTarget
```
protected Specimen specimenTarget
```
    The actual object that is the target of the reference (The specimen that was used when this observation was made.)
  - device
```
protected Reference device
```
    The device used to generate the observation data.
  - deviceTarget
```
protected Resource deviceTarget
```
    The actual object that is the target of the reference (The device used to generate the observation data.)
  - referenceRange
```
protected List<Observation.ObservationReferenceRangeComponent> referenceRange
```
    Guidance on how to interpret the value by comparison to a normal or recommended range.
  - related
```
protected List<Observation.ObservationRelatedComponent> related
```
    A reference to another resource (usually another Observation but could also be a QuestionnaireAnswer) whose relationship is defined by the relationship type code.
  - component
```
protected List<Observation.ObservationComponentComponent> component
```
    Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
  - SP_DATE
```
public static final String SP_DATE
```
    See Also:
    
    Constant Field Values
  - SP_CODE
```
public static final String SP_CODE
```
    See Also:
    
    Constant Field Values
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    See Also:
    
    Constant Field Values
  - SP_COMPONENTDATAABSENTREASON
```
public static final String SP_COMPONENTDATAABSENTREASON
```
    See Also:
    
    Constant Field Values
  - SP_VALUECONCEPT
```
public static final String SP_VALUECONCEPT
```
    See Also:
    
    Constant Field Values
  - SP_VALUEDATE
```
public static final String SP_VALUEDATE
```
    See Also:
    
    Constant Field Values
  - SP_RELATED
```
public static final String SP_RELATED
```
    See Also:
    
    Constant Field Values
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    See Also:
    
    Constant Field Values
  - SP_SPECIMEN
```
public static final String SP_SPECIMEN
```
    See Also:
    
    Constant Field Values
  - SP_COMPONENTCODE
```
public static final String SP_COMPONENTCODE
```
    See Also:
    
    Constant Field Values
  - SP_VALUESTRING
```
public static final String SP_VALUESTRING
```
    See Also:
    
    Constant Field Values
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - SP_COMPONENTCODEVALUEX
```
public static final String SP_COMPONENTCODEVALUEX
```
    See Also:
    
    Constant Field Values
  - SP_CODEVALUEX
```
public static final String SP_CODEVALUEX
```
    See Also:
    
    Constant Field Values
  - SP_PERFORMER
```
public static final String SP_PERFORMER
```
    See Also:
    
    Constant Field Values
  - SP_VALUEQUANTITY
```
public static final String SP_VALUEQUANTITY
```
    See Also:
    
    Constant Field Values
  - SP_COMPONENTVALUEQUANTITY
```
public static final String SP_COMPONENTVALUEQUANTITY
```
    See Also:
    
    Constant Field Values
  - SP_DATAABSENTREASON
```
public static final String SP_DATAABSENTREASON
```
    See Also:
    
    Constant Field Values
  - SP_ENCOUNTER
```
public static final String SP_ENCOUNTER
```
    See Also:
    
    Constant Field Values
  - SP_RELATEDTYPE
```
public static final String SP_RELATEDTYPE
```
    See Also:
    
    Constant Field Values
  - SP_RELATEDTARGET
```
public static final String SP_RELATEDTARGET
```
    See Also:
    
    Constant Field Values
  - SP_COMPONENTVALUESTRING
```
public static final String SP_COMPONENTVALUESTRING
```
    See Also:
    
    Constant Field Values
  - SP_COMPONENTVALUECONCEPT
```
public static final String SP_COMPONENTVALUECONCEPT
```
    See Also:
    
    Constant Field Values
  - SP_CATEGORY
```
public static final String SP_CATEGORY
```
    See Also:
    
    Constant Field Values
  - SP_DEVICE
```
public static final String SP_DEVICE
```
    See Also:
    
    Constant Field Values
  - SP_STATUS
```
public static final String SP_STATUS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Observation
```
public Observation()
```
  - Observation
```
public Observation(Enumeration<Observation.ObservationStatus> status,
                   CodeableConcept code)
```
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (A unique identifier for the simple observation instance.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    Returns:
    
    identifier (A unique identifier for the simple observation instance.)
  - addIdentifier
```
public Observation addIdentifier(Identifier t)
```
  - getStatusElement
```
public Enumeration<Observation.ObservationStatus> getStatusElement()
```
    Returns:
    
    status (The status of the result value.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - setStatusElement
```
public Observation setStatusElement(Enumeration<Observation.ObservationStatus> value)
```
    Parameters:
    
    value - status (The status of the result value.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public Observation.ObservationStatus getStatus()
```
    Returns:
    
    The status of the result value.
  - setStatus
```
public Observation setStatus(Observation.ObservationStatus value)
```
    Parameters:
    
    value - The status of the result value.
  - getCategory
```
public CodeableConcept getCategory()
```
    Returns:
    
    category (A code that classifies the general type of observation being made. This is used for searching, sorting and display purposes.)
  - hasCategory
```
public boolean hasCategory()
```
  - setCategory
```
public Observation setCategory(CodeableConcept value)
```
    Parameters:
    
    value - category (A code that classifies the general type of observation being made. This is used for searching, sorting and display purposes.)
  - getCode
```
public CodeableConcept getCode()
```
    Returns:
    
    code (Describes what was observed. Sometimes this is called the observation "name".)
  - hasCode
```
public boolean hasCode()
```
  - setCode
```
public Observation setCode(CodeableConcept value)
```
    Parameters:
    
    value - code (Describes what was observed. Sometimes this is called the observation "name".)
  - getSubject
```
public Reference getSubject()
```
    Returns:
    
    subject (The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.)
  - hasSubject
```
public boolean hasSubject()
```
  - setSubject
```
public Observation setSubject(Reference value)
```
    Parameters:
    
    value - subject (The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.)
  - getSubjectTarget
```
public Resource getSubjectTarget()
```
    Returns:
    
    subject The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.)
  - setSubjectTarget
```
public Observation setSubjectTarget(Resource value)
```
    Parameters:
    
    value - subject The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.)
  - getEncounter
```
public Reference getEncounter()
```
    Returns:
    
    encounter (The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.)
  - hasEncounter
```
public boolean hasEncounter()
```
  - setEncounter
```
public Observation setEncounter(Reference value)
```
    Parameters:
    
    value - encounter (The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.)
  - getEncounterTarget
```
public Encounter getEncounterTarget()
```
    Returns:
    
    encounter The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.)
  - setEncounterTarget
```
public Observation setEncounterTarget(Encounter value)
```
    Parameters:
    
    value - encounter The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.)
  - getEffective
```
public Type getEffective()
```
    Returns:
    
    effective (The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.)
  - getEffectiveDateTimeType
```
public DateTimeType getEffectiveDateTimeType()
                                      throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    effective (The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasEffectiveDateTimeType
```
public boolean hasEffectiveDateTimeType()
```
  - getEffectivePeriod
```
public Period getEffectivePeriod()
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    effective (The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasEffectivePeriod
```
public boolean hasEffectivePeriod()
```
  - hasEffective
```
public boolean hasEffective()
```
  - setEffective
```
public Observation setEffective(Type value)
```
    Parameters:
    
    value - effective (The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.)
  - getIssuedElement
```
public InstantType getIssuedElement()
```
    Returns:
    
    issued (The date and time this observation was made available to providers, typically after the results have been reviewed and verified.). This is the underlying object with id, value and extensions. The accessor "getIssued" gives direct access to the value
  - hasIssuedElement
```
public boolean hasIssuedElement()
```
  - hasIssued
```
public boolean hasIssued()
```
  - setIssuedElement
```
public Observation setIssuedElement(InstantType value)
```
    Parameters:
    
    value - issued (The date and time this observation was made available to providers, typically after the results have been reviewed and verified.). This is the underlying object with id, value and extensions. The accessor "getIssued" gives direct access to the value
  - getIssued
```
public Date getIssued()
```
    Returns:
    
    The date and time this observation was made available to providers, typically after the results have been reviewed and verified.
  - setIssued
```
public Observation setIssued(Date value)
```
    Parameters:
    
    value - The date and time this observation was made available to providers, typically after the results have been reviewed and verified.
  - getPerformer
```
public List<Reference> getPerformer()
```
    Returns:
    
    performer (Who was responsible for asserting the observed value as "true".)
  - hasPerformer
```
public boolean hasPerformer()
```
  - addPerformer
```
public Reference addPerformer()
```
    Returns:
    
    performer (Who was responsible for asserting the observed value as "true".)
  - addPerformer
```
public Observation addPerformer(Reference t)
```
  - getPerformerTarget
```
public List<Resource> getPerformerTarget()
```
    Returns:
    
    performer (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Who was responsible for asserting the observed value as "true".)
  - getValue
```
public Type getValue()
```
    Returns:
    
    value (The information determined as a result of making the observation, if the information has a simple value.)
  - getValueQuantity
```
public Quantity getValueQuantity()
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    value (The information determined as a result of making the observation, if the information has a simple value.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasValueQuantity
```
public boolean hasValueQuantity()
```
  - getValueCodeableConcept
```
public CodeableConcept getValueCodeableConcept()
                                        throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    value (The information determined as a result of making the observation, if the information has a simple value.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasValueCodeableConcept
```
public boolean hasValueCodeableConcept()
```
  - getValueStringType
```
public StringType getValueStringType()
                              throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    value (The information determined as a result of making the observation, if the information has a simple value.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasValueStringType
```
public boolean hasValueStringType()
```
  - getValueRange
```
public Range getValueRange()
                    throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    value (The information determined as a result of making the observation, if the information has a simple value.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasValueRange
```
public boolean hasValueRange()
```
  - getValueRatio
```
public Ratio getValueRatio()
                    throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    value (The information determined as a result of making the observation, if the information has a simple value.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasValueRatio
```
public boolean hasValueRatio()
```
  - getValueSampledData
```
public SampledData getValueSampledData()
                                throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    value (The information determined as a result of making the observation, if the information has a simple value.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasValueSampledData
```
public boolean hasValueSampledData()
```
  - getValueAttachment
```
public Attachment getValueAttachment()
                              throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    value (The information determined as a result of making the observation, if the information has a simple value.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasValueAttachment
```
public boolean hasValueAttachment()
```
  - getValueTimeType
```
public TimeType getValueTimeType()
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    value (The information determined as a result of making the observation, if the information has a simple value.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasValueTimeType
```
public boolean hasValueTimeType()
```
  - getValueDateTimeType
```
public DateTimeType getValueDateTimeType()
                                  throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    value (The information determined as a result of making the observation, if the information has a simple value.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasValueDateTimeType
```
public boolean hasValueDateTimeType()
```
  - getValuePeriod
```
public Period getValuePeriod()
                      throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    value (The information determined as a result of making the observation, if the information has a simple value.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasValuePeriod
```
public boolean hasValuePeriod()
```
  - hasValue
```
public boolean hasValue()
```
  - setValue
```
public Observation setValue(Type value)
```
    Parameters:
    
    value - value (The information determined as a result of making the observation, if the information has a simple value.)
  - getDataAbsentReason
```
public CodeableConcept getDataAbsentReason()
```
    Returns:
    
    dataAbsentReason (Provides a reason why the expected value in the element Observation.value[x] is missing.)
  - hasDataAbsentReason
```
public boolean hasDataAbsentReason()
```
  - setDataAbsentReason
```
public Observation setDataAbsentReason(CodeableConcept value)
```
    Parameters:
    
    value - dataAbsentReason (Provides a reason why the expected value in the element Observation.value[x] is missing.)
  - getInterpretation
```
public CodeableConcept getInterpretation()
```
    Returns:
    
    interpretation (The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.)
  - hasInterpretation
```
public boolean hasInterpretation()
```
  - setInterpretation
```
public Observation setInterpretation(CodeableConcept value)
```
    Parameters:
    
    value - interpretation (The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.)
  - getCommentsElement
```
public StringType getCommentsElement()
```
    Returns:
    
    comments (May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.). This is the underlying object with id, value and extensions. The accessor "getComments" gives direct access to the value
  - hasCommentsElement
```
public boolean hasCommentsElement()
```
  - hasComments
```
public boolean hasComments()
```
  - setCommentsElement
```
public Observation setCommentsElement(StringType value)
```
    Parameters:
    
    value - comments (May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.). This is the underlying object with id, value and extensions. The accessor "getComments" gives direct access to the value
  - getComments
```
public String getComments()
```
    Returns:
    
    May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.
  - setComments
```
public Observation setComments(String value)
```
    Parameters:
    
    value - May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.
  - getBodySite
```
public CodeableConcept getBodySite()
```
    Returns:
    
    bodySite (Indicates the site on the subject's body where the observation was made (i.e. the target site).)
  - hasBodySite
```
public boolean hasBodySite()
```
  - setBodySite
```
public Observation setBodySite(CodeableConcept value)
```
    Parameters:
    
    value - bodySite (Indicates the site on the subject's body where the observation was made (i.e. the target site).)
  - getMethod
```
public CodeableConcept getMethod()
```
    Returns:
    
    method (Indicates the mechanism used to perform the observation.)
  - hasMethod
```
public boolean hasMethod()
```
  - setMethod
```
public Observation setMethod(CodeableConcept value)
```
    Parameters:
    
    value - method (Indicates the mechanism used to perform the observation.)
  - getSpecimen
```
public Reference getSpecimen()
```
    Returns:
    
    specimen (The specimen that was used when this observation was made.)
  - hasSpecimen
```
public boolean hasSpecimen()
```
  - setSpecimen
```
public Observation setSpecimen(Reference value)
```
    Parameters:
    
    value - specimen (The specimen that was used when this observation was made.)
  - getSpecimenTarget
```
public Specimen getSpecimenTarget()
```
    Returns:
    
    specimen The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The specimen that was used when this observation was made.)
  - setSpecimenTarget
```
public Observation setSpecimenTarget(Specimen value)
```
    Parameters:
    
    value - specimen The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The specimen that was used when this observation was made.)
  - getDevice
```
public Reference getDevice()
```
    Returns:
    
    device (The device used to generate the observation data.)
  - hasDevice
```
public boolean hasDevice()
```
  - setDevice
```
public Observation setDevice(Reference value)
```
    Parameters:
    
    value - device (The device used to generate the observation data.)
  - getDeviceTarget
```
public Resource getDeviceTarget()
```
    Returns:
    
    device The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The device used to generate the observation data.)
  - setDeviceTarget
```
public Observation setDeviceTarget(Resource value)
```
    Parameters:
    
    value - device The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The device used to generate the observation data.)
  - getReferenceRange
```
public List<Observation.ObservationReferenceRangeComponent> getReferenceRange()
```
    Returns:
    
    referenceRange (Guidance on how to interpret the value by comparison to a normal or recommended range.)
  - hasReferenceRange
```
public boolean hasReferenceRange()
```
  - addReferenceRange
```
public Observation.ObservationReferenceRangeComponent addReferenceRange()
```
    Returns:
    
    referenceRange (Guidance on how to interpret the value by comparison to a normal or recommended range.)
  - addReferenceRange
```
public Observation addReferenceRange(Observation.ObservationReferenceRangeComponent t)
```
  - getRelated
```
public List<Observation.ObservationRelatedComponent> getRelated()
```
    Returns:
    
    related (A reference to another resource (usually another Observation but could also be a QuestionnaireAnswer) whose relationship is defined by the relationship type code.)
  - hasRelated
```
public boolean hasRelated()
```
  - addRelated
```
public Observation.ObservationRelatedComponent addRelated()
```
    Returns:
    
    related (A reference to another resource (usually another Observation but could also be a QuestionnaireAnswer) whose relationship is defined by the relationship type code.)
  - addRelated
```
public Observation addRelated(Observation.ObservationRelatedComponent t)
```
  - getComponent
```
public List<Observation.ObservationComponentComponent> getComponent()
```
    Returns:
    
    component (Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.)
  - hasComponent
```
public boolean hasComponent()
```
  - addComponent
```
public Observation.ObservationComponentComponent addComponent()
```
    Returns:
    
    component (Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.)
  - addComponent
```
public Observation addComponent(Observation.ObservationComponentComponent t)
```
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - setProperty
```
public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public Observation copy()
```
    Specified by:
    
    copy in class DomainResource
  - typedCopy
```
protected Observation typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class Observation

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.instance.model.DomainResource

Fields inherited from class org.hl7.fhir.instance.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.instance.model.DomainResource

Methods inherited from class org.hl7.fhir.instance.model.Resource

Methods inherited from class org.hl7.fhir.instance.model.BaseResource

Methods inherited from class org.hl7.fhir.instance.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Field Detail

identifier

status

category

code

subject

subjectTarget

encounter

encounterTarget

effective

issued

performer

performerTarget

value

dataAbsentReason

interpretation

comments

bodySite

method

specimen

specimenTarget

device

deviceTarget

referenceRange

related

component

SP_DATE

SP_CODE

SP_SUBJECT

SP_COMPONENTDATAABSENTREASON

SP_VALUECONCEPT

SP_VALUEDATE

SP_RELATED

SP_PATIENT

SP_SPECIMEN

SP_COMPONENTCODE

SP_VALUESTRING

SP_IDENTIFIER

SP_COMPONENTCODEVALUEX

SP_CODEVALUEX

SP_PERFORMER

SP_VALUEQUANTITY

SP_COMPONENTVALUEQUANTITY

SP_DATAABSENTREASON

SP_ENCOUNTER

SP_RELATEDTYPE

SP_RELATEDTARGET

SP_COMPONENTVALUESTRING

SP_COMPONENTVALUECONCEPT

SP_CATEGORY

SP_DEVICE

SP_STATUS

Constructor Detail

Observation

Observation

Method Detail

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getStatusElement

hasStatusElement

hasStatus