Class Observation

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.Observation
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class Observation
extends BaseResource
implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR Observation Resource (clinical.diagnostics)

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

See Also:
Serialized Form
  • Field Details

    • SP_CODE

      public static final String SP_CODE
      Search parameter constant for code

      Description: The code of the observation type
      Type: token
      Path: Observation.code

      See Also:
      Constant Field Values
    • CODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
      Fluent Client search parameter constant for code

      Description: The code of the observation type
      Type: token
      Path: Observation.code

    • SP_COMPONENT_CODE

      public static final String SP_COMPONENT_CODE
      Search parameter constant for component-code

      Description: The component code of the observation type
      Type: token
      Path: Observation.component.code

      See Also:
      Constant Field Values
    • COMPONENT_CODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam COMPONENT_CODE
      Fluent Client search parameter constant for component-code

      Description: The component code of the observation type
      Type: token
      Path: Observation.component.code

    • SP_VALUE_QUANTITY

      public static final String SP_VALUE_QUANTITY
      Search parameter constant for 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.valueQuantity

      See Also:
      Constant Field Values
    • VALUE_QUANTITY

      public static final ca.uhn.fhir.rest.gclient.QuantityClientParam VALUE_QUANTITY
      Fluent Client search parameter constant for 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.valueQuantity

    • SP_COMPONENT_VALUE_QUANTITY

      public static final String SP_COMPONENT_VALUE_QUANTITY
      Search parameter constant for component-value-quantity

      Description: The value of the component 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.component.valueQuantity

      See Also:
      Constant Field Values
    • COMPONENT_VALUE_QUANTITY

      public static final ca.uhn.fhir.rest.gclient.QuantityClientParam COMPONENT_VALUE_QUANTITY
      Fluent Client search parameter constant for component-value-quantity

      Description: The value of the component 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.component.valueQuantity

    • SP_VALUE_CONCEPT

      public static final String SP_VALUE_CONCEPT
      Search parameter constant for value-concept

      Description: The value of the observation, if the value is a CodeableConcept
      Type: token
      Path: Observation.valueCodeableConcept

      See Also:
      Constant Field Values
    • VALUE_CONCEPT

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam VALUE_CONCEPT
      Fluent Client search parameter constant for value-concept

      Description: The value of the observation, if the value is a CodeableConcept
      Type: token
      Path: Observation.valueCodeableConcept

    • SP_COMPONENT_VALUE_CONCEPT

      public static final String SP_COMPONENT_VALUE_CONCEPT
      Search parameter constant for component-value-concept

      Description: The value of the component observation, if the value is a CodeableConcept
      Type: token
      Path: Observation.component.valueCodeableConcept

      See Also:
      Constant Field Values
    • COMPONENT_VALUE_CONCEPT

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam COMPONENT_VALUE_CONCEPT
      Fluent Client search parameter constant for component-value-concept

      Description: The value of the component observation, if the value is a CodeableConcept
      Type: token
      Path: Observation.component.valueCodeableConcept

    • SP_VALUE_DATE

      public static final String SP_VALUE_DATE
      Search parameter constant for value-date

      Description: The value of the observation, if the value is a date or period of time
      Type: date
      Path: Observation.valueDateTime | Observation.valuePeriod

      See Also:
      Constant Field Values
    • VALUE_DATE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam VALUE_DATE
      Fluent Client search parameter constant for value-date

      Description: The value of the observation, if the value is a date or period of time
      Type: date
      Path: Observation.valueDateTime | Observation.valuePeriod

    • SP_VALUE_STRING

      public static final String SP_VALUE_STRING
      Search parameter constant for value-string

      Description: The value of the observation, if the value is a string, and also searches in CodeableConcept.text
      Type: string
      Path: Observation.valueString

      See Also:
      Constant Field Values
    • VALUE_STRING

      public static final ca.uhn.fhir.rest.gclient.StringClientParam VALUE_STRING
      Fluent Client search parameter constant for value-string

      Description: The value of the observation, if the value is a string, and also searches in CodeableConcept.text
      Type: string
      Path: Observation.valueString

    • SP_COMPONENT_VALUE_STRING

      public static final String SP_COMPONENT_VALUE_STRING
      Search parameter constant for component-value-string

      Description: The value of the component observation, if the value is a string, and also searches in CodeableConcept.text
      Type: string
      Path: Observation.component.valueString

      See Also:
      Constant Field Values
    • COMPONENT_VALUE_STRING

      public static final ca.uhn.fhir.rest.gclient.StringClientParam COMPONENT_VALUE_STRING
      Fluent Client search parameter constant for component-value-string

      Description: The value of the component observation, if the value is a string, and also searches in CodeableConcept.text
      Type: string
      Path: Observation.component.valueString

    • SP_DATE

      public static final String SP_DATE
      Search parameter constant for date

      Description: Obtained date/time. If the obtained element is a period, a date that falls in the period
      Type: date
      Path: Observation.effective[x]

      See Also:
      Constant Field Values
    • DATE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
      Fluent Client search parameter constant for date

      Description: Obtained date/time. If the obtained element is a period, a date that falls in the period
      Type: date
      Path: Observation.effective[x]

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter constant for status

      Description: The status of the observation
      Type: token
      Path: Observation.status

      See Also:
      Constant Field Values
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: The status of the observation
      Type: token
      Path: Observation.status

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter constant for subject

      Description: The subject that the observation is about
      Type: reference
      Path: Observation.subject

      See Also:
      Constant Field Values
    • SUBJECT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
      Fluent Client search parameter constant for subject

      Description: The subject that the observation is about
      Type: reference
      Path: Observation.subject

    • SP_PERFORMER

      public static final String SP_PERFORMER
      Search parameter constant for performer

      Description: Who performed the observation
      Type: reference
      Path: Observation.performer

      See Also:
      Constant Field Values
    • PERFORMER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PERFORMER
      Fluent Client search parameter constant for performer

      Description: Who performed the observation
      Type: reference
      Path: Observation.performer

    • SP_SPECIMEN

      public static final String SP_SPECIMEN
      Search parameter constant for specimen

      Description:
      Type: reference
      Path: Observation.specimen

      See Also:
      Constant Field Values
    • SPECIMEN

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SPECIMEN
      Fluent Client search parameter constant for specimen

      Description:
      Type: reference
      Path: Observation.specimen

    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter constant for encounter

      Description: Healthcare event related to the observation
      Type: reference
      Path: Observation.encounter

      See Also:
      Constant Field Values
    • ENCOUNTER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
      Fluent Client search parameter constant for encounter

      Description: Healthcare event related to the observation
      Type: reference
      Path: Observation.encounter

    • SP_DATA_ABSENT_REASON

      public static final String SP_DATA_ABSENT_REASON
      Search parameter constant for data-absent-reason

      Description: The reason why the expected value in the element Observation.value[x] is missing.
      Type: token
      Path: Observation.dataAbsentReason

      See Also:
      Constant Field Values
    • DATA_ABSENT_REASON

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam DATA_ABSENT_REASON
      Fluent Client search parameter constant for data-absent-reason

      Description: The reason why the expected value in the element Observation.value[x] is missing.
      Type: token
      Path: Observation.dataAbsentReason

    • SP_COMPONENT_DATA_ABSENT_REASON

      Search parameter constant for component-data-absent-reason

      Description: The reason why the expected value in the element Observation.component.value[x] is missing.
      Type: token
      Path: Observation.component.dataAbsentReason

      See Also:
      Constant Field Values
    • COMPONENT_DATA_ABSENT_REASON

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam COMPONENT_DATA_ABSENT_REASON
      Fluent Client search parameter constant for component-data-absent-reason

      Description: The reason why the expected value in the element Observation.component.value[x] is missing.
      Type: token
      Path: Observation.component.dataAbsentReason

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter constant for patient

      Description: The subject that the observation is about (if patient)
      Type: reference
      Path: Observation.subject

      See Also:
      Constant Field Values
    • PATIENT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
      Fluent Client search parameter constant for patient

      Description: The subject that the observation is about (if patient)
      Type: reference
      Path: Observation.subject

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter constant for identifier

      Description: The unique id for a particular observation
      Type: token
      Path: Observation.identifier

      See Also:
      Constant Field Values
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: The unique id for a particular observation
      Type: token
      Path: Observation.identifier

    • SP_DEVICE

      public static final String SP_DEVICE
      Search parameter constant for device

      Description: The Device that generated the observation data.
      Type: reference
      Path: Observation.device

      See Also:
      Constant Field Values
    • DEVICE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEVICE
      Fluent Client search parameter constant for device

      Description: The Device that generated the observation data.
      Type: reference
      Path: Observation.device

    • SP_CATEGORY

      public static final String SP_CATEGORY
      Search parameter constant for category

      Description: The classification of the type of observation
      Type: token
      Path: Observation.category

      See Also:
      Constant Field Values
    • CATEGORY

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
      Fluent Client search parameter constant for category

      Description: The classification of the type of observation
      Type: token
      Path: Observation.category

    • SP_CODE_VALUE_QUANTITY

      public static final String SP_CODE_VALUE_QUANTITY
      Search parameter constant for code-value-quantity

      Description: Both code and one of the value parameters
      Type: composite
      Path: code & value[x]

      See Also:
      Constant Field Values
    • CODE_VALUE_QUANTITY

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,​ca.uhn.fhir.rest.gclient.QuantityClientParam> CODE_VALUE_QUANTITY
      Fluent Client search parameter constant for code-value-quantity

      Description: Both code and one of the value parameters
      Type: composite
      Path: code & value[x]

    • SP_CODE_VALUE_CONCEPT

      public static final String SP_CODE_VALUE_CONCEPT
      Search parameter constant for code-value-concept

      Description: Both code and one of the value parameters
      Type: composite
      Path: code & value[x]

      See Also:
      Constant Field Values
    • CODE_VALUE_CONCEPT

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,​ca.uhn.fhir.rest.gclient.TokenClientParam> CODE_VALUE_CONCEPT
      Fluent Client search parameter constant for code-value-concept

      Description: Both code and one of the value parameters
      Type: composite
      Path: code & value[x]

    • SP_CODE_VALUE_DATE

      public static final String SP_CODE_VALUE_DATE
      Search parameter constant for code-value-date

      Description: Both code and one of the value parameters
      Type: composite
      Path: code & value[x]

      See Also:
      Constant Field Values
    • CODE_VALUE_DATE

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,​ca.uhn.fhir.rest.gclient.DateClientParam> CODE_VALUE_DATE
      Fluent Client search parameter constant for code-value-date

      Description: Both code and one of the value parameters
      Type: composite
      Path: code & value[x]

    • SP_CODE_VALUE_STRING

      public static final String SP_CODE_VALUE_STRING
      Search parameter constant for code-value-string

      Description: Both code and one of the value parameters
      Type: composite
      Path: code & value[x]

      See Also:
      Constant Field Values
    • CODE_VALUE_STRING

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,​ca.uhn.fhir.rest.gclient.StringClientParam> CODE_VALUE_STRING
      Fluent Client search parameter constant for code-value-string

      Description: Both code and one of the value parameters
      Type: composite
      Path: code & value[x]

    • SP_COMPONENT_CODE_COMPONENT_VALUE_QUANTITY

      Search parameter constant for component-code-component-value-quantity

      Description: Both component code and one of the component value parameters
      Type: composite
      Path: component-code & component-value[x]

      See Also:
      Constant Field Values
    • COMPONENT_CODE_COMPONENT_VALUE_QUANTITY

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,​ca.uhn.fhir.rest.gclient.QuantityClientParam> COMPONENT_CODE_COMPONENT_VALUE_QUANTITY
      Fluent Client search parameter constant for component-code-component-value-quantity

      Description: Both component code and one of the component value parameters
      Type: composite
      Path: component-code & component-value[x]

    • SP_COMPONENT_CODE_COMPONENT_VALUE_CONCEPT

      Search parameter constant for component-code-component-value-concept

      Description: Both component code and one of the component value parameters
      Type: composite
      Path: component-code & component-value[x]

      See Also:
      Constant Field Values
    • COMPONENT_CODE_COMPONENT_VALUE_CONCEPT

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,​ca.uhn.fhir.rest.gclient.TokenClientParam> COMPONENT_CODE_COMPONENT_VALUE_CONCEPT
      Fluent Client search parameter constant for component-code-component-value-concept

      Description: Both component code and one of the component value parameters
      Type: composite
      Path: component-code & component-value[x]

    • SP_COMPONENT_CODE_COMPONENT_VALUE_STRING

      Search parameter constant for component-code-component-value-string

      Description: Both component code and one of the component value parameters
      Type: composite
      Path: component-code & component-value[x]

      See Also:
      Constant Field Values
    • COMPONENT_CODE_COMPONENT_VALUE_STRING

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,​ca.uhn.fhir.rest.gclient.StringClientParam> COMPONENT_CODE_COMPONENT_VALUE_STRING
      Fluent Client search parameter constant for component-code-component-value-string

      Description: Both component code and one of the component value parameters
      Type: composite
      Path: component-code & component-value[x]

    • INCLUDE_DEVICE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_DEVICE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Observation:device".
    • INCLUDE_ENCOUNTER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Observation:encounter".
    • INCLUDE_PATIENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Observation:patient".
    • INCLUDE_PERFORMER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Observation:performer".
    • INCLUDE_SPECIMEN

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SPECIMEN
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Observation:specimen".
    • INCLUDE_SUBJECT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Observation:subject".
  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • getIdentifier

      Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

      Definition: A unique identifier for the simple observation instance.

    • setIdentifier

      public Observation setIdentifier​(List<IdentifierDt> theValue)
      Sets the value(s) for identifier (id)

      Definition: A unique identifier for the simple observation instance.

    • addIdentifier

      Adds and returns a new value for identifier (id)

      Definition: A unique identifier for the simple observation instance.

    • addIdentifier

      public Observation addIdentifier​(IdentifierDt theValue)
      Adds a given new value for identifier (id)

      Definition: A unique identifier for the simple observation instance.

      Parameters:
      theValue - The identifier to add (must not be null)
    • getIdentifierFirstRep

      Gets the first repetition for identifier (id), creating it if it does not already exist.

      Definition: A unique identifier for the simple observation instance.

    • getStatusElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<ObservationStatusEnum> getStatusElement()
      Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

      Definition: The status of the result value

    • getStatus

      public String getStatus()
      Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

      Definition: The status of the result value

    • setStatus

      public Observation setStatus​(ca.uhn.fhir.model.primitive.BoundCodeDt<ObservationStatusEnum> theValue)
      Sets the value(s) for status (status)

      Definition: The status of the result value

    • setStatus

      Sets the value(s) for status (status)

      Definition: The status of the result value

    • getCategory

      Gets the value(s) for category (class). creating it if it does not exist. Will not return null.

      Definition: A code that classifies the general type of observation being made. This is used for searching, sorting and display purposes.

    • setCategory

      Sets the value(s) for category (class)

      Definition: A code that classifies the general type of observation being made. This is used for searching, sorting and display purposes.

    • getCode

      Gets the value(s) for code (what). creating it if it does not exist. Will not return null.

      Definition: Describes what was observed. Sometimes this is called the observation \"name\"

    • setCode

      public Observation setCode​(CodeableConceptDt theValue)
      Sets the value(s) for code (what)

      Definition: Describes what was observed. Sometimes this is called the observation \"name\"

    • getSubject

      Gets the value(s) for subject (who.focus). creating it if it does not exist. Will not return null.

      Definition: 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.

    • setSubject

      Sets the value(s) for subject (who.focus)

      Definition: 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

      Gets the value(s) for encounter (context). creating it if it does not exist. Will not return null.

      Definition: The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made

    • setEncounter

      Sets the value(s) for encounter (context)

      Definition: The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made

    • getEffective

      public ca.uhn.fhir.model.api.IDatatype getEffective()
      Gets the value(s) for effective[x] (when.done). creating it if it does not exist. Will not return 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

    • setEffective

      public Observation setEffective​(ca.uhn.fhir.model.api.IDatatype theValue)
      Sets the value(s) for effective[x] (when.done)

      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

    • getIssuedElement

      public ca.uhn.fhir.model.primitive.InstantDt getIssuedElement()
      Gets the value(s) for issued (when.recorded). creating it if it does not exist. Will not return null.

      Definition: The date and time this observation was made available to providers, typically after the results have been reviewed and verified.

    • getIssued

      public Date getIssued()
      Gets the value(s) for issued (when.recorded). creating it if it does not exist. This method may return null.

      Definition: The date and time this observation was made available to providers, typically after the results have been reviewed and verified.

    • setIssued

      public Observation setIssued​(ca.uhn.fhir.model.primitive.InstantDt theValue)
      Sets the value(s) for issued (when.recorded)

      Definition: The date and time this observation was made available to providers, typically after the results have been reviewed and verified.

    • setIssuedWithMillisPrecision

      Sets the value for issued (when.recorded)

      Definition: 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 theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for issued (when.recorded)

      Definition: The date and time this observation was made available to providers, typically after the results have been reviewed and verified.

    • getPerformer

      Gets the value(s) for performer (who.actor). creating it if it does not exist. Will not return null.

      Definition: Who was responsible for asserting the observed value as \"true\"

    • setPerformer

      Sets the value(s) for performer (who.actor)

      Definition: Who was responsible for asserting the observed value as \"true\"

    • addPerformer

      Adds and returns a new value for performer (who.actor)

      Definition: Who was responsible for asserting the observed value as \"true\"

    • getValue

      public ca.uhn.fhir.model.api.IDatatype getValue()
      Gets the value(s) for value[x] (). creating it if it does not exist. Will not return null.

      Definition: The information determined as a result of making the observation, if the information has a simple value

    • setValue

      public Observation setValue​(ca.uhn.fhir.model.api.IDatatype theValue)
      Sets the value(s) for value[x] ()

      Definition: The information determined as a result of making the observation, if the information has a simple value

    • getDataAbsentReason

      Gets the value(s) for dataAbsentReason (). creating it if it does not exist. Will not return null.

      Definition: Provides a reason why the expected value in the element Observation.value[x] is missing.

    • setDataAbsentReason

      Sets the value(s) for dataAbsentReason ()

      Definition: Provides a reason why the expected value in the element Observation.value[x] is missing.

    • getInterpretation

      Gets the value(s) for interpretation (). creating it if it does not exist. Will not return null.

      Definition: 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.

    • setInterpretation

      Sets the value(s) for interpretation ()

      Definition: 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 ca.uhn.fhir.model.primitive.StringDt getCommentsElement()
      Gets the value(s) for comments (). creating it if it does not exist. Will not return 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.

    • getComments

      public String getComments()
      Gets the value(s) for comments (). creating it if it does not exist. This method may return 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.

    • setComments

      public Observation setComments​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for comments ()

      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.

    • setComments

      public Observation setComments​(String theString)
      Sets the value for comments ()

      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.

    • getBodySite

      Gets the value(s) for bodySite (). creating it if it does not exist. Will not return null.

      Definition: Indicates the site on the subject's body where the observation was made (i.e. the target site).

    • setBodySite

      Sets the value(s) for bodySite ()

      Definition: Indicates the site on the subject's body where the observation was made (i.e. the target site).

    • getMethod

      Gets the value(s) for method (). creating it if it does not exist. Will not return null.

      Definition: Indicates the mechanism used to perform the observation

    • setMethod

      public Observation setMethod​(CodeableConceptDt theValue)
      Sets the value(s) for method ()

      Definition: Indicates the mechanism used to perform the observation

    • getSpecimen

      Gets the value(s) for specimen (). creating it if it does not exist. Will not return null.

      Definition: The specimen that was used when this observation was made

    • setSpecimen

      Sets the value(s) for specimen ()

      Definition: The specimen that was used when this observation was made

    • getDevice

      Gets the value(s) for device (). creating it if it does not exist. Will not return null.

      Definition: The device used to generate the observation data.

    • setDevice

      Sets the value(s) for device ()

      Definition: The device used to generate the observation data.

    • getReferenceRange

      Gets the value(s) for referenceRange (). creating it if it does not exist. Will not return null.

      Definition: Guidance on how to interpret the value by comparison to a normal or recommended range

    • setReferenceRange

      Sets the value(s) for referenceRange ()

      Definition: Guidance on how to interpret the value by comparison to a normal or recommended range

    • addReferenceRange

      Adds and returns a new value for referenceRange ()

      Definition: Guidance on how to interpret the value by comparison to a normal or recommended range

    • addReferenceRange

      Adds a given new value for referenceRange ()

      Definition: Guidance on how to interpret the value by comparison to a normal or recommended range

      Parameters:
      theValue - The referenceRange to add (must not be null)
    • getReferenceRangeFirstRep

      Gets the first repetition for referenceRange (), creating it if it does not already exist.

      Definition: Guidance on how to interpret the value by comparison to a normal or recommended range

    • getRelated

      Gets the value(s) for related (). creating it if it does not exist. Will not return null.

      Definition: A reference to another resource (usually another Observation but could also be a QuestionnaireAnswer) whose relationship is defined by the relationship type code.

    • setRelated

      Sets the value(s) for related ()

      Definition: A reference to another resource (usually another Observation but could also be a QuestionnaireAnswer) whose relationship is defined by the relationship type code.

    • addRelated

      Adds and returns a new value for related ()

      Definition: A reference to another resource (usually another Observation but could also be a QuestionnaireAnswer) whose relationship is defined by the relationship type code.

    • addRelated

      Adds a given new value for related ()

      Definition: A reference to another resource (usually another Observation but could also be a QuestionnaireAnswer) whose relationship is defined by the relationship type code.

      Parameters:
      theValue - The related to add (must not be null)
    • getRelatedFirstRep

      Gets the first repetition for related (), creating it if it does not already exist.

      Definition: A reference to another resource (usually another Observation but could also be a QuestionnaireAnswer) whose relationship is defined by the relationship type code.

    • getComponent

      Gets the value(s) for component (). creating it if it does not exist. Will not return null.

      Definition: 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.

    • setComponent

      Sets the value(s) for component ()

      Definition: 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

      Adds and returns a new value for component ()

      Definition: 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

      Adds a given new value for component ()

      Definition: 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.

      Parameters:
      theValue - The component to add (must not be null)
    • getComponentFirstRep

      Gets the first repetition for component (), creating it if it does not already exist.

      Definition: 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.

    • getResourceName

      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource
    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource