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.lifecycleStatus
  • Description
    • Codes that reflect the current state of a goal and whether the goal is still being targeted.
  • Details: Goal Lifecycle Status Codes
    System: http://hl7.org/fhir/goal-status

Goal.achievementStatus
  • Description
    • Indicates the progression, or lack thereof, towards the goal against the target.
  • Details: Goal Achievement Status Codes
    System: http://terminology.hl7.org/CodeSystem/goal-achievement

Goal.category
  • Description
    • Codes for grouping and sorting goals.
  • Details: Category
    System: http://terminology.hl7.org/CodeSystem/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 is not used. Example: _id=7891
patient Conditionally reference The patient who has the goal. This parameter is required if _id is not used. Example: patient=12345
target-date No date A date or date range from which to find goals. Example: target-date=ge2016-10-01&target-date=le2016-12-01
_revinclude No token Provenance resource entries to be returned as part of the bundle. Example:_revinclude=Provenance:target

Notes:

Headers

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

Example Search by ID

Request

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

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "b399773c-51f2-43f1-a539-ec85e5d6609c",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?_id=187042107"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal/187042107",
      "resource": {
        "resourceType": "Goal",
        "id": "187042107",
        "meta": {
          "versionId": "1607035687000",
          "lastUpdated": "2020-12-03T22:48:07.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Goal</b></p><p><b>Subject</b>: SMART, TIMMY</p><p><b>Description</b>: Maintain a healthy weight</p><p><b>Expressed By</b>: SMART, TIMMY</p><p><p><b>Status</b>: Active</p><p><b>Start Date</b>: Dec  3, 2020</p><p><b>Target Date</b>: Dec 31, 2020</p></div>"
        },
        "lifecycleStatus": "active",
        "achievementStatus": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/goal-achievement",
              "code": "achieved",
              "display": "Achieved"
            }
          ],
          "text": "Achieved"
        },
        "category": [
          {
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4003016",
                "code": "25481501",
                "display": "Physiologic",
                "userSelected": true
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/goal-category",
                "code": "physiotherapy",
                "display": "Physiotherapy",
                "userSelected": false
              }
            ],
            "text": "Physiologic"
          }
        ],
        "description": {
          "text": "Maintain a healthy weight"
        },
        "subject": {
          "reference": "Patient/12724069",
          "display": "SMART, TIMMY"
        },
        "startDate": "2020-12-03",
        "target": [
          {
            "dueDate": "2020-12-31"
          }
        ],
        "statusDate": "2020-12-03",
        "expressedBy": {
          "reference": "Patient/12724069",
          "display": "SMART, TIMMY"
        },
        "note": [
          {
            "authorReference": {
              "reference": "Practitioner/995932",
              "display": "Smart, John"
            },
            "time": "2020-11-12T16:14:20.000Z",
            "text": "Daily exercise"
          }
        ]
      }
    }
  ]
}

Example Search by Patient

Request

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

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "c0dab9bc-3a6e-4f0f-b0b7-213ed80c3d4b",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?patient=12724069"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal/187042107",
      "resource": {
        "resourceType": "Goal",
        "id": "187042107",
        "meta": {
          "versionId": "1607035687000",
          "lastUpdated": "2020-12-03T22:48:07.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Goal</b></p><p><b>Subject</b>: SMART, TIMMY</p><p><b>Description</b>: Maintain a healthy weight</p><p><b>Expressed By</b>: SMART, TIMMY</p><p><p><b>Status</b>: Active</p><p><b>Start Date</b>: Dec  3, 2020</p><p><b>Target Date</b>: Dec 31, 2020</p></div>"
        },
        "lifecycleStatus": "active",
        "achievementStatus": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/goal-achievement",
              "code": "achieved",
              "display": "Achieved"
            }
          ],
          "text": "Achieved"
        },
        "category": [
          {
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4003016",
                "code": "25481501",
                "display": "Physiologic",
                "userSelected": true
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/goal-category",
                "code": "physiotherapy",
                "display": "Physiotherapy",
                "userSelected": false
              }
            ],
            "text": "Physiologic"
          }
        ],
        "description": {
          "text": "Maintain a healthy weight"
        },
        "subject": {
          "reference": "Patient/12724069",
          "display": "SMART, TIMMY"
        },
        "startDate": "2020-12-03",
        "target": [
          {
            "dueDate": "2020-12-31"
          }
        ],
        "statusDate": "2020-12-03",
        "expressedBy": {
          "reference": "Patient/12724069",
          "display": "SMART, TIMMY"
        },
        "note": [
          {
            "authorReference": {
              "reference": "Practitioner/995932",
              "display": "Smart, John"
            },
            "time": "2020-11-12T16:14:20.000Z",
            "text": "Daily exercise"
          }
        ]
      }
    }
  ]
}

