Goal _search

post/Goal/_search

Page View

This resource includes one or more target outcomes for a patient over a defined period.

The goal could be a desired outcome of a medical intervention or program or the target result after a period of recovery. A goal may be for preventing, mitigating, or recovering from a clinical condition (e.g., diabetes, cancer, heart attack) or recovering after a procedure (e.g., heart surgery).

You can review or retrieve goal details for a patient.

Supported fields and schema examples

We support any valid FHIR® field. However, we only display fields we’ve defined in our schema, which are usually based on what’s included in the U.S. Core profile. We recommend relying on U.S. Core requirements.

Our schema examples show the shape and possibility of each FHIR® resource; they aren’t code for real-time API calls. We don’t currently recommend copying and pasting these schema examples for your API calls. Consider reviewing FHIR® API actions for realistic examples for particular use cases.

_search

Query for details about a patient's medical intervention goals.

Flexible FHIR queries, different query parameters

FHIR® queries are a flexible option with parameters to refine your search. The response returns a bundle of resources, known as a searchset bundle type. Learn about bundles and bundle types in our FHIR® glossary.

We only note which query parameters are required if you're querying a FHIR® server directly. Remember that Redox (i.e., data on demand) isn't a FHIR® server, and your connection may not be either.

Query parameters will vary between sites. Work with your connection to find out which query parameters they require for a successful search.

Data on demand requirements

For data on demand searches, you must include this query parameter:

FHIR® resource ID for Patient resource (learn about FHIR® references or review HL7's docs on references)

Request parameters and payload

cURL request example

bash

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Goal/_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 'lifecycle-status=string' \
8
--data-urlencode 'target-date=string'

Request Body Schema

patient
Array of string
The patient the goal is for
patient.identifier
Array of string
One or more external identifiers for the patient
lifecycle-status
Array of string
The status of the goal: proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
target-date
Array of string
Date to reach goal on or before.

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": "Goal",
9
        "id": "RedoxGoalExample",
10
        "identifier": [
11
          {
12
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.4.737179",
13
            "value": "657120987"
14
          }
15
        ],
16
        "lifecycleStatus": "completed",
17
        "achievementStatus": {
18
          "text": "On track"
19
        },
20
        "priority": {
21
          "text": "High priority",
22
          "coding": [
23
            {
24
              "code": "394849002",
25
              "system": "http://snomed.info/sct"
26
            }
27
          ]
28
        },
29
        "description": {
30
          "text": "Oxygen saturation in Arterial blood by Pulse oximetry",
31
          "coding": [
32
            {
33
              "code": "59408-5",
34
              "system": "http://loinc.org"
35
            }
36
          ]
37
        },
38
        "subject": {
39
          "reference": "Patient/RedoxPatientExampleTimothy"
40
        },
41
        "startDate": "2013-09-02",
42
        "target": [
43
          {
44
            "measure": {
45
              "text": "Oxygen saturation in Arterial blood by Pulse oximetry",
46
              "coding": [
47
                {
48
                  "code": "59408-5",
49
                  "system": "http://loinc.org"
50
                }
51
              ]
52
            },
53
            "detailQuantity": {
54
              "value": 92,
55
              "unit": "%"
56
            },
57
            "dueDate": "2013-09-02"
58
          }
59
        ],
60
        "statusDate": "2012-12-31"
61
      },
62
      "search": {
63
        "mode": "match"
64
      }
65
    }
66
  ]
67
}

Response to a Goal search operation

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 Goal or Other
A resource matching the search criteria or related to a matching resource

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.