CarePlan

Top  Previous  Next

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.

Response Description

Sample Response

{

  "resourceType": "CarePlan",

  "id": "DEV-DEV-11913-628",

  "meta": {

     "lastUpdated": "2017-08-10T12:00:00-04:00",

     "profile": [

        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"

     ]

  },

  "text": {

     "status": "generated",

     "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table><tbody><tr><td>Patient:</td><td>Cole Andersonian (DEV-DEV-11913)</td></tr><tr><td>Encounter:</td><td>DEV-DEV-11913-0014797</td></tr><tr><td></td></tr><tr><td>Description:</td><td>Plan of Treatment</td></tr><tr><td>Narrative:</td><td>Get an EKG done on 06/23/2015.</td></tr></tbody></table></div>"

  },

  "status": "unknown",

  "intent": "plan",

  "category": [

     {

        "coding": [

           {

              "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",

              "code": "assess-plan",

              "display": "Assessment and Plan of Treatment"

           }

        ]

     }

  ],

  "title": "Plan of Treatment",

  "description": "Get an EKG done on 06/23/2015.",

  "encounter": {

     "reference": "Encounter/DEV-DEV-11913-0014797",

     "display": "11/07/2022 at 9:30 am, MRI L/Knee with provider 117 at location OF1"

  },

  "subject": {

     "reference": "Patient/DEV-DEV-11913",

     "display": "Cole Andersonian (DEV-DEV-11913)"

  }

}

 

 

CarePlan.id

 

The logical ID of the resource, as used in the URL for the resource. Once assigned, this value never changes.

 

Cardinality

0..1

Type

string

Comment

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

 

 

CarePlan.meta

 

Metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

 

Cardinality

0..1

Type

Meta

 

 

CarePlan.text

 

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.

Cardinality

0..1

Type

Narrative

Comment

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

 

 

CarePlan.text.status

 

Whether the text was generated or is additional information.

Cardinality

1..1

Type

Code : generated | additional

 

 

CarePlan.text.div

 

Limited xhtml content

Cardinality

1..1

Type

xhtml

 

 

CarePlan.status

 

Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

Cardinality

1..1

Type

code: RequestStatus

Comment

Always unknown.

Requirements

Allows clinicians to determine whether the plan is actionable or not.

 

 

CarePlan.intent

 

Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.

Cardinality

1..1

Type

code: Care Plan Intent

Comment

Always plan.

Requirements

Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.

 

 

CarePlan.category:AssessPlan

 

Type of plan.

Cardinality

1..1

Type

CodeableConcept

Comment

There may be multiple axes of categorization and one plan may serve multiple purposes.

 

 

CarePlan.category.coding.system

 

Identifier of the terminology system.

Cardinality

0..*

Type

uri

Comment

Always http://hl7.org/fhir/us/core/CodeSystem/careplan-category

 

 

CarePlan.category.coding.code

 

Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.

Cardinality

0..*

Type

code

Comment

Always assess-plan.

 

 

CarePlan.title

 

Human-friendly name for the care plan.

Cardinality

0..1

Type

string

 

 

CarePlan.description

 

A description of the care plan.

Cardinality

0..1

Type

string

Comments

Provides more detail than conveyed by category.

 

 

CarePlan.encounter

 

The reference to the encounter during which this CarePlan was created or to which the creation of this record is tightly associated.

Cardinality

0..1

Type

Reference(Encounter)

Comment

This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. CarePlan activities conducted as a result of the care plan may well occur as part of other encounters.

 

 

CarePlan.subject

 

Identifies the patient whose intended care is described by the plan.

Cardinality

1..1

Type

Reference(Patient)

 


 

Search

 

URL Syntax

Two HTTP methods are supported for searching: GET and POST. It is recommended to use HTTP POST.

Visit the FHIR Sandbox to try requests.

 

 

HTTP GET - searching

https://sandbox.pai.healthcare/preview/fhir/CarePlan?{query string}

 

HTTP GET - return single record

https://sandbox.pai.healthcare/preview/fhir/CarePlan/{resource id}

 

HTTP POST - searching

https://sandbox.pai.healthcare/preview/fhir/CarePlan/_search

Set the Content-Type header to application/x-www-urlencoded

The body of the request is a similar query string used in the GET type of request detailed above.

 

 

Error Handling

If no records are returned or invalid search parameters are provided, then an HTTP 400 Bad Request is returned.

The body of the response will be an OperationOutcome.

 

 

Supported Search Parameters

 

_id

Corresponds to

CarePlan.id

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/CarePlan/dev-DEV-test-234234

https://sandbox.pai.healthcare/preview/fhir/CarePlan?_id=dev-DEV-test-234234

 

Returns the resource for the test account in the DEV practice where ID is 234234.

 

 

patient

Corresponds to

CarePlan.subject

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/CarePlan?patient=Patient/dev-dev-test

 

Return all care plans for the test account in the DEV practice.

 

 

patient + category

Corresponds to

CarePlan.subject and CarePlan.category

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/CarePlan?category=assess-plan&patient=Patient/dev-dev-test

 

Return all assess-plan care plans for the test account in the DEV practice

 

 

patient + category + _revInclude:Provenance:target

Corresponds to

CarePlan.subject and CarePlan.category

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/CarePlan?category=assess-plan&patient=Patient/dev-dev-test&_revInclude=Provenance:target

 

Return all assess-plan care plans for the test account in the DEV practice. And, for each included record, also include its Provenance record.

 

 

encounter

Corresponds to

CarePlan.encounter

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/CarePlan?encounter=Encounter/0044433

 

Return all care plans for the encounter with accession# 0044433.