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:
- id
- Subject (patient)
- Start date
- Target date
- Category
- Description of goal
- Status
- Status date
- Author
- Note
Terminology Bindings
Goal.category |
|
Search
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=7891
|
patient |
This, or one of _id , or subject . |
reference |
The patient who has the goal. Example: patient=12345
|
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/12345 or subject:Patient=12345
|
targetdate |
N | date |
A date or date range from which to find Goals. Example: targetdate=ge2016-10-01&targetdate=le2016-12-01
|
Notes:
-
The
_id
parameter may not be provided at the same time as thepatient
,subject
, ortargetdate
parameters. -
The
targetdate
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 withle
,lt
,ge
, orgt
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
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"
}
}
}
]
}
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/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"
}
}
}
]
}
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
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"
}
}
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.