CarePlan
Overview
The CarePlan resource describes the intention of how one or more practitioners plan to deliver care for a patient specific to an encounter.
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:
Terminology Bindings
CarePlan.category |
|
Search
Search for CarePlan resources that meet the specified query parameters:
GET /CarePlan?: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 care plan. |
category |
See notes | token |
The scope of the care plan. Example: category=assess-plan
|
encounter |
No | reference |
The encounter associated with the care plan record. |
_count |
No | count |
The maximum number of resources returned in a page. |
_revincude |
No | _revinclude |
A request to include any Provenance resource in the bundle that refers to a CarePlan resource in the search results. Only supported with Provenance. |
Notes:
- Either
_id
orpatient
andcategory
is required. - The
category
parameter:- May be combined with the
_id
parameter. - Is required with the
patient
parameter. - Only supports the code
assess-plan
.
- May be combined with the
- The
_revinclude
parameter may be provided once with the valueProvenance:target
. Example:_revinclude=Provenance:target
- When
_revinclude
is provided in a request, the OAuth2 token must include thepatient/Provenance.read system/Provenance.read
oruser/Provenance.read
scope as applicable.
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example Search by Patient and Category
Request
GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/CarePlan?patient=A879904FD2FE4B2D90C89FDA84E1285F&category=assess-plan
Response
Status: 200 OK
{
"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<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"
}
]
}
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/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/CarePlan?_id=A879904FD2FE4B2D90C89FDA84E1285F.NRS.43060
Response
Status: 200 OK
{
"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<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"
}
]
}
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 CarePlan resource by its ID:
GET /CarePlan/:id
Authorization Types
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/CarePlan/A879904FD2FE4B2D90C89FDA84E1285F.NRS.43060
Response
Status: 200 OK
{
"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<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>"
}
}
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.