Overview
Assessment and Plan of Treatment addresses to the CarePlan HL7® FHIR® resource.
The CarePlan resource describes the intentions of how one or more practitioners plan to deliver care to a specific patient. 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:
- a narrative summary of the patient assessment and plan of treatment
- a status
- an intent
- a category code of “assess-plan”
- a patient
Each CarePlan must support:
- text
- status
- div
- status
- category
- subject
Profile specific implementation guidance:
- Additional considerations for systems aligning with HL7 Consolidated (C-CDA) Care Plan requirements:
- US Core Goal SHOULD be present in CarePlan.goal
- US Core Condition SHOULD be present in CarePlan.addresses
- Assessment and Plan MAY be included as narrative text
TThis resource conforms to USCDI V2 profile for CarePlan - refers to US Core CarePlan Profile. 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:
test
status
div
status
intent
category
category: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]/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]/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]/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
Get CarePlan by combination of the patient
and category
METHOD GET
[base url]/CarePlan?patient={Type/}[id]&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan
PARAMS
[base url] - FHIR base url
{Type/} - reference type for the patient resource (Optional)
[id] - Id for Patient resource
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Go to Authentication and Authorization for further details.
Header | Type | Required/Optional | Value |
---|---|---|---|
Authorization | string | required | 'Bearer' |
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 entered 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'