Class 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

      A unique identifier assigned to this observation.
    • instantiates

      The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.
    • basedOn

      protected List<Reference> basedOn
      A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
    • triggeredBy

      Identifies the observation(s) that triggered the performance of this observation.
    • partOf

      protected List<Reference> partOf
      A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
    • status

      The status of the result value.
    • 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, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation.
    • focus

      protected List<Reference> focus
      The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
    • encounter

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

      protected DataType 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 version of the 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".
    • value

      protected DataType value
      The information determined as a result of making the observation, if the information has a simple value.
    • dataAbsentReason

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

      A categorical assessment of an observation value. For example, high, low, normal.
    • note

      protected List<Annotation> note
      Comments about the observation or the results.
    • bodySite

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

      Indicates the body structure on the subject's body where the observation was made (i.e. the target site).
    • method

      Indicates the mechanism used to perform the observation.
    • specimen

      protected Reference specimen
      The specimen that was used when this observation was made.
    • device

      protected Reference device
      The device used to generate the observation data.
    • referenceRange

      Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.
    • hasMember

      protected List<Reference> hasMember
      This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
    • derivedFrom

      The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
    • 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_BASED_ON

      public static final String SP_BASED_ON
      Search parameter: based-on

      Description: Reference to the service 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 service 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_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_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: Observation

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

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

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

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

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

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

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

    • 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: Observation | Observation.component

      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: Observation | Observation.component

    • 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: Observation | Observation.component

      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: Observation | Observation.component

    • 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_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_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.value as CodeableConcept) | (Observation.component.value as CodeableConcept)

      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.value as CodeableConcept) | (Observation.component.value as CodeableConcept)

    • 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.value as Quantity) | (Observation.value as SampledData) | (Observation.component.value as Quantity) | (Observation.component.value as SampledData)

      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.value as Quantity) | (Observation.value as SampledData) | (Observation.component.value as Quantity) | (Observation.component.value as SampledData)

    • SP_COMPONENT_CODE_VALUE_CONCEPT

      Search parameter: component-code-value-concept

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

      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: Observation.component

    • SP_COMPONENT_CODE_VALUE_QUANTITY

      Search parameter: component-code-value-quantity

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

      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: Observation.component

    • 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_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_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.value as CodeableConcept)

      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.value as CodeableConcept)

    • 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.value as Quantity) | (Observation.component.value as SampledData)

      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.value as Quantity) | (Observation.component.value as SampledData)

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

      public static final String SP_DERIVED_FROM
      Search parameter: derived-from

      Description: Related measurements the observation is made from
      Type: reference
      Path: Observation.derivedFrom

      See Also:
    • DERIVED_FROM

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DERIVED_FROM
      Fluent Client search parameter constant for derived-from

      Description: Related measurements the observation is made from
      Type: reference
      Path: Observation.derivedFrom

    • INCLUDE_DERIVED_FROM

      public static final ca.uhn.fhir.model.api.Include INCLUDE_DERIVED_FROM
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Observation:derived-from".
    • 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_FOCUS

      public static final String SP_FOCUS
      Search parameter: focus

      Description: The focus of an observation when the focus is not the patient of record.
      Type: reference
      Path: Observation.focus

      See Also:
    • FOCUS

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

      Description: The focus of an observation when the focus is not the patient of record.
      Type: reference
      Path: Observation.focus

    • INCLUDE_FOCUS

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

      public static final String SP_HAS_MEMBER
      Search parameter: has-member

      Description: Related resource that belongs to the Observation group
      Type: reference
      Path: Observation.hasMember

      See Also:
    • HAS_MEMBER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam HAS_MEMBER
      Fluent Client search parameter constant for has-member

      Description: Related resource that belongs to the Observation group
      Type: reference
      Path: Observation.hasMember

    • INCLUDE_HAS_MEMBER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_HAS_MEMBER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Observation:has-member".
    • 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_PART_OF

      public static final String SP_PART_OF
      Search parameter: part-of

      Description: Part of referenced event
      Type: reference
      Path: Observation.partOf

      See Also:
    • PART_OF

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PART_OF
      Fluent Client search parameter constant for part-of

      Description: Part of referenced event
      Type: reference
      Path: Observation.partOf

    • INCLUDE_PART_OF

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PART_OF
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Observation:part-of".
    • 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_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_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

    • 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_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.value as CodeableConcept)

      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.value as CodeableConcept)

    • 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.value as dateTime) | (Observation.value as Period)

      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.value as dateTime) | (Observation.value as Period)

    • 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.value as Quantity) | (Observation.value as SampledData)

      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.value as Quantity) | (Observation.value as SampledData)

    • 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.value as string) | (Observation.value as CodeableConcept).text

      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.value as string) | (Observation.value as CodeableConcept).text

    • SP_CODE

      public static final String SP_CODE
      Search parameter: code

      Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance [Condition](condition.html): Code for the condition [DeviceRequest](devicerequest.html): Code for what is being requested/ordered [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result [FamilyMemberHistory](familymemberhistory.html): A search by a condition code [List](list.html): What the purpose of this list is [Medication](medication.html): Returns medications for a specific code [MedicationAdministration](medicationadministration.html): Return administrations of this medication code [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code [MedicationUsage](medicationusage.html): Return statements of this medication code [Observation](observation.html): The code of the observation type [Procedure](procedure.html): A code to identify a procedure
      Type: token
      Path: AllergyIntolerance.code | AllergyIntolerance.reaction.substance | Condition.code | DeviceRequest.code.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationUsage.medication.concept | Observation.code | Procedure.code

      See Also:
    • CODE

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

      Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance [Condition](condition.html): Code for the condition [DeviceRequest](devicerequest.html): Code for what is being requested/ordered [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result [FamilyMemberHistory](familymemberhistory.html): A search by a condition code [List](list.html): What the purpose of this list is [Medication](medication.html): Returns medications for a specific code [MedicationAdministration](medicationadministration.html): Return administrations of this medication code [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code [MedicationUsage](medicationusage.html): Return statements of this medication code [Observation](observation.html): The code of the observation type [Procedure](procedure.html): A code to identify a procedure
      Type: token
      Path: AllergyIntolerance.code | AllergyIntolerance.reaction.substance | Condition.code | DeviceRequest.code.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationUsage.medication.concept | Observation.code | Procedure.code

    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

      Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): A date within the coverage time period. [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When consent was agreed to [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [Encounter](encounter.html): A date within the actualPeriod the Encounter lasted [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated [Flag](flag.html): Time period when flag is active [Immunization](immunization.html): Vaccination (non)-Administration Date [List](list.html): When the list was prepared [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period [Procedure](procedure.html): When the procedure occurred or is occurring [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
      Type: date
      Path: AllergyIntolerance.recordedDate | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.dateTime | DiagnosticReport.effective | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence as dateTime) | List.date | Observation.effective | Procedure.occurrence | (RiskAssessment.occurrence as dateTime) | SupplyRequest.authoredOn

      See Also:
    • DATE

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

      Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): A date within the coverage time period. [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When consent was agreed to [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [Encounter](encounter.html): A date within the actualPeriod the Encounter lasted [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated [Flag](flag.html): Time period when flag is active [Immunization](immunization.html): Vaccination (non)-Administration Date [List](list.html): When the list was prepared [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period [Procedure](procedure.html): When the procedure occurred or is occurring [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
      Type: date
      Path: AllergyIntolerance.recordedDate | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.dateTime | DiagnosticReport.effective | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence as dateTime) | List.date | Observation.effective | Procedure.occurrence | (RiskAssessment.occurrence as dateTime) | SupplyRequest.authoredOn

    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter: encounter

      Description: Multiple Resources: [Composition](composition.html): Context of the Composition [DeviceRequest](devicerequest.html): Encounter during which request was created [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made [Flag](flag.html): Alert relevant during encounter [List](list.html): Context in which list created [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier [Observation](observation.html): Encounter related to the observation [Procedure](procedure.html): The Encounter during which this Procedure was created [RiskAssessment](riskassessment.html): Where was assessment performed? [ServiceRequest](servicerequest.html): An encounter in which this request is made [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
      Type: reference
      Path: Composition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | Flag.encounter | List.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | RiskAssessment.encounter | ServiceRequest.encounter | VisionPrescription.encounter

      See Also:
    • ENCOUNTER

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

      Description: Multiple Resources: [Composition](composition.html): Context of the Composition [DeviceRequest](devicerequest.html): Encounter during which request was created [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made [Flag](flag.html): Alert relevant during encounter [List](list.html): Context in which list created [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier [Observation](observation.html): Encounter related to the observation [Procedure](procedure.html): The Encounter during which this Procedure was created [RiskAssessment](riskassessment.html): Where was assessment performed? [ServiceRequest](servicerequest.html): An encounter in which this request is made [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
      Type: reference
      Path: Composition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | Flag.encounter | List.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | RiskAssessment.encounter | ServiceRequest.encounter | VisionPrescription.encounter

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

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationUsage](medicationusage.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
      Type: token
      Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier

      See Also:
    • IDENTIFIER

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

      Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationUsage](medicationusage.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
      Type: token
      Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
      Type: reference
      Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.subject | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | VisionPrescription.patient

      See Also:
    • PATIENT

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

      Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
      Type: reference
      Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.subject | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | VisionPrescription.patient

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

  • Method Details