Example Search by Patient and Target Date

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?patient=12724069&target-date=gt2021-01-12

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "b399773c-51f2-43f1-a539-ec85e5d6609c",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?patient=12724069&target-date=gt2021-01-12"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal/187042107",
      "resource": {
        "resourceType": "Goal",
        "id": "187042107",
        "meta": {
          "versionId": "1607035687000",
          "lastUpdated": "2020-12-03T22:48:07.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Goal</b></p><p><b>Subject</b>: SMART, TIMMY</p><p><b>Description</b>: Maintain a healthy weight</p><p><b>Expressed By</b>: SMART, TIMMY</p><p><p><b>Status</b>: Active</p><p><b>Start Date</b>: Dec  3, 2020</p><p><b>Target Date</b>: Dec 31, 2020</p></div>"
        },
        "lifecycleStatus": "active",
        "achievementStatus": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/goal-achievement",
              "code": "achieved",
              "display": "Achieved"
            }
          ],
          "text": "Achieved"
        },
        "category": [
          {
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4003016",
                "code": "25481501",
                "display": "Physiologic",
                "userSelected": true
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/goal-category",
                "code": "physiotherapy",
                "display": "Physiotherapy",
                "userSelected": false
              }
            ],
            "text": "Physiologic"
          }
        ],
        "description": {
          "text": "Maintain a healthy weight"
        },
        "subject": {
          "reference": "Patient/12724069",
          "display": "SMART, TIMMY"
        },
        "startDate": "2020-12-03",
        "target": [
          {
            "dueDate": "2020-12-31"
          }
        ],
        "statusDate": "2020-12-03",
        "expressedBy": {
          "reference": "Patient/12724069",
          "display": "SMART, TIMMY"
        },
        "note": [
          {
            "authorReference": {
              "reference": "Practitioner/995932",
              "display": "Smart, John"
            },
            "time": "2020-11-12T16:14:20.000Z",
            "text": "Daily exercise"
          }
        ]
      }
    }
  ]
}

Example with RevInclude

Authorization Types

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?_id=498290085&_revinclude=Provenance:target

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "4a1ae23d-cb80-49ac-9b3b-6abbdb7d5b92",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?_id=498290085&_revinclude=Provenance%3Atarget"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal/498290085",
      "resource": {
        "resourceType": "Goal",
        "id": "498290085",
        "meta": {
          "versionId": "1610019857000",
          "lastUpdated": "2021-01-07T11:44:17.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Goal</b></p><p>\n              <b>Subject</b>: Smith, Grace</p><p><b>Description</b>: Fighting depression</p>\n              <p><b>Expressed By</b>: Smith, Grace</p><p><b>Status</b>: Cancelled</p>\n              <p><b>Start Date</b>: Jan  7, 2021</p></div>"
        },
        "lifecycleStatus": "cancelled",
        "category": [
          {
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4003016",
                "code": "71690181",
                "display": "Behavioral",
                "userSelected": true
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/goal-category",
                "code": "behavioral",
                "display": "Behavioral",
                "userSelected": false
              }
            ],
            "text": "Behavioral"
          },
          {
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4003016",
                "code": "71690193",
                "display": "Physiologic",
                "userSelected": true
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/goal-category",
                "code": "physiotherapy",
                "display": "Physiotherapy",
                "userSelected": false
              }
            ],
            "text": "Physiologic"
          }
        ],
        "description": {
          "text": "Fighting depression"
        },
        "subject": {
          "reference": "Patient/2100031",
          "display": "Smith, Grace"
        },
        "startDate": "2021-01-07",
        "statusDate": "2021-01-07",
        "expressedBy": {
          "reference": "Patient/2100031",
          "display": "Smith, Grace"
        }
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/INT.goal-498290085",
      "resource": {
        "resourceType": "Provenance",
        "id": "INT.goal-498290085",
        "meta": {
          "versionId": "498290085",
          "lastUpdated": "2021-01-07T11:44:17Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Provenance</b></p>\n              <p><b>Target</b>:</p><ul><li>Goal/498290085</li></ul><p><b>Recorded</b>: Jan  7, 2021  5:44 A.M. CST</p>\n              <p><b>Agents</b>:</p><dl><dt>One Plan, One Plan</dt><dd><b>Agent Type</b>: Author</dd>\n              <dd><b>Agent Role</b>: Source</dd><dt>DEVENG-DEFAULT-PROV</dt><dd><b>Agent Type</b>: Author</dd>\n              <dd><b>Agent Role</b>: Source</dd></dl></div>"
        },
        "target": [
          {
            "reference": "Goal/498290085"
          }
        ],
        "recorded": "2021-01-07T11:44:17Z",
        "agent": [
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                  "code": "author"
                }
              ],
              "text": "Author"
            },
            "role": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
                    "code": "SOURCE"
                  }
                ],
                "text": "Source"
              }
            ],
            "who": {
              "reference": "Practitioner/118617332",
              "display": "One Plan, One Plan"
            }
          },
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                  "code": "author"
                }
              ],
              "text": "Author"
            },
            "role": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
                    "code": "SOURCE"
                  }
                ],
                "text": "Source"
              }
            ],
            "who": {
              "reference": "Organization/57535538",
              "display": "DEVENG-DEFAULT-PROV"
            }
          }
        ]
      },
      "search": {
        "mode": "include"
      }
    }
  ]
}

