CarePlan

Overview

The CarePlan resource describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions.

Resource Schema

Key fields in the CarePlan resource:

{
  "resourceType": "CarePlan",
  "id": "example-careplan-123",
  "status": "active",
  "intent": "plan",
  "category": [
    {
      "coding": [
        {
          "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
          "code": "assess-plan",
          "display": "Assessment and Plan of Treatment"
        }
      ]
    }
  ],
  "title": "Diabetes Management Plan",
  "description": "Comprehensive care plan for diabetes management",
  "subject": {
    "reference": "Patient/123456"
  },
  "period": {
    "start": "2023-07-15",
    "end": "2024-07-15"
  },
  "author": {
    "reference": "Practitioner/789"
  },
  "addresses": [
    {
      "reference": "Condition/diabetes-456"
    }
  ]
}

Operations

The CarePlan resource supports Read and Search operations. Support varies by CareRecord solution.

CareRecord / Solution	Read	Search
GEHRIMED	✅	✅
myAvatar	✅	✅
myEvolv	✅	✅
myUnity	✅	✅
TheraOffice	✅	✅

Read

Retrieves a specific CarePlan resource by ID.

HTTP Method: GET
URL: /CarePlan/{id}

Examples

Production

curl -X GET https://fhir.netsmartcloud.com/uscore/v1/CarePlan/123456 \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Preview

curl -X GET https://fhirtest.netsmartcloud.com/uscore/v1/CarePlan/123456 \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Search

Retrieves CarePlan resources matching specified criteria.

HTTP Method: GET or POST
URL: /CarePlan or /CarePlan/_search

Search Parameters

Patient-based Search:

Parameter	Type	Required	Description	Example
patient	reference	Yes	REQUIRED Who the care plan is for	patient=value
category	token	No	Type of plan	category=value
date	date	No	Time period plan covers	date=value
page	string	No	Zero-based page index	page=value
status	token	No	draft	status=value
_revinclude	special	No	Include Provenance resource(s) that reference the matched search results. Allowed: "Provenance:target"	_revinclude=value

ID-based Search:

Parameter	Type	Required	Description	Example
category	token	No	Type of plan	category=value
date	date	No	Time period plan covers	date=value
page	string	No	Zero-based page index	page=value
status	token	No	draft	status=value
_revinclude	special	No	Include Provenance resource(s) that reference the matched search results. Allowed: "Provenance:target"	_revinclude=value

Examples

POST Method (Recommended)

Production

Search by Patient and Category

curl -X POST https://fhir.netsmartcloud.com/uscore/v1/CarePlan/_search \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "patient=Patient/123" \
    -d "category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan"

Preview

Search by Patient and Category

curl -X POST https://fhirtest.netsmartcloud.com/uscore/v1/CarePlan/_search \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "patient=Patient/123" \
    -d "category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan"

GET Method

Production

Search by Patient and Category

curl -X GET "https://fhir.netsmartcloud.com/uscore/v1/CarePlan?patient=Patient/123&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Preview

Search by Patient and Category

curl -X GET "https://fhirtest.netsmartcloud.com/uscore/v1/CarePlan?patient=Patient/123&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Integration Patterns

Common Workflows

1. Care Coordination - Retrieve active care plans for a patient
2. Treatment Planning - Review care plans by category or condition
3. Care Management - Track progress against established care plans

Relationships to Other Resources

The CarePlan resource relates to:

• Patient - Subject of the care plan
• Practitioner - Who authored or manages the care plan
• Condition - Conditions addressed by the care plan
• Goal - Goals established within the care plan
• CareTeam - Team members involved in care delivery

Error Handling

For common errors and troubleshooting guidance, see Common Errors.

Supported Profiles

Profiles supported by this resource (as defined in the CapabilityStatement):

• HL7 FHIR R4 CarePlan
• US Core CarePlan