Overview
Assessment and Plan of Treatment Information addresses:
- CarePlan HL7® FHIR® resource with US Core Profile 6.1.0
The CarePlan resource describes the intentions of how one or more practitioners plan to deliver care to a specific patient. This profile meets the U.S. Core Data for Interoperability (USCDI) v3 requirements for Assessment and Plan of Treatment Information.
This resource is designed for stating specific activities related to a single patient, rather than generic protocols for condition treatment. CarePlan can represent both proposed plans (for example, recommendations from a decision support engine or returned as part of a consult report) as well as active plans.
Each CarePlan has next elements:
statusintentcategorywith code "assess-plan"subject(patient)
Each CarePlan must support:
- a narrative summary of the patient assessment and plan of treatment
This resource conforms to USCDI v3 for Assessment and Plan of Treatment - refers to US Core CarePlan Profile 6.1.0. CarePlan response will be provided in JSON (refers to Capability Statement) format as per FHIR standard R4 version.
| USCore Data Element | FHIR Resource Field |
|---|---|
| Narrative summary | CarePlan.text |
| Status | CarePlan.status |
| Intent | CarePlan.intent |
| Category | CarePlan.category |
| Patient | CarePlan.subject |
Must support elements, mandatory and optional search parameters
CarePlan must support these elements:
text(narrative summary)statusdiv
statusintentcategorycategory:AssessPlan
subject
Each CarePlan Must Have (Mandatory):
intentcategorycategory:AssessPlan
subject
The following search parameters and search parameter combinations SHALL be supported:
The syntax used to describe the interactions is described here.
SHALL support searching using the combination of the patient and category search parameters:
GET [base url]/CarePlan?patient={Type/}[id]&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan
The following search parameter combinations SHOULD be supported:
SHOULD support searching using the combination of the patient and category and date search parameters:
- including support for these date comparators: gt,lt,ge,le
- including optional support for AND search on date (e.g.date=[date]&date=[date]]&...)
GET [base url]/CarePlan?patient={Type/}[id]&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}
SHOULD support searching using the combination of the patient and category and status search parameters:
- including support for OR search on status (e.g.status={system|}[code],{system|}[code],...)
GET [base url]/CarePlan?patient={Type/}[id]&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&status={system|}[code]{,{system|}[code],...}
SHOULD support searching using the combination of the patient and category and status and date search parameters:
- including support for OR search on status (e.g.status={system|}[code],{system|}[code],...)
- including support for these date comparators: gt,lt,ge,le
- including optional support for AND search on date (e.g.date=[date]&date=[date]]&...)
GET [base url]/CarePlan?patient={Type/}[id]&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&status={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
CarePlan By Patient and Category
Search for CarePlan using combination of the patient and category parameters.
METHOD GET
GET [base url]/CarePlan?patient={Type/}[id]&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-planPARAMS
[base url] - FHIR base url
{Type/} - Reference type for the patient resource. Example: Patient/
[id] - Id for Patient resource
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/CarePlan?patient=Patient/aa74fca2-2c68-47a8-98b6-3857d3df75c4&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'CarePlan By Patient, Category, and Date
Search for CarePlan using combination of the patient, category, and date parameters.
METHOD GET
GET [base url]/CarePlan?patient={Type/}[id]&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}PARAMS
[base url] - FHIR base url
{Type/} - Reference type for the patient resource. Example: Patient/
[id] - Id for Patient resource
{gt|lt|ge|le} - Date search modifiers. See Search specification for more information.
[date] - Date for the period search
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/CarePlan?patient=Patient/aa74fca2-2c68-47a8-98b6-3857d3df75c4&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&date=ge2023-01-01&date=le2023-12-31' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'CarePlan By Patient, Category, and Status
Search for CarePlan using combination of the patient, category, and status parameters.
METHOD GET
GET [base url]/CarePlan?patient={Type/}[id]&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&status={system|}[code]{,{system|}[code],...}PARAMS
[base url] - FHIR base url
{Type/} - Reference type for the patient resource. Example: Patient/
[id] - Id for Patient resource
{system|} - Status system. FHIR search token parameter. See Search specification for more information.
[code] - Status code. Example: active, draft, completed
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/CarePlan?patient=Patient/aa74fca2-2c68-47a8-98b6-3857d3df75c4&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&status=active' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'CarePlan By Patient, Category, Status, and Date
Search for CarePlan using combination of the patient, category, status, and date parameters.
METHOD GET
GET [base url]/CarePlan?patient={Type/}[id]&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&status={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}PARAMS
[base url] - FHIR base url
{Type/} - Reference type for the patient resource. Example: Patient/
[id] - Id for Patient resource
{system|} - Status system. FHIR search token parameter.
[code] - Status code. Example: active, draft, completed
{gt|lt|ge|le} - Date search modifiers. See Search specification for more information.
[date] - Date for the period search
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/CarePlan?patient=Patient/aa74fca2-2c68-47a8-98b6-3857d3df75c4&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&status=active&date=ge2023-01-01T00:00:00Z&date=le2023-12-31T23:59:59Z' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'