Goal

Terminology Bindings

Goal.category

Search for Goals that meet supplied query parameters:

GET /Goal?:parameters

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:

Response

Status: 200 OK
Functionality: Search by patient
{
  "resourceType": "Bundle",
  "id": "d134ea4c-e069-498b-9810-d52eb4d5658e",
  "type": "searchset",
  "total": 5,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Goal?patient=1045932"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Goal/59563861",
      "resource": {
        "resourceType": "Goal",
        "id": "59563861",
        "meta": {
          "versionId": "1485364022000",
          "lastUpdated": "2017-01-25T17:07:02.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-18</p><p><b>Target Date</b>: 2017-01-27</p></div>"
        },
        "subject": {
          "reference": "Patient/1045932",
          "display": "TEST, LISA"
        },
        "startDate": "2017-01-18",
        "targetDate": "2017-01-27",
        "description": "A New Goal",
        "status": "in-progress",
        "statusDate": "2017-01-25"
      }
    },
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Goal/59563857",
      "resource": {
        "resourceType": "Goal",
        "id": "59563857",
        "meta": {
          "versionId": "1485363963000",
          "lastUpdated": "2017-01-25T17:06:03.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Goal</b></p><p><b>Subject</b>: TEST, LISA</p><p><b>Description</b>: asdf</p><p><b>Status</b>: In Progress</p><p><b>Start Date</b>: 2017-01-20</p><p><b>Target Date</b>: 2017-01-30</p></div>"
        },
        "subject": {
          "reference": "Patient/1045932",
          "display": "TEST, LISA"
        },
        "startDate": "2017-01-20",
        "targetDate": "2017-01-30",
        "description": "asdf",
        "status": "in-progress",
        "statusDate": "2017-01-25"
      }
    },
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Goal/59563949",
      "resource": {
        "resourceType": "Goal",
        "id": "59563949",
        "meta": {
          "versionId": "1485368838000",
          "lastUpdated": "2017-01-25T18:27:18.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><p><b>Target Date</b>: 2017-01-25</p></div>"
        },
        "subject": {
          "reference": "Patient/1045932",
          "display": "TEST, LISA"
        },
        "startDate": "2017-01-25",
        "targetDate": "2017-01-25",
        "category": [
          {
            "text": "Behavioral"
          }
        ],
        "description": "A New Goal",
        "status": "in-progress",
        "statusDate": "2017-01-25"
      }
    },
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Goal/59563953",
      "resource": {
        "resourceType": "Goal",
        "id": "59563953",
        "meta": {
          "versionId": "1485369827000",
          "lastUpdated": "2017-01-25T18:43:47.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Goal</b></p><p><b>Subject</b>: TEST, LISA</p><p><b>Description</b>: A newer goal</p><p><b>Status</b>: In Progress</p><p><b>Start Date</b>: 2017-01-25</p><p><b>Target Date</b>: 2017-01-25</p></div>"
        },
        "subject": {
          "reference": "Patient/1045932",
          "display": "TEST, LISA"
        },
        "startDate": "2017-01-25",
        "targetDate": "2017-01-25",
        "category": [
          {
            "text": "Safety"
          },
          {
            "text": "Behavioral"
          },
          {
            "text": "Community"
          },
          {
            "text": "Physiologic"
          },
          {
            "text": "Family"
          }
        ],
        "description": "A newer goal",
        "status": "in-progress",
        "statusDate": "2017-01-25"
      }
    },
    {
      "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"
      }
    }
  ]
}
Status: 200 OK
Functionality: Search by id
{
  "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"
      }
    }
  ]
}

Retrieve by id

List an individual Goal by its id:

GET /Goal/:id

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