Package org.hl7.fhir.dstu3.model

Class Observation

java.lang.Object
org.hl7.fhir.dstu3.model.Base
org.hl7.fhir.dstu3.model.BaseResource
org.hl7.fhir.dstu3.model.Resource
org.hl7.fhir.dstu3.model.DomainResource
org.hl7.fhir.dstu3.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:

  • Field Details

    • identifier

      protected List<Identifier> identifier
      A unique identifier assigned to this observation.

    • basedOn

      protected List<Reference> basedOn
      A plan, proposal or order that is fulfilled in whole or in part by this event.

    • basedOnTarget

      protected List<Resource> basedOnTarget
      The actual objects that are the target of the reference (A plan, proposal or order that is fulfilled in whole or in part by this event.)

    • status

      protected Enumeration<Observation.ObservationStatus> status
      The status of the result value.

    • category

      protected List<CodeableConcept> category
      A code that classifies the general type of observation being made.

    • 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.)

    • context

      protected Reference context
      The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

    • contextTarget

      protected Resource contextTarget
      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.

    • comment

      protected StringType comment
      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.

    • 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
      Search parameter: 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:

    • 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_COMBO_DATA_ABSENT_REASON

      public static final String SP_COMBO_DATA_ABSENT_REASON
      Search parameter: combo-data-absent-reason

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

      See Also:

    • COMBO_DATA_ABSENT_REASON

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

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

    • SP_CODE

      public static final String SP_CODE
      Search parameter: code

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

      See Also:

    • 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_COMBO_CODE_VALUE_QUANTITY

      public static final String SP_COMBO_CODE_VALUE_QUANTITY
      Search parameter: combo-code-value-quantity

      Description: Code and quantity value parameter pair, including in components
      Type: composite
      Path:

      See Also:

    • COMBO_CODE_VALUE_QUANTITY

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

      Description: Code and quantity value parameter pair, including in components
      Type: composite
      Path:

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

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

      See Also:

    • 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

    • 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".

    • SP_COMPONENT_DATA_ABSENT_REASON

      public static final String SP_COMPONENT_DATA_ABSENT_REASON
      Search parameter: 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:

    • 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_VALUE_CONCEPT

      public static final String SP_VALUE_CONCEPT
      Search parameter: value-concept

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

      See Also:

    • 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_VALUE_DATE

      public static final String SP_VALUE_DATE
      Search parameter: 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:

    • 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_CODE_VALUE_STRING

      public static final String SP_CODE_VALUE_STRING
      Search parameter: code-value-string

      Description: Code and string value parameter pair
      Type: composite
      Path:

      See Also:

    • 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: Code and string value parameter pair
      Type: composite
      Path:

    • SP_COMPONENT_CODE_VALUE_QUANTITY

      public static final String SP_COMPONENT_CODE_VALUE_QUANTITY
      Search parameter: component-code-value-quantity

      Description: Component code and component quantity value parameter pair
      Type: composite
      Path:

      See Also:

    • COMPONENT_CODE_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_VALUE_QUANTITY
      Fluent Client search parameter constant for component-code-value-quantity

      Description: Component code and component quantity value parameter pair
      Type: composite
      Path:

    • SP_BASED_ON

      public static final String SP_BASED_ON
      Search parameter: based-on

      Description: Reference to the test or procedure request.
      Type: reference
      Path: Observation.basedOn

      See Also:

    • BASED_ON

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON
      Fluent Client search parameter constant for based-on

      Description: Reference to the test or procedure request.
      Type: reference
      Path: Observation.basedOn

    • INCLUDE_BASED_ON

      public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Observation:based-on".

    • SP_CODE_VALUE_DATE

      public static final String SP_CODE_VALUE_DATE
      Search parameter: code-value-date

      Description: Code and date/time value parameter pair
      Type: composite
      Path:

      See Also:

    • 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: Code and date/time value parameter pair
      Type: composite
      Path:

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

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

      See Also:

    • 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

    • 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".

    • SP_SPECIMEN

      public static final String SP_SPECIMEN
      Search parameter: specimen

      Description: Specimen used for this observation
      Type: reference
      Path: Observation.specimen

      See Also:

    • SPECIMEN

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

      Description: Specimen used for this observation
      Type: reference
      Path: Observation.specimen

    • 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".

    • SP_COMPONENT_CODE

      public static final String SP_COMPONENT_CODE
      Search parameter: component-code

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

      See Also:

    • 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_CODE_VALUE_QUANTITY

      public static final String SP_CODE_VALUE_QUANTITY
      Search parameter: code-value-quantity

      Description: Code and quantity value parameter pair
      Type: composite
      Path:

      See Also:

    • 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: Code and quantity value parameter pair
      Type: composite
      Path:

    • SP_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: Healthcare event (Episode-of-care or Encounter) related to the observation
      Type: reference
      Path: Observation.context

      See Also:

    • CONTEXT

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

      Description: Healthcare event (Episode-of-care or Encounter) related to the observation
      Type: reference
      Path: Observation.context

    • INCLUDE_CONTEXT

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

    • SP_COMBO_CODE_VALUE_CONCEPT

      public static final String SP_COMBO_CODE_VALUE_CONCEPT
      Search parameter: combo-code-value-concept

      Description: Code and coded value parameter pair, including in components
      Type: composite
      Path:

      See Also:

    • COMBO_CODE_VALUE_CONCEPT

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

      Description: Code and coded value parameter pair, including in components
      Type: composite
      Path:

    • SP_VALUE_STRING

      public static final String SP_VALUE_STRING
      Search parameter: 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:

    • 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_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

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

      See Also:

    • 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_PERFORMER

      public static final String SP_PERFORMER
      Search parameter: performer

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

      See Also:

    • 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

    • 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".

    • SP_COMBO_CODE

      public static final String SP_COMBO_CODE
      Search parameter: combo-code

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

      See Also:

    • COMBO_CODE

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

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

    • SP_METHOD

      public static final String SP_METHOD
      Search parameter: method

      Description: The method used for the observation
      Type: token
      Path: Observation.method

      See Also:

    • METHOD

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

      Description: The method used for the observation
      Type: token
      Path: Observation.method

    • SP_VALUE_QUANTITY

      public static final String SP_VALUE_QUANTITY
      Search parameter: 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:

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

    • 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_DATA_ABSENT_REASON

      public static final String SP_DATA_ABSENT_REASON
      Search parameter: 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:

    • 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_COMBO_VALUE_QUANTITY

      public static final String SP_COMBO_VALUE_QUANTITY
      Search parameter: combo-value-quantity

      Description: The value or component 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, Observation.component.valueQuantity

      See Also:

    • COMBO_VALUE_QUANTITY

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

      Description: The value or component 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, Observation.component.valueQuantity

    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter: encounter

      Description: Encounter related to the observation
      Type: reference
      Path: Observation.context

      See Also:

    • ENCOUNTER

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

      Description: Encounter related to the observation
      Type: reference
      Path: Observation.context

    • 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".

    • SP_CODE_VALUE_CONCEPT

      public static final String SP_CODE_VALUE_CONCEPT
      Search parameter: code-value-concept

      Description: Code and coded value parameter pair
      Type: composite
      Path:

      See Also:

    • 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: Code and coded value parameter pair
      Type: composite
      Path:

    • SP_COMPONENT_CODE_VALUE_CONCEPT

      public static final String SP_COMPONENT_CODE_VALUE_CONCEPT
      Search parameter: component-code-value-concept

      Description: Component code and component coded value parameter pair
      Type: composite
      Path:

      See Also:

    • COMPONENT_CODE_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_VALUE_CONCEPT
      Fluent Client search parameter constant for component-code-value-concept

      Description: Component code and component coded value parameter pair
      Type: composite
      Path:

    • SP_COMPONENT_VALUE_CONCEPT

      public static final String SP_COMPONENT_VALUE_CONCEPT
      Search parameter: component-value-concept

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

      See Also:

    • 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_CATEGORY

      public static final String SP_CATEGORY
      Search parameter: category

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

      See Also:

    • 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_DEVICE

      public static final String SP_DEVICE
      Search parameter: device

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

      See Also:

    • 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

    • 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".

    • SP_COMBO_VALUE_CONCEPT

      public static final String SP_COMBO_VALUE_CONCEPT
      Search parameter: combo-value-concept

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

      See Also:

    • COMBO_VALUE_CONCEPT

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

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

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

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

      See Also:

    • 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

  • Constructor Details

  • Method Details

    • getIdentifier

      public List<Identifier> getIdentifier()
      Returns:
      identifier (A unique identifier assigned to this observation.)

    • setIdentifier

      public Observation setIdentifier(List<Identifier> theIdentifier)
      Returns:
      Returns a reference to this for easy method chaining

    • hasIdentifier

      public boolean hasIdentifier()

    • addIdentifier

      public Identifier addIdentifier()

    • addIdentifier

      public Observation addIdentifier(Identifier t)

    • getIdentifierFirstRep

      public Identifier getIdentifierFirstRep()
      Returns:
      The first repetition of repeating field identifier, creating it if it does not already exist

    • getBasedOn

      public List<Reference> getBasedOn()
      Returns:
      basedOn (A plan, proposal or order that is fulfilled in whole or in part by this event.)

    • setBasedOn

      public Observation setBasedOn(List<Reference> theBasedOn)
      Returns:
      Returns a reference to this for easy method chaining

    • hasBasedOn

      public boolean hasBasedOn()

    • addBasedOn

      public Reference addBasedOn()

    • addBasedOn

      public Observation addBasedOn(Reference t)

    • getBasedOnFirstRep

      public Reference getBasedOnFirstRep()
      Returns:
      The first repetition of repeating field basedOn, creating it if it does not already exist

    • getBasedOnTarget

      @Deprecated public List<Resource> getBasedOnTarget()
      Deprecated.
      Use Reference#setResource(IBaseResource) instead

    • 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 List<CodeableConcept> getCategory()
      Returns:
      category (A code that classifies the general type of observation being made.)

    • setCategory

      public Observation setCategory(List<CodeableConcept> theCategory)
      Returns:
      Returns a reference to this for easy method chaining

    • hasCategory

      public boolean hasCategory()

    • addCategory

      public CodeableConcept addCategory()

    • addCategory

      public Observation addCategory(CodeableConcept t)

    • getCategoryFirstRep

      public CodeableConcept getCategoryFirstRep()
      Returns:
      The first repetition of repeating field category, creating it if it does not already exist

    • 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.)

    • getContext

      public Reference getContext()
      Returns:
      context (The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.)

    • hasContext

      public boolean hasContext()

    • setContext

      public Observation setContext(Reference value)
      Parameters:
      value - context (The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.)

    • getContextTarget

      public Resource getContextTarget()
      Returns:
      context 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.)

    • setContextTarget

      public Observation setContextTarget(Resource value)
      Parameters:
      value - context 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) throws org.hl7.fhir.exceptions.FHIRFormatError
      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.)
      Throws:
      org.hl7.fhir.exceptions.FHIRFormatError

    • 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".)

    • setPerformer

      public Observation setPerformer(List<Reference> thePerformer)
      Returns:
      Returns a reference to this for easy method chaining

    • hasPerformer

      public boolean hasPerformer()

    • addPerformer

      public Reference addPerformer()

    • addPerformer

      public Observation addPerformer(Reference t)

    • getPerformerFirstRep

      public Reference getPerformerFirstRep()
      Returns:
      The first repetition of repeating field performer, creating it if it does not already exist

    • getPerformerTarget

      @Deprecated public List<Resource> getPerformerTarget()
      Deprecated.
      Use Reference#setResource(IBaseResource) instead

    • 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()

    • getValueBooleanType

      public BooleanType getValueBooleanType() 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

    • hasValueBooleanType

      public boolean hasValueBooleanType()

    • 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) throws org.hl7.fhir.exceptions.FHIRFormatError
      Parameters:
      value - value (The information determined as a result of making the observation, if the information has a simple value.)
      Throws:
      org.hl7.fhir.exceptions.FHIRFormatError

    • 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.)

    • getCommentElement

      public StringType getCommentElement()
      Returns:
      comment (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 "getComment" gives direct access to the value

    • hasCommentElement

      public boolean hasCommentElement()

    • hasComment

      public boolean hasComment()

    • setCommentElement

      public Observation setCommentElement(StringType value)
      Parameters:
      value - comment (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 "getComment" gives direct access to the value

    • getComment

      public String getComment()
      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.

    • setComment

      public Observation setComment(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.)

    • setReferenceRange

      public Observation setReferenceRange(List<Observation.ObservationReferenceRangeComponent> theReferenceRange)
      Returns:
      Returns a reference to this for easy method chaining

    • hasReferenceRange

      public boolean hasReferenceRange()

    • addReferenceRange

      public Observation.ObservationReferenceRangeComponent addReferenceRange()

    • addReferenceRange

      public Observation addReferenceRange(Observation.ObservationReferenceRangeComponent t)

    • getReferenceRangeFirstRep

      public Observation.ObservationReferenceRangeComponent getReferenceRangeFirstRep()
      Returns:
      The first repetition of repeating field referenceRange, creating it if it does not already exist

    • getRelated

      public List<Observation.ObservationRelatedComponent> getRelated()
      Returns:
      related (A reference to another resource (usually another Observation) whose relationship is defined by the relationship type code.)

    • setRelated

      public Observation setRelated(List<Observation.ObservationRelatedComponent> theRelated)
      Returns:
      Returns a reference to this for easy method chaining

    • hasRelated

      public boolean hasRelated()

    • addRelated

      public Observation.ObservationRelatedComponent addRelated()

    • addRelated

      public Observation addRelated(Observation.ObservationRelatedComponent t)

    • getRelatedFirstRep

      public Observation.ObservationRelatedComponent getRelatedFirstRep()
      Returns:
      The first repetition of repeating field related, creating it if it does not already exist

    • 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.)

    • setComponent

      public Observation setComponent(List<Observation.ObservationComponentComponent> theComponent)
      Returns:
      Returns a reference to this for easy method chaining

    • hasComponent

      public boolean hasComponent()

    • addComponent

      public Observation.ObservationComponentComponent addComponent()

    • addComponent

      public Observation addComponent(Observation.ObservationComponentComponent t)

    • getComponentFirstRep

      public Observation.ObservationComponentComponent getComponentFirstRep()
      Returns:
      The first repetition of repeating field component, creating it if it does not already exist

    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class DomainResource

    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getProperty

      public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty 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()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      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