FHIR R4 APIs for Oracle Health Millennium Platform

Get a goal by ID

get

/Goal/{ID}

Retrieves an individual goal by the associated goal ID.

Request

Path Parameters

ID(required): string

The logical resource ID.

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-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal/187042107

Example Response:

{
  "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": {
    "coding":[
      {
         "system":"https://fhir.cerner.com/eb2384f8-839e-4c6e-8b29-18e71db1a0b1/codeSet/72",
         "code":"747214249",
         "display":"O-Food security (finding)",
         "userSelected":true
      },
      {
         "system":"http://snomed.info/sct",
         "code":"1078229009",
         "display":"Food security (finding)",
         "userSelected":false
      }
    ],
    "text":"O-Food security (finding)"
  },
  "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-error-in-status Response

This operation supports the following authorization types:

Example Request:

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal/187042111

Example Response:

{
  "resourceType": "Goal",
  "id": "187042111",
  "meta": {
    "versionId": "1607035809000",
    "lastUpdated": "2020-12-03T22:50:09.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>: Error</p><p><b>Status</b>: Entered in Error</p></div>"
  },
  "lifecycleStatus": "entered-in-error",
  "description": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
        "code": "error",
        "display": "Error"
      }
    ],
    "text": "Error"
  },
  "subject": {
    "reference": "Patient/12724069",
    "display": "SMART, TIMMY"
  }
}

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-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Goal/187555592

Example Response:

{
    "resourceType": "OperationOutcome",
    "issue": [
        {
            "severity": "error",
            "code": "not-found",
            "details": {
                "text": "Goal.lifecycleStatus is missing."
            }
        }
    ]
}

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.