Get a list of CarePlans
GET {{baseUrl}}/api/v2/CarePlan?patient=<string>&departmentId=<integer>&third-party-user-name=<string>&patient-facing-call=<boolean>&status=draft&category=treatment
Overview:
Retrieves detailed information on patient care plans, enabling healthcare developers to access and display real-time data regarding treatment regimens and care instructions for streamlined coordination within clinical workflows.
This is only supported in ATHENA.
Use Cases:
Review Care History: Review full care plan history
Share Plan With New Provider: Share with new treating provider
Assess Adherence: Evaluate adherence to treatments
Appeal Insurance Denial: Obtain as evidence for insurance appeal
Analyze Treatment Efficacy: Analyze efficacy over time
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
patient | string | (Required) The patient identifier associated with the care plan. | |
departmentId | string | (Required) The department identifier | |
third-party-user-name | string | The third party user name | |
patient-facing-call | string | Flag to indicate if the call is patient facing | |
status | string | The status of the care plan. | |
category | string | The category of the care plan. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-source-id | string | (Required) The source id provided for connecting to the data source | |
Authorization | string |
RESPONSES
status: OK
[{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e"},"data":{"resourceType":"Bundle","type":"searchset","total":"\u003cinteger\u003e","entry":[{"resource":{"resourceType":"CarePlan","id":"\u003cstring\u003e","intent":"option","subject":{"reference":"\u003cstring\u003e"},"category":[{"text":"\u003cstring\u003e","coding":[{"display":"\u003cstring\u003e","code":"\u003cstring\u003e","system":"\u003cstring\u003e"},{"display":"\u003cstring\u003e","code":"\u003cstring\u003e","system":"\u003cstring\u003e"}]},{"text":"\u003cstring\u003e","coding":[{"display":"\u003cstring\u003e","code":"\u003cstring\u003e","system":"\u003cstring\u003e"},{"display":"\u003cstring\u003e","code":"\u003cstring\u003e","system":"\u003cstring\u003e"}]}],"status":"active","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}},{"resource":{"resourceType":"CarePlan","id":"\u003cstring\u003e","intent":"option","subject":{"reference":"\u003cstring\u003e"},"category":[{"text":"\u003cstring\u003e","coding":[{"display":"\u003cstring\u003e","code":"\u003cstring\u003e","system":"\u003cstring\u003e"},{"display":"\u003cstring\u003e","code":"\u003cstring\u003e","system":"\u003cstring\u003e"}]},{"text":"\u003cstring\u003e","coding":[{"display":"\u003cstring\u003e","code":"\u003cstring\u003e","system":"\u003cstring\u003e"},{"display":"\u003cstring\u003e","code":"\u003cstring\u003e","system":"\u003cstring\u003e"}]}],"status":"on-hold","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}}]}},{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e"},"data":{"resourceType":"Bundle","type":"searchset","total":"\u003cinteger\u003e","entry":[{"resource":{"resourceType":"CarePlan","id":"\u003cstring\u003e","intent":"proposal","subject":{"reference":"\u003cstring\u003e"},"category":[{"text":"\u003cstring\u003e","coding":[{"display":"\u003cstring\u003e","code":"\u003cstring\u003e","system":"\u003cstring\u003e"},{"display":"\u003cstring\u003e","code":"\u003cstring\u003e","system":"\u003cstring\u003e"}]},{"text":"\u003cstring\u003e","coding":[{"display":"\u003cstring\u003e","code":"\u003cstring\u003e","system":"\u003cstring\u003e"},{"display":"\u003cstring\u003e","code":"\u003cstring\u003e","system":"\u003cstring\u003e"}]}],"status":"unknown","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}},{"resource":{"resourceType":"CarePlan","id":"\u003cstring\u003e","intent":"plan","subject":{"reference":"\u003cstring\u003e"},"category":[{"text":"\u003cstring\u003e","coding":[{"display":"\u003cstring\u003e","code":"\u003cstring\u003e","system":"\u003cstring\u003e"},{"display":"\u003cstring\u003e","code":"\u003cstring\u003e","system":"\u003cstring\u003e"}]},{"text":"\u003cstring\u003e","coding":[{"display":"\u003cstring\u003e","code":"\u003cstring\u003e","system":"\u003cstring\u003e"},{"display":"\u003cstring\u003e","code":"\u003cstring\u003e","system":"\u003cstring\u003e"}]}],"status":"entered-in-error","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}}]}}]