Goal

Overview
Terminology Bindings
Search
Retrieve by id

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-health care related (e.g. dance at a wedding).

The following fields are returned if valued:

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

Search for Goals that meet supplied query parameters:

GET /Goal?:parameters

Authorization Types

Provider | Patient | System

Parameters

Name	Required?	Type	Description
`_id`	This, or patient.	`token`	The logical resource id associated with the Goal. Example: `_id=7891`
`patient`	This, or _id.	`reference`	The patient who has the goal. Example: `patient=12345`
`target-date`	N	`date`	A date or date range from which to find Goals. Example: `target-date=ge2016-10-01&target-date=le2016-12-01`

Notes:

The _id parameter may not be provided at the same time as the patient or target-date
The target-date parameter may be provided once with a prefix to imply a date range or without a prefix to search for goals at a specific date. Alternately it may be provided twice with le, lt, ge, or gt prefixes to search for goals within specific range. The date and prefix pairs must create a closed range.

Headers

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

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"
          }
        ]
      }
    }
  ]
}

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.

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"
          }
        ]
      }
    }
  ]
}

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.

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"
          }
        ]
      }
    }
  ]
}

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.

Patient Authorization Request

GET https://fhir-ehr.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"
          }
        ]
      }
    }
  ]
}

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.

Retrieve by id

List an individual Goal by its id:

GET /Goal/:id

Authorization Types

Provider | Patient | System

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"
    }
  ]
}

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.

Patient Authorization Request

GET https://fhir-ehr.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"
    }
  ]
}

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.

Patient Authorization Request For Entered in Error Status

GET https://fhir-ehr.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"
  }
}

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.

Millennium

Goal

Overview

Terminology Bindings

Search

Authorization Types

Parameters

Headers

Example Search by Patient

Request

Response

Example Search by Id

Request

Response

Example Search by Patient and Target Date

Request

Response

Patient Authorization Request

Response

Errors

Retrieve by id

Authorization Types

Headers

Example

Request

Response

Patient Authorization Request

Response

Patient Authorization Request For Entered in Error Status

Response

Errors

R4 Overview

Foundation

Base

Clinical

Financial

Specialized