FHIR R4 APIs for Oracle Soarian Clinicals

Get a list of care plans

get

/CarePlan

Search for CarePlan resources that meet the specified query parameters.

GET /CarePlan?:parameters

This operation supports the following authorization types:

Provider
Patient
System

Request

Query Parameters

_count: string

The maximum number of resources returned in a page.
Type: count.
_id: string

The logical resource ID associated with the resource.
This parameter is required if patient is not used.
Type: token.
_revinclude: string

A request to include any Provenance resource in the bundle that refers to a CarePlan resource in the search results. Only supported with Provenance.
Type: _revinclude.
The _revinclude parameter may be provided once with the value Provenance:target. For example: _revinclude=Provenance:target.
When _revinclude is provided in a request, the OAuth2 token must include the patient/Provenance.read system/Provenance.read or user/Provenance.read scope as applicable.
category: string

The scope of the care plan. For example, category=assess-plan
Type: token.
This parameter is required with the patient parameter.
This parameter can be combined with the _id parameter.
This parameter only supports the code assess-plan.
encounter: string

The encounter associated with the care plan record.
Type: reference.
patient: string

The patient who has the care plan.
This parameter is required if _id is not used.
Type: reference.

Header Parameters

Accept(required): string

The media type to be requested. Refer to what the resource's operation produces for what is supported.
Authorization(required): string

Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

Response

Supported Media Types

application/fhir+json

Default Response

Example Search by Patient and Category
Example Request

GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/CarePlan?patient=A879904FD2FE4B2D90C89FDA84E1285F&category=assess-plan

Example Response:

{
  "resourceType": "Bundle",
  "id": "5b57aff5-d3ed-4f11-aeef-e8f7440870e9",
  "type": "searchset",
  "timestamp": "2022-05-16T03:21:23-04:00",
  "entry": [
    {
      "fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/CarePlan/A879904FD2FE4B2D90C89FDA84E1285F.NRS.43060",
      "resource": {
        "resourceType": "CarePlan",
        "id": "A879904FD2FE4B2D90C89FDA84E1285F.NRS.43060",
        "meta": {
          "lastUpdated": "2020-11-15T16:09:49-05:00"
        },
        "status": "active",
        "intent": "plan",
        "category": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
                "code": "assess-plan"
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
          "display": "Mcgovern,Astrid Santiago"
        },
        "encounter": {
          "reference": "Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019",
          "display": "Inferno,Initial"
        },
        "text": {
          "status": "additional",
          "div": "<div xmlns='http://www.w3.org/1999/xhtml'><b>*** The appearance of the following text may differ from its appearance on the native electronic health record, but the content is the same. For example, text displayed in color may appear in regular,black type.***</b><br /><b>CarePlan</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago
<b>Status</b>:active<br /><b>Encounter</b>:Inferno,Initial<br /><b>Intent</b>:plan<br /><b>Category : </b><b>System</b>:http://hl7.org/fhir/us/core/CodeSystem/careplan-category <b>Code</b>:assess-plan<br /><b>Assessment and Plan</b>:<ul><li>Comments: <span><p>i. The patient was found to have Anemia and Dr Seven and his staff diagnosed</p> <p>the condition and treated Ms Rebecca for Anemia during the 2 day stay at</p> <p>Community Health Hospitals. Ms Rebecca recovered from Anemia during</p> <p>the stay and is being discharged in a stable condition. If there is fever</p> <p>greater than 101.5 F or onset of chest pain/breathlessness the patient is</p> <p>advised to contact emergency.</p></span></li></ul><br /></div>"
        }
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/CarePlan?patient=A879904FD2FE4B2D90C89FDA84E1285F&category=assess-plan"
    }
  ]
}

x-_id Response

Example Request

GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/CarePlan?_id=A879904FD2FE4B2D90C89FDA84E1285F.NRS.43060

Example Response:

{
  "resourceType": "Bundle",
  "id": "5b57aff5-d3ed-4f11-aeef-e8f7440870e9",
  "type": "searchset",
  "timestamp": "2022-05-16T03:21:23-04:00",
  "entry": [
    {
      "fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/CarePlan/A879904FD2FE4B2D90C89FDA84E1285F.NRS.43060",
      "resource": {
        "resourceType": "CarePlan",
        "id": "A879904FD2FE4B2D90C89FDA84E1285F.NRS.43060",
        "meta": {
          "lastUpdated": "2020-11-15T16:09:49-05:00"
        },
        "status": "active",
        "intent": "plan",
        "category": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
                "code": "assess-plan"
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
          "display": "Mcgovern,Astrid Santiago"
        },
        "encounter": {
          "reference": "Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019",
          "display": "Inferno,Initial"
        },
        "text": {
          "status": "additional",
          "div": "<div xmlns='http://www.w3.org/1999/xhtml'><b>*** The appearance of the following text may differ from its appearance on the native electronic health record, but the content is the same. For example, text displayed in color may appear in regular,black type.***</b><br /><b>CarePlan</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago<br /><b>Status</b>:active<br /><b>Encounter</b>:Inferno,Initial
<b>Intent:plan
<b>Category : </b><b>System</b>:http://hl7.org/fhir/us/core/CodeSystem/careplan-category <b>Code</b>:assess-plan<br /><b>Assessment and Plan</b>:<ul><li>Comments: <span><p>i. The patient was found to have Anemia and Dr Seven and his staff diagnosed</p> <p>the condition and treated Ms Rebecca for Anemia during the 2 day stay at</p> <p>Community Health Hospitals. Ms Rebecca recovered from Anemia during</p> <p>the stay and is being discharged in a stable condition. If there is fever</p> <p>greater than 101.5 F or onset of chest pain/breathlessness the patient is</p> <p>advised to contact emergency.</p></span></li></ul><br /></div>"
        }
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/CarePlan?patient=A879904FD2FE4B2D90C89FDA84E1285F&category=assess-plan"
    }
  ]
}

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.