Get a list of goals
get
/Goal
Retrieves a list of goals that meet supplied query parameters.
Request
Query Parameters
-
_id: string
The logical resource ID associated with the goal. This parameter is required if
patientis not used. This parameter may not be provided at the same time as thepatientortarget-date. Example:_id=7891 -
_revinclude: string
Provenance resource entries to be returned as part of the bundle. The
_revincludeparameter may be provided once with the valueProvenance:target.
Example:_revinclude=Provenance:targetThe_revincludeparameter may be provided with the_id/patientparameter. For example,_id=178866310&_revinclude=Provenance:target. When_revincludeis provided in a request to the closed endpoint, the OAuth2 token must include the scope corresponding to the authorization type, such asuser/Provenance.read,patient/Provenance.readorsystem/Provenance.read. -
patient: string
The patient who has the goal. This parameter is required if
_idis not used.
Example:patient=12345 -
target-date: string
A date or date range from which to find goals. The
target-dateparameter 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, orgtprefixes to search for goals within a specific range. The date and prefix pairs must create a closed range. Example:target-date=ge2016-10-01&target-date=le2016-12-01
Header Parameters
-
accept(required): string
The media type to be requested. See what the resource's operation produces for what is supported.
Response
Supported Media Types
- application/json+fhir
Default Response
This operation supports the following authorization types:
Example Request:
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?_id=498290085&_revinclude=Provenance:target{
"resourceType": "Bundle",
"id": "4a1ae23d-cb80-49ac-9b3b-6abbdb7d5b92",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?_id=498290085&_revinclude=Provenance%3Atarget"
}
],
"entry": [
{
"fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal/498290085",
"resource": {
"resourceType": "Goal",
"id": "498290085",
"meta": {
"versionId": "1610019857000",
"lastUpdated": "2021-01-07T11:44:17.000Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Goal</b></p><p><b>Subject</b>: Smith, Grace</p><p><b>Description</b>: Fighting depression</p><p><b>Expressed By</b>: Smith, Grace</p><p><b>Status</b>: Cancelled</p><p><b>Start Date</b>: Jan 7, 2021</p></div>"
},
"lifecycleStatus": "cancelled",
"category": [
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4003016",
"code": "71690181",
"display": "Behavioral",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/goal-category",
"code": "behavioral",
"display": "Behavioral",
"userSelected": false
}
],
"text": "Behavioral"
},
{
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4003016",
"code": "71690193",
"display": "Physiologic",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/goal-category",
"code": "physiotherapy",
"display": "Physiotherapy",
"userSelected": false
}
],
"text": "Physiologic"
}
],
"description": {
"text": "Fighting depression"
},
"subject": {
"reference": "Patient/2100031",
"display": "Smith, Grace"
},
"startDate": "2021-01-07",
"statusDate": "2021-01-07",
"expressedBy": {
"reference": "Patient/2100031",
"display": "Smith, Grace"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/INT.goal-498290085",
"resource": {
"resourceType": "Provenance",
"id": "INT.goal-498290085",
"meta": {
"versionId": "498290085",
"lastUpdated": "2021-01-07T11:44:17Z"
},
"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>"
},
"target": [
{
"reference": "Goal/498290085"
}
],
"recorded": "2021-01-07T11:44:17Z",
"agent": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
"code": "author"
}
],
"text": "Author"
},
"role": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
"code": "SOURCE"
}
],
"text": "Source"
}
],
"who": {
"reference": "Practitioner/118617332",
"display": "One Plan, One Plan"
}
},
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
"code": "author"
}
],
"text": "Author"
},
"role": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
"code": "SOURCE"
}
],
"text": "Source"
}
],
"who": {
"reference": "Organization/57535538",
"display": "DEVENG-DEFAULT-PROV"
}
}
]
},
"search": {
"mode": "include"
}
}
]
}
Headers
-
X-Request-Id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
X-Request-Id, if present. -
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
opc-Request-Id, if present.
x-_id Response
This operation supports the following authorization types:
Example Request:
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?_id=187042107{
"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"
}
]
}
}
]
}
Headers
-
X-Request-Id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
X-Request-Id, if present. -
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
opc-Request-Id, if present.
x-patient Response
This operation supports the following authorization types:
Example Request:
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?patient=12724069{
"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"
}
]
}
}
]
}
Headers
-
X-Request-Id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
X-Request-Id, if present. -
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
opc-Request-Id, if present.
x-target-date Response
This operation supports the following authorization types:
Example Request:
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?patient=12724069&target-date=gt2021-01-12{
"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"
}
]
}
}
]
}
Headers
-
X-Request-Id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
X-Request-Id, if present. -
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
opc-Request-Id, if present.
x-with-nil-lifecycleStatus Response
This operation supports the following authorization types:
Example Request:
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?patient=14512110&target-date=gt2021-01-12{
"resourceType": "Bundle",
"id": "1a9cbff7-6092-4180-9cb2-186730799e98",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?patient=14512110&target-date=gt2021-01-12"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal/187555585",
"resource": {
"resourceType": "Goal",
"id": "187555585",
"meta": {
"versionId": "1654548637000",
"lastUpdated": "2022-06-06T20:50:37.000Z"
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Goal</b></p><p><b>Subject</b>: PHY, Esig1</p><p><b>Description</b>: Lose Weight</p><p><b>Status</b>: Active</p><p><b>Start Date</b>: Jun 6, 2022</p><p><b>Target Date</b>: Jul 6, 2022</p></div>"
},
"lifecycleStatus": "active",
"achievementStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/goal-achievement",
"code": "not-achieved",
"display": "Not Achieved"
}
],
"text": "Not Achieved"
},
"category": [
{
"coding": [
{
"system": "https://fhir.cerner.com/91fd1841-fb25-42f3-a48e-1264a2c6b72a/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": "Lose Weight"
},
"subject": {
"reference": "Patient/14512110",
"display": "PHY, Esig1"
},
"startDate": "2022-06-06",
"target": [
{
"dueDate": "2022-07-06"
}
],
"statusDate": "2022-06-06"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "urn:uuid:01e2fd7d-8797-44d3-8c16-85179ec463bb",
"resource": {
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "warning",
"code": "suppressed",
"diagnostics": "Other search results were found but could not be compliantly expressed and hence have been suppressed"
}
]
},
"search": {
"mode": "outcome"
}
}
]
}Headers
-
X-Request-Id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
X-Request-Id, if present. -
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
opc-Request-Id, if present.