1. FHIR DSTU 2 APIs for Oracle Health Millennium Platform
  2. Tasks
  3. Goal

Get a list of goals

get

/Goal

Retrieves a list of goals that meet supplied query parameters.

Request

Query Parameters
  • The logical resource ID associated with the goal.
    • This parameter is required if patient or subject is not used.
    • May not be provided with the patient, subject, or targetdate parameters.
    Example: _id=7891
  • The patient who has the goal. This parameter is required if _id or subject are not used.
    Example: patient=12345
  • The subject who this goal is intended for.
    • Must represent a Patient resource.
    • May use the :Patient modifier.
    • This parameter is required if _id or patient is not used.
    Example: subject=Patient/12345 or subject:Patient=12345
  • A date or date range from which to find goals.
    • May be provided once with a prefix to imply a date range or without a prefix to search for goals at a specific date.
    • May be provided twice with le, lt, ge, or gt prefixes 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
Back to Top

Response

Supported Media Types

Default Response

This operation supports the following authorization types:
  • Provider
  • Patient
  • System
Example Request: 
GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?patient=12724066
Example Response: 
{
  "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"
        }
      }
    }
  ]
}
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
  • 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:
  • Provider
  • Patient
  • System
Example Request: 
GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal?_id=183353727
Example Response: 
{
  "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"
        }
      }
    }
  ]
}
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.
Back to Top