Home
API reference
FHIR® API
FHIR® resources
Observation
_search

Observation _search

post/Observation/_search
Page View

This resource contains one or more results, findings, or measurements to inform a patient’s clinical condition (e.g., vitals, imaging results, lab results, device measurements).

Observations can help to identify baselines and patterns or define personal characteristics for a patient (e.g., height, weight, eye color). A DiagnosticReport resource may reference Observation resources to provide the metadata for a complete diagnostic report.

You can review, retrieve, create, or update observations for a patient.

_search

Query for one or more defined observations for a patient.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Observation/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode 'patient=string' \
6
--data-urlencode 'patient.identifier=string' \
7
--data-urlencode 'category=string' \
8
--data-urlencode 'code=string' \
9
--data-urlencode 'date=string' \
10
--data-urlencode 'effective=string' \
11
--data-urlencode 'identifier=string'

Request Body Schema

  • patient
    Array of string

    The patient about whom this Observation was recorded

  • patient.identifier
    Array of string

    One or more external identifiers for the patient

  • category
    Array of string

    The categorization of the Observation

  • code
    Array of string

    The code of the observation type

  • date
    Array of string

    Clinically relevant time/time-period for Observation

  • effective
    Array of string

    Clinically relevant time/time-period for Observation (alias for 'date')

  • identifier
    Array of string

    An identifier for the observation

Response fields and example

Example payload generated from schema
1
{
2
  "resourceType": "Bundle",
3
  "type": "searchset",
4
  "total": 1,
5
  "entry": [
6
    {
7
      "resource": {
8
        "resourceType": "Observation",
9
        "id": "RedoxSocialHistoryObservationExample",
10
        "category": [
11
          {
12
            "coding": [
13
              {
14
                "code": "social-history",
15
                "system": "http://terminology.hl7.org/CodeSystem/observation-category"
16
              }
17
            ]
18
          }
19
        ],
20
        "identifier": [
21
          {
22
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
23
            "value": "3059131578"
24
          }
25
        ],
26
        "subject": {
27
          "reference": "Patient/RedoxPatientExampleTimothy"
28
        },
29
        "encounter": {
30
          "reference": "Encounter/RedoxEncounterExample"
31
        },
32
        "status": "final",
33
        "code": {
34
          "coding": [
35
            {
36
              "code": "160573003",
37
              "system": "http://snomed.info/sct",
38
              "display": "Alcohol Consumption"
39
            }
40
          ]
41
        },
42
        "effectivePeriod": {
43
          "start": "1990-05-01T04:00:00.000Z"
44
        },
45
        "valueString": "None"
46
      },
47
      "search": {
48
        "mode": "match"
49
      }
50
    }
51
  ]
52
}

    Response to an Observation search operation for social history-related resources

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Identifies this bundle as a response to a search

    Value: searchset
  • total
    required, number

    The total number of matches

  • entry
    Array of Observation or Other

    A resource matching the search criteria or related to a matching resource

    • resource
      required, object

      Measurements and simple assertions made about a patient.

      • resourceType
        required, string

        Identifies the type of the resource

        Value: Observation
      • status
        required, string

        The status of the result value.

        Possible Values: registered, preliminary, final, amended, corrected, cancelled, entered-in-error, unknown
      • category
        required, Array of SocialHistory or Other

        A code that classifies the general type of observation being made.

        • coding
          required, Array of object
          • code
            required, string
            Value: social-history
          • system
            required, string
            Value: http://terminology.hl7.org/CodeSystem/observation-category
      • code
        required, object

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

        • coding
          Array of object

          A reference to a code defined by a terminology system.

          • system
            string

            The identification of the code system that defines the meaning of the symbol in the code.

          • code
            string

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        • text
          string

          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      • id
        string

        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      • identifier
        Array of object

        A unique identifier assigned to this observation.

        • extension
          Array of Boolean, String, CodeableConcept, Coding

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • url
            required, string

            Source of the definition for the extension code - a logical name or a URL.

          • valueBoolean
            boolean

            A single value for the extension.

        • use
          string

          The purpose of this identifier.

          Possible Values: usual, official, temp, secondary, old (If known)
        • system
          string

          Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

        • value
          string

          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

      • subject
        object

        The patient, or group of patients, location, or device this observation is about and into whose 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.

        Must be a resource of type Patient.

        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

      • encounter
        object

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

        Must be a resource of type Encounter.

        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

      • dataAbsentReason
        object

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

        • coding
          Array of object

          A reference to a code defined by a terminology system.

          • system
            string

            The identification of the code system that defines the meaning of the symbol in the code.

          • code
            string

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        • text
          string

          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      • effectiveDateTime
        string

        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.

        Only one of effectiveDateTime, effectivePeriod may be present.

      • effectivePeriod
        object

        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.

        Only one of effectiveDateTime, effectivePeriod may be present.

        • start
          string

          The start of the period. The boundary is inclusive.

        • end
          string

          The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

      • valueCodeableConcept
        object

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

        Only one of valueCodeableConcept, valueString may be present.

        • coding
          Array of object

          A reference to a code defined by a terminology system.

          • system
            string

            The identification of the code system that defines the meaning of the symbol in the code.

          • code
            string

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        • text
          string

          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      • valueString
        string

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

        Only one of valueCodeableConcept, valueString may be present.

    • search
      required, object

      Information about the search process that lead to the creation of this entry.

      • mode
        required, string

        Identifies the Observation as matching the search parameters

        Value: match