Overview
Assessment and Plan of Treatment Information addresses:- CarePlan HL7® FHIR® resource with US Core Profile 6.1.0
statusintentcategorywith code “assess-plan”subject(patient)
- a narrative summary of the patient assessment and plan of treatment
| 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
intentcategorycategory:AssessPlan
subject
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 thepatient and category parameters.
METHOD GET
Patient/
[id] - Id for Patient resource
HEADERS
The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
| 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 |
CarePlan By Patient, Category, and Date
Search for CarePlan using combination of thepatient, category, and date parameters.
METHOD GET
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 the Authentication and Authorization process. Go to Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
| 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 |
CarePlan By Patient, Category, and Status
Search for CarePlan using combination of thepatient, category, and status parameters.
METHOD GET
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 the Authentication and Authorization process. Go to Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
| 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 |
CarePlan By Patient, Category, Status, and Date
Search for CarePlan using combination of thepatient, category, status, and date parameters.
METHOD GET
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 the Authentication and Authorization process. Go to Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
| 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 |