Goal

Overview

The Goal resource describes intended objectives for a patient. A goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A goal may address preventative health or mitigation of a diagnosis or problem. Goals can be non-healthcare related (for example, dance at a wedding).

The following fields are returned if valued:

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Errors

The common errors and OperationOutcomes may be returned.

Terminology Bindings

Goal.category
  • Description
    • Codes for grouping and sorting goals.
  • Details: Goal Category Codes
    System: http://hl7.org/fhir/goal-category

Search for goals that meet supplied query parameters.

GET /Goal?:parameters

Authorization Types

Parameters

Name Required? Type Description
_id Conditionally token The logical resource ID associated with the goal. This parameter is required if patient or subject are not used. Example: _id=7891
patient Conditionally reference The patient who has the goal. This parameter is required if _id or subject are not used. Example: patient=12345
subject:Patient Condtionally reference The subject who this goal is intended for. Must represent a Patient resource. This parameter is required if _id or patient are not used. Examples: subject=Patient/12345 or subject:Patient=12345
targetdate No date A date or date range from which to find goals. Example: targetdate=ge2016-10-01&targetdate=le2016-12-01

Notes:

Headers

Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?patient=12724066

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "94553cc2-fba5-410f-a0a4-fe760b4a8c72",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?patient=12724066"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal/183353727",
      "resource": {
        "resourceType": "Goal",
        "id": "183353727",
        "meta": {
          "versionId": "1594062592000",
          "lastUpdated": "2020-07-06T19:09:52.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Goal</b></p><p><b>Subject</b>: SMART, NANCY</p><p><b>Description</b>: Walk 2 miles a day</p><p><b>Author</b>: SMART, NANCY</p><p><b>Status</b>: In Progress</p><p><b>Start Date</b>: Jul  6, 2020</p><p><b>Target Date</b>: Jul  1, 2021</p></div>"
        },
        "subject": {
          "reference": "Patient/12724066",
          "display": "SMART, NANCY"
        },
        "startDate": "2020-07-06",
        "targetDate": "2021-07-01",
        "category": [
          {
            "text": "Family"
          }
        ],
        "description": "Walk 2 miles a day",
        "status": "in-progress",
        "statusDate": "2020-07-06",
        "author": {
          "reference": "Patient/12724066",
          "display": "SMART, NANCY"
        }
      }
    }
  ]
}

Example Search by ID

Request

GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?_id=183353727

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "b399773c-51f2-43f1-a539-ec85e5d6609c",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?_id=183353727"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal/183353727",
      "resource": {
        "resourceType": "Goal",
        "id": "183353727",
        "meta": {
          "versionId": "1594062592000",
          "lastUpdated": "2020-07-06T19:09:52.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Goal</b></p><p><b>Subject</b>: SMART, NANCY</p><p><b>Description</b>: Walk 2 miles a day</p><p><b>Author</b>: SMART, NANCY</p><p><b>Status</b>: In Progress</p><p><b>Start Date</b>: Jul  6, 2020</p><p><b>Target Date</b>: Jul  1, 2021</p></div>"
        },
        "subject": {
          "reference": "Patient/12724066",
          "display": "SMART, NANCY"
        },
        "startDate": "2020-07-06",
        "targetDate": "2021-07-01",
        "category": [
          {
            "text": "Family"
          }
        ],
        "description": "Walk 2 miles a day",
        "status": "in-progress",
        "statusDate": "2020-07-06",
        "author": {
          "reference": "Patient/12724066",
          "display": "SMART, NANCY"
        }
      }
    }
  ]
}

Retrieve by ID

List an individual goal by its ID.

GET /Goal/:id

Authorization Types

Headers

Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal/183353727

Response

Status: 200 OK
{
  "resourceType": "Goal",
  "id": "183353727",
  "meta": {
    "versionId": "1594062592000",
    "lastUpdated": "2020-07-06T19:09:52.000Z"
  },
  "text": {
    "status": "generated",
    "div": "<div><p><b>Goal</b></p><p><b>Subject</b>: SMART, NANCY</p><p><b>Description</b>: Walk 2 miles a day</p><p><b>Author</b>: SMART, NANCY</p><p><b>Status</b>: In Progress</p><p><b>Start Date</b>: Jul  6, 2020</p><p><b>Target Date</b>: Jul  1, 2021</p></div>"
  },
  "subject": {
    "reference": "Patient/12724066",
    "display": "SMART, NANCY"
  },
  "startDate": "2020-07-06",
  "targetDate": "2021-07-01",
  "category": [
    {
      "text": "Family"
    }
  ],
  "description": "Walk 2 miles a day",
  "status": "in-progress",
  "statusDate": "2020-07-06",
  "author": {
    "reference": "Patient/12724066",
    "display": "SMART, NANCY"
  }
}