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

The following fields are returned if valued:

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 This, or one of patient, or subject. token The logical resource id associated with the Goal. Example: _id=24110557
patient This, or one of _id, or subject. reference The patient who has the goal. Example: patient=1316024
subject:Patient This, or one of _id, or patient. reference The subject who this goal is intended for. Must represent a Patient resource. May use the :Patient modifier. Example: subject=Patient/1316020 or subject:Patient=1316020
targetdate N 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.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Goal?patient=685925

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "5ecc9ee8-8a52-4676-a2c6-b8698d30e284",
  "type": "searchset",
  "total": 3,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Goal?patient=685925"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Goal/59475953",
      "resource": {
        "resourceType": "Goal",
        "id": "59475953",
        "meta": {
          "versionId": "1485975664000",
          "lastUpdated": "2017-02-01T19:01:04.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Goal</b></p><p><b>Subject</b>: Granger, Hermione</p><p><b>Description</b>: Test goal</p><p><b>Status</b>: In Progress</p><p><b>Start Date</b>: 2016-11-09</p><p><b>Target Date</b>: 2016-11-30</p></div>"
        },
        "subject": {
          "reference": "Patient/685925",
          "display": "Granger, Hermione"
        },
        "startDate": "2016-11-09",
        "targetDate": "2016-11-30",
        "category": [
          {
            "text": "Community"
          }
        ],
        "description": "Test goal",
        "status": "in-progress",
        "statusDate": "2016-11-09",
        "note": [
          {
            "authorReference": {
              "reference": "Practitioner/4594024",
              "display": "Pomfrey, Poppy"
            },
            "time": "2017-02-01T19:01:04.000Z",
            "text": "Test comment for the goal \"Test goal\""
          }
        ]
      }
    },
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Goal/59535837",
      "resource": {
        "resourceType": "Goal",
        "id": "59535837",
        "meta": {
          "versionId": "1482335249000",
          "lastUpdated": "2016-12-21T15:47:29.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Goal</b></p><p><b>Subject</b>: Granger, Hermione</p><p><b>Description</b>: Met goal</p><p><b>Status</b>: Achieved</p><p><b>Start Date</b>: 2016-12-13</p><p><b>Target Date</b>: 2016-12-23</p></div>"
        },
        "subject": {
          "reference": "Patient/685925",
          "display": "Granger, Hermione"
        },
        "startDate": "2016-12-13",
        "targetDate": "2016-12-23",
        "category": [
          {
            "text": "Community"
          },
          {
            "text": "Safety"
          }
        ],
        "description": "Met goal",
        "status": "achieved",
        "statusDate": "2016-12-21"
      }
    },
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Goal/59535833",
      "resource": {
        "resourceType": "Goal",
        "id": "59535833",
        "meta": {
          "versionId": "1485975696000",
          "lastUpdated": "2017-02-01T19:01:36.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Goal</b></p><p><b>Subject</b>: Granger, Hermione</p><p><b>Description</b>: Test Goal without a target date</p><p><b>Author</b>: Granger, Hermione</p><p><b>Status</b>: In Progress</p><p><b>Start Date</b>: 2016-12-21</p></div>"
        },
        "subject": {
          "reference": "Patient/685925",
          "display": "Granger, Hermione"
        },
        "startDate": "2016-12-21",
        "category": [
          {
            "text": "Behavioral"
          }
        ],
        "description": "Test Goal without a target date",
        "status": "in-progress",
        "statusDate": "2016-12-21",
        "author": {
          "reference": "Patient/685925",
          "display": "Granger, Hermione"
        },
        "note": [
          {
            "authorReference": {
              "reference": "Practitioner/4594024",
              "display": "Pomfrey, Poppy"
            },
            "time": "2017-02-01T19:01:36.000Z",
            "text": "This is a test. I repeat, this is only a test!"
          }
        ]
      }
    }
  ]
}

Example Search by Id

Request

GET https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Goal?_id=59563849

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "5c7be2b1-79b7-4387-abde-df3ffc2247ba",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Goal?_id=59563849"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Goal/59563849",
      "resource": {
        "resourceType": "Goal",
        "id": "59563849",
        "meta": {
          "versionId": "1485363855000",
          "lastUpdated": "2017-01-25T17:04:15.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Goal</b></p><p><b>Subject</b>: TEST, LISA</p><p><b>Description</b>: A New Goal</p><p><b>Status</b>: In Progress</p><p><b>Start Date</b>: 2017-01-25</p></div>"
        },
        "subject": {
          "reference": "Patient/1045932",
          "display": "TEST, LISA"
        },
        "startDate": "2017-01-25",
        "description": "A New Goal",
        "status": "in-progress",
        "statusDate": "2017-01-25"
      }
    }
  ]
}

Errors

The common errors may be returned.

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.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Goal/59563849

Response

Status: 200 OK
{
  "resourceType": "Goal",
  "id": "59563849",
  "meta": {
    "versionId": "1485363855000",
    "lastUpdated": "2017-01-25T17:04:15.000Z"
  },
  "text": {
    "status": "generated",
    "div": "<div><p><b>Goal</b></p><p><b>Subject</b>: TEST, LISA</p><p><b>Description</b>: A New Goal</p><p><b>Status</b>: In Progress</p><p><b>Start Date</b>: 2017-01-25</p></div>"
  },
  "subject": {
    "reference": "Patient/1045932",
    "display": "TEST, LISA"
  },
  "startDate": "2017-01-25",
  "description": "A New Goal",
  "status": "in-progress",
  "statusDate": "2017-01-25"
}

Errors

The common errors may be returned.