Skip to main content

CarePlan

Overview​

The CarePlan resource 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.

Use Cases:

  • Treatment planning and coordination
  • Care team communication
  • Patient care management
  • Clinical workflow documentation

Relationships:

  • References Patient resources for care recipients
  • May reference Practitioner, Organization, and other care team members
  • Can be linked to Condition, Goal, and other clinical resources

Resource Schema​

Key fields in the CarePlan resource:

{
  "resourceType": "CarePlan",
  "id": "example-careplan",
  "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"
        }
      ]
    }
  ],
  "subject": {
    "reference": "Patient/123",
    "display": "John Doe"
  },
  "period": {
    "start": "2023-01-01",
    "end": "2023-12-31"
  },
  "author": {
    "reference": "Practitioner/456",
    "display": "Dr. Smith"
  }
}

Operations​

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

CareRecord / SolutionCreateReadUpdateSearch
GEHRIMED-Yes-Yes
myAvatar-Yes-Yes
myEvolv-Yes-Yes
myUnity-Yes-Yes
TheraOffice-Yes-Yes

Read​

Retrieve a specific CarePlan by ID:

GET [base]/CarePlan/[id]

Search for care plans using various criteria.

GET Method​

Use GET for simple searches with parameters in the query string.

GET /CarePlan?parameter=value

POST Method​

Use POST for complex searches with form-encoded parameters.

POST /CarePlan/_search
info

Not all Netsmart solutions support CarePlan search. See supported operations table above and consult your target solution's documentation for more information.

Search Parameters​

Patient-based Search:

ParameterTypeRequiredDescriptionExample
patientreferenceYesREQUIRED Who the care plan is forpatient=value
categorytokenNoType of plancategory=value
datedateNoTime period plan coversdate=value
pagestringNoZero-based page indexpage=value
statustokenNodraftstatus=value
_lastUpdateddateNoOnly return resources which were last updated as specified by the given range_lastUpdated=value
_revincludespecialNoInclude Provenance resource(s) that reference the matched search results. Allowed: "Provenance:target"_revinclude=value

ID-based Search:

ParameterTypeRequiredDescriptionExample
_idtokenNoOnly return resources with the provided id_id=value
_lastUpdateddateNoOnly return resources which were last updated as specified by the given range_lastUpdated=value
_revincludespecialNoInclude Provenance resource(s) that reference the matched search results. Allowed: "Provenance:target"_revinclude=value

Examples​

Read CarePlan​

Read CarePlan by ID
curl -X GET "https://fhir.netsmartcloud.com/uscore/v1/CarePlan/123" \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json"

Search CarePlans​

Via POST (Recommended)​

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-www-form-urlencoded" \
    -d "patient=Patient/123" \
    -d "category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan"

Via GET​

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"

Integration Patterns​

Common Workflows​

  1. Patient Care Planning: Retrieve CarePlans for a specific patient to understand their treatment approach
  2. Care Coordination: Access CarePlans to coordinate care across multiple providers
  3. Treatment Monitoring: Review CarePlans to track progress against planned interventions
  • Patient: Subject of the care plan
  • Practitioner: Care plan authors and contributors
  • Condition: Medical conditions addressed by the care plan
  • Goal: Treatment goals defined in the care plan
  • Provenance: Audit trail for care plan changes

Error Handling​

For detailed error codes and handling, see the Error Handling Guide.

Supported Profiles​

This API supports the following FHIR profiles: