Jump to

• Request
• Response

Get a list of goals

get

/Goal

Search for Goal resources that meet the specified query parameters.

GET/Goal?:parameters

This operation supports the following authorization types:

• Provider
• Patient
• System

Request

Query Parameters

• _id: string
  The logical resource ID associated with the resource.
  This parameter is required if patient is not used.
  Type: token.
• _revinclude: string
  A request to include any Provenance resource in the bundle that refers to a Goal resource in the search results. Only supported with Provenance.
  Type: _revinclude.
  The _revinclude parameter may be provided once with the value Provenance:target. Example: _revinclude=Provenance:target.
  When _revinclude is provided in a request, the OAuth2 token must include the patient/Provenance.read system/Provenance.read or user/Provenance.read scope as applicable.

patient: string

The patient who has the goal.
This parameter is required if _id is not used.
Type: reference.

Header Parameters

• Authorization(required): string
  Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.
• accept(required): string

  The media type to be requested. Refer to what the resource's operation produces for what is supported.

Back to Top

Response

Supported Media Types

• application/fhir+json

Default Response

Example Search by Patient
Example Request

GET https://fhir-myrecord-sc.cerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Goal?patient=A879904FD2FE4B2D90C89FDA84E1285F

Example Response:

{
  "resourceType": "Bundle",
  "id": "0cebf130-3245-405e-9e83-96c498cbd602",
  "type": "searchset",
  "timestamp": "2022-05-10T01:45:56-04:00",
  "entry": [
    {
      "fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Goal/A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083",
      "resource": {
        "resourceType": "Goal",
        "id": "A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083",
        "meta": {
          "lastUpdated": "2020-11-15T16:21:24-05:00"
        },
        "lifecycleStatus": "active",
        "subject": {
          "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
          "display": "Mcgovern,Astrid Santiago"
        },
        "target": [
          {
            "dueDate": "2022-11-30"
          }
        ],
        "text": {
          "status": "generated",
          "div": "
Goal
Patient:Mcgovern,Astrid Santiago
Status:active
DueDate:2022-11-30
Description:
Goal 1: Decrease Sodium Intake

"
        },
        "description": {
          "text": "
Goal 1: Decrease Sodium Intake

"
        }
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-myrecord-sc.cerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Goal?patient=A879904FD2FE4B2D90C89FDA84E1285F&_format=json"
    }
  ]
}

x-_id Response

Example Search By ID
Example Request

GET https://fhir-myrecord-sc.cerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Goal?_id=A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083
 

Example Response:

{
   "resourceType": "Bundle",
   "id": "0cebf130-3245-405e-9e83-96c498cbd602",
   "type": "searchset",
   "timestamp": "2022-05-10T01:45:56-04:00",
   "entry": [
     {
       "fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Goal/A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083",
       "resource": {
         "resourceType": "Goal",
         "id": "A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083",
         "meta": {
           "lastUpdated": "2020-11-15T16:21:24-05:00"
         },
         "lifecycleStatus": "active",
         "subject": {
           "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
           "display": "Mcgovern,Astrid Santiago"
         },
         "target": [
           {
             "dueDate": "2022-11-30"
           }
         ],
         "text": {
           "status": "generated",
           "div": "
Goal
Patient:Mcgovern,Astrid Santiago
Status:active
DueDate:2022-11-30
Description:
Goal 1: Decrease Sodium Intake

"
         },
         "description": {
           "text": "
Goal 1: Decrease Sodium Intake

"
         }
       }
     }
   ],
   "link": [
     {
       "relation": "self",
       "url": "https://fhir-myrecord-sc.cerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Goal?patient=A879904FD2FE4B2D90C89FDA84E1285F&_format=json"
     }
   ]
 }
 

Headers

• X-Request-Id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

Back to Top