Home
API reference
FHIR® API
FHIR® resources
Goal
_search

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.

_search

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

This is a flexible option with query 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.

Request parameters and payload

When querying for this resource, one of the following sets of parameters must always be sent. Additional parameters may be sent at any time.
  • patient

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

    • resource
      required, object

      Describes the intended objective for a patient, group or organization

      • resourceType
        required, string

        Identifies the type of the resource

        Value: Goal
      • lifecycleStatus
        required, string

        The state of the goal throughout its lifecycle.

        Possible Values: proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, rejected
      • description
        required, object

        Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".

        • extension
          Array of OriginalText or Other

          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.

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

            See http://hl7.org/fhir/StructureDefinition/originalText for more information

          • url
            required, string

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

            Value: http://hl7.org/fhir/StructureDefinition/originalText
          • valueString
            required, string

            The original text

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

      • subject
        required, object

        Identifies the patient, group or organization for whom the goal is being established.

        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.

      • 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

        Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

        • extension
          Array of Boolean, String, CodeableConcept, Coding, HumanName or Reference

          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.

      • achievementStatus
        object

        Describes the progression, or lack thereof, towards the goal against the target.

        • extension
          Array of OriginalText or Other

          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.

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

            See http://hl7.org/fhir/StructureDefinition/originalText for more information

          • url
            required, string

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

            Value: http://hl7.org/fhir/StructureDefinition/originalText
          • valueString
            required, string

            The original text

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

      • priority
        object

        Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.

        • extension
          Array of OriginalText or Other

          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.

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

            See http://hl7.org/fhir/StructureDefinition/originalText for more information

          • url
            required, string

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

            Value: http://hl7.org/fhir/StructureDefinition/originalText
          • valueString
            required, string

            The original text

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

      • target
        Array of object

        Indicates what should be done by when.

        • measure
          object

          The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

          • extension
            Array of OriginalText or Other

            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.

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

              See http://hl7.org/fhir/StructureDefinition/originalText for more information

            • url
              required, string

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

              Value: http://hl7.org/fhir/StructureDefinition/originalText
            • valueString
              required, string

              The original text

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

        • detailQuantity
          object

          The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

          Only one of detailQuantity, detailCodeableConcept, detailString may be present.

          • value
            number

            The value of the measured amount. The value includes an implicit precision in the presentation of the value.

          • system
            string

            The identification of the system that provides the coded form of the unit.

          • code
            string

            A computer processable form of the unit in some unit representation system.

        • detailCodeableConcept
          object

          The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

          Only one of detailQuantity, detailCodeableConcept, detailString may be present.

          • extension
            Array of OriginalText or Other

            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.

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

              See http://hl7.org/fhir/StructureDefinition/originalText for more information

            • url
              required, string

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

              Value: http://hl7.org/fhir/StructureDefinition/originalText
            • valueString
              required, string

              The original text

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

        • detailString
          string

          The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

          Only one of detailQuantity, detailCodeableConcept, detailString may be present.

        • dueDate
          string

          Indicates either the date or the duration after start by which the goal should be met.

      • statusDate
        string

        Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.

      • expressedBy
        object

        Indicates whose goal this is - patient goal, practitioner goal, etc.

        Must reference one of the following types of resources:

        • Patient
        • Practitioner
        • PractitionerRole
        • RelatedPerson
        • 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.

      • startDate
        string

        The date or event after which the goal should begin being pursued.

    • search
      required, object

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

      • mode
        required, string

        Identifies the Goal as matching the search parameters

        Value: match