Patient Authorization Request

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

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "c0dab9bc-3a6e-4f0f-b0b7-213ed80c3d4b",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?patient=12724069"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal/187042107",
      "resource": {
        "resourceType": "Goal",
        "id": "187042107",
        "meta": {
          "versionId": "1607035687000",
          "lastUpdated": "2020-12-03T22:48:07.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Goal</b></p><p><b>Subject</b>: SMART, TIMMY</p><p><b>Description</b>: Maintain a healthy weight</p><p><b>Expressed By</b>: SMART, TIMMY</p><p><p><b>Status</b>: Active</p><p><b>Start Date</b>: Dec  3, 2020</p><p><b>Target Date</b>: Dec 31, 2020</p></div>"
        },
        "lifecycleStatus": "active",
        "achievementStatus": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/goal-achievement",
              "code": "achieved",
              "display": "Achieved"
            }
          ],
          "text": "Achieved"
        },
        "category": [
          {
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4003016",
                "code": "25481501",
                "display": "Physiologic",
                "userSelected": true
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/goal-category",
                "code": "physiotherapy",
                "display": "Physiotherapy",
                "userSelected": false
              }
            ],
            "text": "Physiologic"
          }
        ],
        "description": {
          "text": "Maintain a healthy weight"
        },
        "subject": {
          "reference": "Patient/12724069",
          "display": "SMART, TIMMY"
        },
        "startDate": "2020-12-03",
        "target": [
          {
            "dueDate": "2020-12-31"
          }
        ],
        "statusDate": "2020-12-03",
        "expressedBy": {
          "reference": "Patient/12724069",
          "display": "SMART, TIMMY"
        },
        "note": [
          {
            "authorReference": {
              "reference": "Practitioner/995932",
              "display": "Smart, John"
            },
            "time": "2020-11-12T16:14:20.000Z",
            "text": "Daily exercise"
          }
        ]
      }
    }
  ]
}

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/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal/187042107

Response

Status: 200 OK
{
  "resourceType": "Goal",
  "id": "187042107",
  "meta": {
    "versionId": "1607035687000",
    "lastUpdated": "2020-12-03T22:48:07.000Z"
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Goal</b></p><p><b>Subject</b>: SMART, TIMMY</p><p><b>Description</b>: Maintain a healthy weight</p><p><b>Expressed By</b>: SMART, TIMMY</p><p><p><b>Status</b>: Active</p><p><b>Start Date</b>: Dec  3, 2020</p><p><b>Target Date</b>: Dec 31, 2020</p></div>"
  },
  "lifecycleStatus": "active",
  "achievementStatus": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/goal-achievement",
        "code": "achieved",
        "display": "Achieved"
      }
    ],
    "text": "Achieved"
  },
  "category": [
    {
      "coding": [
        {
          "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4003016",
          "code": "25481501",
          "display": "Physiologic",
          "userSelected": true
        },
        {
          "system": "http://terminology.hl7.org/CodeSystem/goal-category",
          "code": "physiotherapy",
          "display": "Physiotherapy",
          "userSelected": false
        }
      ],
      "text": "Physiologic"
    }
  ],
  "description": {
    "text": "Maintain a healthy weight"
  },
  "subject": {
    "reference": "Patient/12724069",
    "display": "SMART, TIMMY"
  },
  "startDate": "2020-12-03",
  "target": [
    {
      "dueDate": "2020-12-31"
    }
  ],
  "statusDate": "2020-12-03",
  "expressedBy": {
    "reference": "Patient/12724069",
    "display": "SMART, TIMMY"
  },
  "note": [
    {
      "authorReference": {
        "reference": "Practitioner/995932",
        "display": "Smart, John"
      },
      "time": "2020-11-12T16:14:20.000Z",
      "text": "Daily exercise"
    }
  ]
}

Patient Authorization Request For Entered in Error Status

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

Response

Status: 200 OK
{
  "resourceType": "Goal",
  "id": "187042111",
  "meta": {
    "versionId": "1607035809000",
    "lastUpdated": "2020-12-03T22:50:09.000Z"
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Goal</b></p><p><b>Subject</b>: SMART, TIMMY</p><p><b>Description</b>: Error</p><p><b>Status</b>: Entered in Error</p></div>"
  },
  "lifecycleStatus": "entered-in-error",
  "description": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
        "code": "error",
        "display": "Error"
      }
    ],
    "text": "Error"
  },
  "subject": {
    "reference": "Patient/12724069",
    "display": "SMART, TIMMY"
  }
}