Goal
Overview
The Goal resource describes intended objectives for a patient. A goal is typically expressed as a desired outcome or health state for a patient to achieve 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 nonhealth care related (for example, to dance at a wedding).
Soarian Clinicals® supports a read-only Application Programming Interface (API). This API accepts GET and POST based search and GET based read interactions. The response represents the most current information about the patient that is charted in Soarian Clinicals® at the time of the query.
The search results include the following fields if they contain values:
Search
Search for Goal resources that meet the specified query parameters:
GET/Goal?:parameters
Authorization Types
Parameters
| Name | Required? | Type | Description |
|---|---|---|---|
_id |
This, or patient
|
token |
The logical resource ID associated with the resource. |
patient |
This, or _id
|
reference |
The patient who has the goal. |
_revinclude |
No | _revinclude |
A request to include any Provenance resource in the bundle that refers to a Goal resource in the search results. Only supported with Provenance. |
Notes:
- The
_revincludeparameter may be provided once with the valueProvenance:target. Example:_revinclude=Provenance:target - When
_revincludeis provided in a request, the OAuth2 token must include thepatient/Provenance.read system/Provenance.readoruser/Provenance.readscope as applicable.
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>Example Search by Patient
Request
GET https://fhir-myrecord-sc.cerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Goal?patient=A879904FD2FE4B2D90C89FDA84E1285F
Response
Status: 200 OK{
"resourceType": "Bundle",
"id": "0cebf130-3245-405e-9e83-96c498cbd602",
"type": "searchset",
"timestamp": "2022-05-10T01:45:56-04:00",
"entry": [
{
"fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Goal/A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083",
"resource": {
"resourceType": "Goal",
"id": "A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083",
"meta": {
"lastUpdated": "2020-11-15T16:21:24-05:00"
},
"lifecycleStatus": "active",
"subject": {
"reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
"display": "Mcgovern,Astrid Santiago"
},
"target": [
{
"dueDate": "2022-11-30"
}
],
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Goal</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago<br /><b>Status</b>:active<br /><b>DueDate</b>:2022-11-30<br /><b>Description</b>:<ul><li>Goal 1: Decrease Sodium Intake</li></ul><br /></div>"
},
"description": {
"text": "<ul><li>Goal 1: Decrease Sodium Intake</li></ul><br/>"
}
}
}
],
"link": [
{
"relation": "self",
"url": "https://fhir-myrecord-sc.cerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Goal?patient=A879904FD2FE4B2D90C89FDA84E1285F&_format=json"
}
]
}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-myrecord-sc.cerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Goal?_id=A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083
Response
Status: 200 OK{
"resourceType": "Bundle",
"id": "0cebf130-3245-405e-9e83-96c498cbd602",
"type": "searchset",
"timestamp": "2022-05-10T01:45:56-04:00",
"entry": [
{
"fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Goal/A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083",
"resource": {
"resourceType": "Goal",
"id": "A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083",
"meta": {
"lastUpdated": "2020-11-15T16:21:24-05:00"
},
"lifecycleStatus": "active",
"subject": {
"reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
"display": "Mcgovern,Astrid Santiago"
},
"target": [
{
"dueDate": "2022-11-30"
}
],
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Goal</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago<br /><b>Status</b>:active<br /><b>DueDate</b>:2022-11-30<br /><b>Description</b>:<ul><li>Goal 1: Decrease Sodium Intake</li></ul><br /></div>"
},
"description": {
"text": "<ul><li>Goal 1: Decrease Sodium Intake</li></ul><br/>"
}
}
}
],
"link": [
{
"relation": "self",
"url": "https://fhir-myrecord-sc.cerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Goal?patient=A879904FD2FE4B2D90C89FDA84E1285F&_format=json"
}
]
}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 Resource by its ID:
GET /Goal/:id
Authorization Types
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>Example
Request
GET https://fhir-myrecord-sc.cerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Goal/A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083
Response
Status: 200 OK{
"resourceType": "Goal",
"id": "A879904FD2FE4B2D90C89FDA84E1285F.NRS.43083",
"meta": {
"lastUpdated": "2020-11-15T16:21:24-05:00"
},
"lifecycleStatus": "active",
"subject": {
"reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
"display": "Mcgovern,Astrid Santiago"
},
"target": [
{
"dueDate": "2022-11-30"
}
],
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Goal</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago<br /><b>Status</b>:active<br /><b>DueDate</b>:2022-11-30<br /><b>Description</b>:<ul><li>Goal 1: Decrease Sodium Intake</li></ul><br /></div>"
},
"description": {
"text": "<ul><li>Goal 1: Decrease Sodium Intake</li></ul><br/>"
}
}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.