CarePlan

Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.

https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-careplan.html

A CarePlan in Canvas translates to the Integrated Care Plan PDF you can print on the patient’s chart. This endpoint will return either one or zero care plans for each patient. If no care plan was returned for a given patient, then that patient has never had a Goal command committed on their chart.

Endpoints

get
/CarePlan/{id}
 get
/CarePlan
get
/CarePlan/{id}

CarePlan read

Read a CarePlan resource.

Path Parameters

id required
string
The unique identifier for the CarePlan

Response Payload Attributes

resourceType
string

The FHIR Resource name.

id
string

The identifier of the CarePlan.

text
json

Text summary of the resource, for human interpretation.

Click to view child attributes
status

All resources returned from this endpoint will show a status of generated since this resource is generated by Canvas.

div

Limited xhtml content that contains the human readable text of the resource.

status
enum [active]

Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. Currently, this value will always return active.

intent
enum [plan]

Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain. Currently, this value will always return plan.

category
array[json]

Type of plan.

Click to view child attributes
coding
array[json]

A CodeableConcept combination of one or more coding elements.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://hl7.org/fhir/us/core/CodeSystem/careplan-category
  • http://snomed.info/sct
code
string

The code of the category.

display
string

The display name of the coding.

subject
json

Who the care plan is for.

Click to view child attributes
reference
string

The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".

type
string

Type the reference refers to (e.g. “Patient”).

Responses

200 OK
Request was successful.

Errors

401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
404 Not Found
The requested resource was not found.
get
/CarePlan

CarePlan search

Search for CarePlan resources.

Query Parameters

_id
string

The unique Canvas identifier of the CarePlan.

category
string

A category code in the format system|code.

Search Values Supported:
  • http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan
  • http://snomed.info/sct|734163000
patient
string

The patient reference for who this care plan is for, in the format Patient/a39cafb9d1b445be95a2e2548e12a787.

Response Payload Attributes

resourceType
string

The FHIR Resource name.

type
string

This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .

total
integer

The number of resources that match the search parameter.

link
array[json]

Attributes relevant to pagination, see our Pagination page for more detail.

Click to view child attributes
relation
enum [self|first|next|last]

The relation of the page search

url

The search url for the specific relation

entry
array[json]

The results bundle that lists out each object returned in the search

Click to view child attributes
resource
json

The attributes specific to the resource type, see the Attributes section below

Attributes

resourceType
string

The FHIR Resource name.

id
string

The identifier of the CarePlan.

text
json

Text summary of the resource, for human interpretation.

Click to view child attributes
status

All resources returned from this endpoint will show a status of generated since this resource is generated by Canvas.

div

Limited xhtml content that contains the human readable text of the resource.

status
enum [active]

Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. Currently, this value will always return active.

intent
enum [plan]

Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain. Currently, this value will always return plan.

category
array[json]

Type of plan.

Click to view child attributes
coding
array[json]

A CodeableConcept combination of one or more coding elements.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://hl7.org/fhir/us/core/CodeSystem/careplan-category
  • http://snomed.info/sct
code
string

The code of the category.

display
string

The display name of the coding.

subject
json

Who the care plan is for.

Click to view child attributes
reference
string

The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".

type
string

Type the reference refers to (e.g. “Patient”).

Responses

200 OK
Request was successful.

Errors

400 Bad Request
The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
  • curl --request GET \
     --url 'https://fumage-example.canvasmedical.com/CarePlan/<id>' \
     --header 'Authorization: Bearer <token>' \
     --header 'accept: application/json'

  • import requests

url = "https://fumage-example.canvasmedical.com/CarePlan/<id>"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

  • {
    "resourceType": "CarePlan",
    "id": "b4190e86-1a63-4010-85fe-5c42b607d2f9",
    "text": {
        "status": "generated",
        "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hapiHeaderText\">CarePlan</div><table class=\"hapiPropertyTable\"><tbody><tr><td>Coding</td><td>{'system': 'http://snomed.info/sct', 'code': '734163000', 'display': 'Care plan'}</td></tr><tr><td>For Patient Name</td><td><span>Cube, Rubik N. (Nick Name)</span></td></tr></tbody></table></div>"
    },
    "status": "active",
    "intent": "plan",
    "category": [
        {
            "coding": [
                {
                    "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
                    "code": "assess-plan"
                }
            ]
        },
        {
            "coding": [
                {
                    "system": "http://snomed.info/sct",
                    "code": "734163000",
                    "display": "Care plan"
                }
            ]
        }
    ],
    "subject": {
        "reference": "Patient/a1197fa9e65b4a5195af15e0234f61c2",
        "type": "Patient"
    }
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "unknown",
      "details": {
        "text": "Authentication failed"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "forbidden",
      "details": {
        "text": "Authorization failed"
      }
    }
  ]
}

  • {
    "resourceType": "OperationOutcome",
    "issue": [
        {
            "severity": "error",
            "code": "not-found",
            "details": {
                "text": "Unknown CarePlan resource '7d1ce256fcd7408193b0459650937a07'"
            }
        }
    ]
}

  • curl --request GET \
     --url 'https://fumage-example.canvasmedical.com/CarePlan?patient=Patient/11430ad243f84ad2a47b1267d33ce9b8&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan' \
     --header 'Authorization: Bearer <token>' \
     --header 'accept: application/json'

  • import requests

url = "https://fumage-example.canvasmedical.com/CarePlan?patient=Patient/11430ad243f84ad2a47b1267d33ce9b8&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

  • {
    "resourceType": "Bundle",
    "type": "searchset",
    "total": 1,
    "link": [
        {
            "relation": "self",
            "url": "/CarePlan?patient=Patient/a1197fa9e65b4a5195af15e0234f61c2&_count=10&_offset=0"
        },
        {
            "relation": "first",
            "url": "/CarePlan?patient=Patient/a1197fa9e65b4a5195af15e0234f61c2&_count=10&_offset=0"
        },
        {
            "relation": "last",
            "url": "/CarePlan?patient=Patient/a1197fa9e65b4a5195af15e0234f61c2&_count=10&_offset=0"
        }
    ],
    "entry": [
        {
            "resource": {
                "resourceType": "CarePlan",
                "id": "b4190e86-1a63-4010-85fe-5c42b607d2f9",
                "text": {
                    "status": "generated",
                    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hapiHeaderText\">CarePlan</div><table class=\"hapiPropertyTable\"><tbody><tr><td>Coding</td><td>{'system': 'http://snomed.info/sct', 'code': '734163000', 'display': 'Care plan'}</td></tr><tr><td>For Patient Name</td><td><span>Cube, Rubik N. (Nick Name)</span></td></tr></tbody></table></div>"
                },
                "status": "active",
                "intent": "plan",
                "category": [
                    {
                        "coding": [
                            {
                                "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
                                "code": "assess-plan"
                            }
                        ]
                    },
                    {
                        "coding": [
                            {
                                "system": "http://snomed.info/sct",
                                "code": "734163000",
                                "display": "Care plan"
                            }
                        ]
                    }
                ],
                "subject": {
                    "reference": "Patient/a1197fa9e65b4a5195af15e0234f61c2",
                    "type": "Patient"
                }
            }
        }
    ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "invalid",
      "details": {
        "text": "Bad request"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "unknown",
      "details": {
        "text": "Authentication failed"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "forbidden",
      "details": {
        "text": "Authorization failed"
      }
    }
  ]
}