public class Observation extends BaseResource implements IResource
Definition: Measurements and simple assertions made about a patient, device or other subject
Requirements: Observations are a key aspect of healthcare. This resource is used to capture those that do not require more sophisticated mechanisms.
Profile Definition: http://hl7.org/fhir/profiles/Observation
| Modifier and Type | Class and Description |
|---|---|
static class |
Observation.ReferenceRange
Block class for child element: Observation.referenceRange (Provides guide for interpretation)
|
static class |
Observation.Related
Block class for child element: Observation.related (Observations related to this observation)
|
| Modifier and Type | Field and Description |
|---|---|
static DateClientParam |
DATE
Fluent Client search parameter constant for date
|
static Include |
INCLUDE_PERFORMER
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_RELATED_TARGET
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_SPECIMEN
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.
|
static TokenClientParam |
NAME
Fluent Client search parameter constant for name
|
static CompositeClientParam<TokenClientParam,TokenClientParam> |
NAME_VALUE_CONCEPT
Fluent Client search parameter constant for name-value-concept
|
static CompositeClientParam<TokenClientParam,DateClientParam> |
NAME_VALUE_DATE
Fluent Client search parameter constant for name-value-date
|
static CompositeClientParam<TokenClientParam,QuantityClientParam> |
NAME_VALUE_QUANTITY
Fluent Client search parameter constant for name-value-quantity
|
static CompositeClientParam<TokenClientParam,StringClientParam> |
NAME_VALUE_STRING
Fluent Client search parameter constant for name-value-string
|
static ReferenceClientParam |
PERFORMER
Fluent Client search parameter constant for performer
|
static ReferenceClientParam |
RELATED_TARGET
Fluent Client search parameter constant for related-target
|
static CompositeClientParam<ReferenceClientParam,TokenClientParam> |
RELATED_TARGET_RELATED_TYPE
Fluent Client search parameter constant for related-target-related-type
|
static TokenClientParam |
RELATED_TYPE
Fluent Client search parameter constant for related-type
|
static TokenClientParam |
RELIABILITY
Fluent Client search parameter constant for reliability
|
static String |
SP_DATE
Search parameter constant for date
|
static String |
SP_NAME
Search parameter constant for name
|
static String |
SP_NAME_VALUE_CONCEPT
Search parameter constant for name-value-concept
|
static String |
SP_NAME_VALUE_DATE
Search parameter constant for name-value-date
|
static String |
SP_NAME_VALUE_QUANTITY
Search parameter constant for name-value-quantity
|
static String |
SP_NAME_VALUE_STRING
Search parameter constant for name-value-string
|
static String |
SP_PERFORMER
Search parameter constant for performer
|
static String |
SP_RELATED_TARGET
Search parameter constant for related-target
|
static String |
SP_RELATED_TARGET_RELATED_TYPE
Search parameter constant for related-target-related-type
|
static String |
SP_RELATED_TYPE
Search parameter constant for related-type
|
static String |
SP_RELIABILITY
Search parameter constant for reliability
|
static String |
SP_SPECIMEN
Search parameter constant for specimen
|
static String |
SP_STATUS
Search parameter constant for status
|
static String |
SP_SUBJECT
Search parameter constant for subject
|
static String |
SP_VALUE_CONCEPT
Search parameter constant for value-concept
|
static String |
SP_VALUE_DATE
Search parameter constant for value-date
|
static String |
SP_VALUE_QUANTITY
Search parameter constant for value-quantity
|
static String |
SP_VALUE_STRING
Search parameter constant for value-string
|
static ReferenceClientParam |
SPECIMEN
Fluent Client search parameter constant for specimen
|
static TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
static ReferenceClientParam |
SUBJECT
Fluent Client search parameter constant for subject
|
static TokenClientParam |
VALUE_CONCEPT
Fluent Client search parameter constant for value-concept
|
static DateClientParam |
VALUE_DATE
Fluent Client search parameter constant for value-date
|
static QuantityClientParam |
VALUE_QUANTITY
Fluent Client search parameter constant for value-quantity
|
static StringClientParam |
VALUE_STRING
Fluent Client search parameter constant for value-string
|
SP_RES_ID, SP_RES_LANGUAGE| Constructor and Description |
|---|
Observation() |
| Modifier and Type | Method and Description |
|---|---|
ResourceReferenceDt |
addPerformer()
Adds and returns a new value for performer (Who did the observation)
|
Observation.ReferenceRange |
addReferenceRange()
Adds and returns a new value for referenceRange (Provides guide for interpretation)
|
Observation.Related |
addRelated()
Adds and returns a new value for related (Observations related to this observation)
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType)
Returns a list containing all child elements matching a given type
|
IDatatype |
getApplies()
Gets the value(s) for applies[x] (Physiologically Relevant time/time-period for observation).
|
CodeableConceptDt |
getBodySite()
Gets the value(s) for bodySite (Observed body part).
|
StringDt |
getComments()
Gets the value(s) for comments (Comments about result).
|
IdentifierDt |
getIdentifier()
Gets the value(s) for identifier (Unique Id for this particular observation).
|
BoundCodeableConceptDt<ObservationInterpretationCodesEnum> |
getInterpretation()
Gets the value(s) for interpretation (High, low, normal, etc.).
|
InstantDt |
getIssued()
Gets the value(s) for issued (Date/Time this was made available).
|
CodeableConceptDt |
getMethod()
Gets the value(s) for method (How it was done).
|
CodeableConceptDt |
getName()
Gets the value(s) for name (Type of observation (code / type)).
|
List<ResourceReferenceDt> |
getPerformer()
Gets the value(s) for performer (Who did the observation).
|
List<Observation.ReferenceRange> |
getReferenceRange()
Gets the value(s) for referenceRange (Provides guide for interpretation).
|
Observation.ReferenceRange |
getReferenceRangeFirstRep()
Gets the first repetition for referenceRange (Provides guide for interpretation),
creating it if it does not already exist.
|
List<Observation.Related> |
getRelated()
Gets the value(s) for related (Observations related to this observation).
|
Observation.Related |
getRelatedFirstRep()
Gets the first repetition for related (Observations related to this observation),
creating it if it does not already exist.
|
BoundCodeDt<ObservationReliabilityEnum> |
getReliability()
Gets the value(s) for reliability (ok | ongoing | early | questionable | calibrating | error +).
|
ResourceReferenceDt |
getSpecimen()
Gets the value(s) for specimen (Specimen used for this observation).
|
BoundCodeDt<ObservationStatusEnum> |
getStatus()
Gets the value(s) for status (registered | preliminary | final | amended +).
|
ResourceReferenceDt |
getSubject()
Gets the value(s) for subject (Who and/or what this is about).
|
IDatatype |
getValue()
Gets the value(s) for value[x] (Actual result).
|
boolean |
isEmpty() |
Observation |
setApplies(IDatatype theValue)
Sets the value(s) for applies[x] (Physiologically Relevant time/time-period for observation)
|
Observation |
setBodySite(CodeableConceptDt theValue)
Sets the value(s) for bodySite (Observed body part)
|
Observation |
setComments(String theString)
Sets the value for comments (Comments about result)
|
Observation |
setComments(StringDt theValue)
Sets the value(s) for comments (Comments about result)
|
Observation |
setIdentifier(IdentifierDt theValue)
Sets the value(s) for identifier (Unique Id for this particular observation)
|
Observation |
setIdentifier(IdentifierUseEnum theUse,
String theSystem,
String theValue,
String theLabel)
Sets the value for identifier (Unique Id for this particular observation)
|
Observation |
setIdentifier(String theSystem,
String theValue)
Sets the value for identifier (Unique Id for this particular observation)
|
Observation |
setInterpretation(BoundCodeableConceptDt<ObservationInterpretationCodesEnum> theValue)
Sets the value(s) for interpretation (High, low, normal, etc.)
|
Observation |
setInterpretation(ObservationInterpretationCodesEnum theValue)
Sets the value(s) for interpretation (High, low, normal, etc.)
|
Observation |
setIssued(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for issued (Date/Time this was made available)
|
Observation |
setIssued(InstantDt theValue)
Sets the value(s) for issued (Date/Time this was made available)
|
Observation |
setIssuedWithMillisPrecision(Date theDate)
Sets the value for issued (Date/Time this was made available)
|
Observation |
setMethod(CodeableConceptDt theValue)
Sets the value(s) for method (How it was done)
|
Observation |
setName(CodeableConceptDt theValue)
Sets the value(s) for name (Type of observation (code / type))
|
Observation |
setPerformer(List<ResourceReferenceDt> theValue)
Sets the value(s) for performer (Who did the observation)
|
Observation |
setReferenceRange(List<Observation.ReferenceRange> theValue)
Sets the value(s) for referenceRange (Provides guide for interpretation)
|
Observation |
setRelated(List<Observation.Related> theValue)
Sets the value(s) for related (Observations related to this observation)
|
Observation |
setReliability(BoundCodeDt<ObservationReliabilityEnum> theValue)
Sets the value(s) for reliability (ok | ongoing | early | questionable | calibrating | error +)
|
Observation |
setReliability(ObservationReliabilityEnum theValue)
Sets the value(s) for reliability (ok | ongoing | early | questionable | calibrating | error +)
|
Observation |
setSpecimen(ResourceReferenceDt theValue)
Sets the value(s) for specimen (Specimen used for this observation)
|
Observation |
setStatus(BoundCodeDt<ObservationStatusEnum> theValue)
Sets the value(s) for status (registered | preliminary | final | amended +)
|
Observation |
setStatus(ObservationStatusEnum theValue)
Sets the value(s) for status (registered | preliminary | final | amended +)
|
Observation |
setSubject(ResourceReferenceDt theValue)
Sets the value(s) for subject (Who and/or what this is about)
|
Observation |
setValue(IDatatype theValue)
Sets the value(s) for value[x] (Actual result)
|
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensionsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadatapublic static final String SP_NAME
Description: The name of the observation type
Type: token
Path: Observation.name
public static final TokenClientParam NAME
Description: The name of the observation type
Type: token
Path: Observation.name
public static final String SP_VALUE_QUANTITY
Description: The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)
Type: quantity
Path: Observation.value[x]
public static final QuantityClientParam VALUE_QUANTITY
Description: The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)
Type: quantity
Path: Observation.value[x]
public static final String SP_VALUE_CONCEPT
Description: The value of the observation, if the value is a CodeableConcept
Type: token
Path: Observation.value[x]
public static final TokenClientParam VALUE_CONCEPT
Description: The value of the observation, if the value is a CodeableConcept
Type: token
Path: Observation.value[x]
public static final String SP_VALUE_DATE
Description: The value of the observation, if the value is a Period
Type: date
Path: Observation.value[x]
public static final DateClientParam VALUE_DATE
Description: The value of the observation, if the value is a Period
Type: date
Path: Observation.value[x]
public static final String SP_VALUE_STRING
Description: The value of the observation, if the value is a string, and also searches in CodeableConcept.text
Type: string
Path: Observation.value[x]
public static final StringClientParam VALUE_STRING
Description: The value of the observation, if the value is a string, and also searches in CodeableConcept.text
Type: string
Path: Observation.value[x]
public static final String SP_DATE
Description: Obtained date/time. If the obtained element is a period, a date that falls in the period
Type: date
Path: Observation.applies[x]
public static final DateClientParam DATE
Description: Obtained date/time. If the obtained element is a period, a date that falls in the period
Type: date
Path: Observation.applies[x]
public static final String SP_STATUS
Description: The status of the observation
Type: token
Path: Observation.status
public static final TokenClientParam STATUS
Description: The status of the observation
Type: token
Path: Observation.status
public static final String SP_RELIABILITY
Description: The reliability of the observation
Type: token
Path: Observation.reliability
public static final TokenClientParam RELIABILITY
Description: The reliability of the observation
Type: token
Path: Observation.reliability
public static final String SP_SUBJECT
Description: The subject that the observation is about
Type: reference
Path: Observation.subject
public static final ReferenceClientParam SUBJECT
Description: The subject that the observation is about
Type: reference
Path: Observation.subject
public static final Include INCLUDE_SUBJECT
public static final String SP_PERFORMER
Description: Who and/or what performed the observation
Type: reference
Path: Observation.performer
public static final ReferenceClientParam PERFORMER
Description: Who and/or what performed the observation
Type: reference
Path: Observation.performer
public static final Include INCLUDE_PERFORMER
public static final String SP_SPECIMEN
Description:
Type: reference
Path: Observation.specimen
public static final ReferenceClientParam SPECIMEN
Description:
Type: reference
Path: Observation.specimen
public static final Include INCLUDE_SPECIMEN
public static final String SP_RELATED_TYPE
Description:
Type: token
Path: Observation.related.type
public static final TokenClientParam RELATED_TYPE
Description:
Type: token
Path: Observation.related.type
public static final String SP_RELATED_TARGET
Description:
Type: reference
Path: Observation.related.target
public static final ReferenceClientParam RELATED_TARGET
Description:
Type: reference
Path: Observation.related.target
public static final Include INCLUDE_RELATED_TARGET
public static final String SP_NAME_VALUE_QUANTITY
Description: Both name and one of the value parameters
Type: composite
Path: name & value-[x]
public static final CompositeClientParam<TokenClientParam,QuantityClientParam> NAME_VALUE_QUANTITY
Description: Both name and one of the value parameters
Type: composite
Path: name & value-[x]
public static final String SP_NAME_VALUE_CONCEPT
Description: Both name and one of the value parameters
Type: composite
Path: name & value-[x]
public static final CompositeClientParam<TokenClientParam,TokenClientParam> NAME_VALUE_CONCEPT
Description: Both name and one of the value parameters
Type: composite
Path: name & value-[x]
public static final String SP_NAME_VALUE_DATE
Description: Both name and one of the value parameters
Type: composite
Path: name & value-[x]
public static final CompositeClientParam<TokenClientParam,DateClientParam> NAME_VALUE_DATE
Description: Both name and one of the value parameters
Type: composite
Path: name & value-[x]
public static final String SP_NAME_VALUE_STRING
Description: Both name and one of the value parameters
Type: composite
Path: name & value-[x]
public static final CompositeClientParam<TokenClientParam,StringClientParam> NAME_VALUE_STRING
Description: Both name and one of the value parameters
Type: composite
Path: name & value-[x]
public static final String SP_RELATED_TARGET_RELATED_TYPE
Description: Related Observations - search on related-type and related-target together
Type: composite
Path: related-target & related-type
public static final CompositeClientParam<ReferenceClientParam,TokenClientParam> RELATED_TARGET_RELATED_TYPE
Description: Related Observations - search on related-type and related-target together
Type: composite
Path: related-target & related-type
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
ICompositeElementgetAllPopulatedChildElementsOfType in interface ICompositeElementtheType - The type to match. If set to null, all child elements will be returnedpublic CodeableConceptDt getName()
null.
Definition: Describes what was observed. Sometimes this is called the observation \"code\"
public Observation setName(CodeableConceptDt theValue)
Definition: Describes what was observed. Sometimes this is called the observation \"code\"
public IDatatype getValue()
null.
Definition: The information determined as a result of making the observation, if the information has a simple value
public Observation setValue(IDatatype theValue)
Definition: The information determined as a result of making the observation, if the information has a simple value
public BoundCodeableConceptDt<ObservationInterpretationCodesEnum> getInterpretation()
null.
Definition: The assessment made based on the result of the observation.
public Observation setInterpretation(BoundCodeableConceptDt<ObservationInterpretationCodesEnum> theValue)
Definition: The assessment made based on the result of the observation.
public Observation setInterpretation(ObservationInterpretationCodesEnum theValue)
Definition: The assessment made based on the result of the observation.
public StringDt getComments()
null.
Definition: 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.
public Observation setComments(StringDt theValue)
Definition: 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.
public Observation setComments(String theString)
Definition: 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.
public IDatatype getApplies()
null.
Definition: 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
public Observation setApplies(IDatatype theValue)
Definition: 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
public InstantDt getIssued()
null.
Definition:
public Observation setIssued(InstantDt theValue)
Definition:
public Observation setIssued(Date theDate, TemporalPrecisionEnum thePrecision)
Definition:
public Observation setIssuedWithMillisPrecision(Date theDate)
Definition:
public BoundCodeDt<ObservationStatusEnum> getStatus()
null.
Definition: The status of the result value
public Observation setStatus(BoundCodeDt<ObservationStatusEnum> theValue)
Definition: The status of the result value
public Observation setStatus(ObservationStatusEnum theValue)
Definition: The status of the result value
public BoundCodeDt<ObservationReliabilityEnum> getReliability()
null.
Definition: An estimate of the degree to which quality issues have impacted on the value reported
public Observation setReliability(BoundCodeDt<ObservationReliabilityEnum> theValue)
Definition: An estimate of the degree to which quality issues have impacted on the value reported
public Observation setReliability(ObservationReliabilityEnum theValue)
Definition: An estimate of the degree to which quality issues have impacted on the value reported
public CodeableConceptDt getBodySite()
null.
Definition: Indicates where on the subject's body the observation was made.
public Observation setBodySite(CodeableConceptDt theValue)
Definition: Indicates where on the subject's body the observation was made.
public CodeableConceptDt getMethod()
null.
Definition: Indicates the mechanism used to perform the observation
public Observation setMethod(CodeableConceptDt theValue)
Definition: Indicates the mechanism used to perform the observation
public IdentifierDt getIdentifier()
null.
Definition: A unique identifier for the simple observation
public Observation setIdentifier(IdentifierDt theValue)
Definition: A unique identifier for the simple observation
public Observation setIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)
Definition: A unique identifier for the simple observation
public Observation setIdentifier(String theSystem, String theValue)
Definition: A unique identifier for the simple observation
public ResourceReferenceDt getSubject()
null.
Definition: The thing the observation is being made about
public Observation setSubject(ResourceReferenceDt theValue)
Definition: The thing the observation is being made about
public ResourceReferenceDt getSpecimen()
null.
Definition: The specimen that was used when this observation was made
public Observation setSpecimen(ResourceReferenceDt theValue)
Definition: The specimen that was used when this observation was made
public List<ResourceReferenceDt> getPerformer()
null.
Definition: Who was responsible for asserting the observed value as \"true\"
public Observation setPerformer(List<ResourceReferenceDt> theValue)
Definition: Who was responsible for asserting the observed value as \"true\"
public ResourceReferenceDt addPerformer()
Definition: Who was responsible for asserting the observed value as \"true\"
public List<Observation.ReferenceRange> getReferenceRange()
null.
Definition: Guidance on how to interpret the value by comparison to a normal or recommended range
public Observation setReferenceRange(List<Observation.ReferenceRange> theValue)
Definition: Guidance on how to interpret the value by comparison to a normal or recommended range
public Observation.ReferenceRange addReferenceRange()
Definition: Guidance on how to interpret the value by comparison to a normal or recommended range
public Observation.ReferenceRange getReferenceRangeFirstRep()
Definition: Guidance on how to interpret the value by comparison to a normal or recommended range
public List<Observation.Related> getRelated()
null.
Definition: Related observations - either components, or previous observations, or statements of derivation
public Observation setRelated(List<Observation.Related> theValue)
Definition: Related observations - either components, or previous observations, or statements of derivation
public Observation.Related addRelated()
Definition: Related observations - either components, or previous observations, or statements of derivation
public Observation.Related getRelatedFirstRep()
Definition: Related observations - either components, or previous observations, or statements of derivation
Copyright © 2014 University Health Network. All rights reserved.