CarePlan
Work with FHIR R4 4.0.1 CarePlan resources.
Choose an operation for this resource:
- Search CarePlan
- Read CarePlan
- Read CarePlan Version
- Create CarePlan
- Update CarePlan
- Delete CarePlan
- Hard Delete CarePlan
- Purge Deleted CarePlan
The diagram summarizes CarePlan requests and responses. See Supported FHIR REST Interactions for the shared interaction model.
FHIR R4 definition: https://hl7.org/fhir/R4/careplan.html. See interaction response codes and common error responses.
The endpoint is /api/fhir/r4/CarePlan. Consult the live CapabilityStatement for supported capabilities. This resource is available on the R4 API.
Interactions and responses
- Resource lifecycle: create, read, versioned read, update, soft deletion and version preconditions.
- PUT-as-create and restoration: creation/restoration, server-managed metadata, response headers and return preferences.
- Interaction responses: success
statuscodes. - OperationOutcome errors: common errors and response bodies.
- Batch requests: independent entry processing.
| CarePlan capability | Support or requirement |
|---|---|
| Conditional create | Not supported. |
| Conditional update | Not supported. |
| Transaction bundles | Not supported. |
Content and validation
For shared validation-error responses, see OperationOutcome errors.
| CarePlan detail | Requirement or behavior |
|---|---|
| Required content | Supply status, intent and subject. |
| Status | Status is draft, active, on-hold, revoked, completed, entered-in-error or unknown; intent is proposal, plan, order or option. |
| Patient references | The subject references Patient or Group. |
| References | Activities can provide a reference or inline detail; they cannot contain both. |
| References | An inline detail requires an activity status and permits one scheduled value (Timing, Period or string) and one product value (CodeableConcept or Reference). |
| Choice elements | The service validates required bindings, reference targets and choice cardinalities. |
| Contained resources | Resource content, primitive extensions, nested details and supported contained resources are preserved. |
| Write provenance | Successful changes generate Provenance. |
{"resourceType":"CarePlan","status":"active","intent":"plan","title":"Synthetic care plan","subject":{"reference":"Patient/synthetic-patient"},"period":{"start":"2026-01-01","end":"2026-12-31"}}Search
- Search operation: endpoints, complete parameter table, supported forms and examples.
- Common Search Controls: shared controls and server-provided paging links.
- Value Types and Syntax and Comparators, Modifiers, and Chains: shared syntax. Use only the forms supported by this resource.
| CarePlan detail | Requirement or behavior |
|---|---|
| Patient references | Selected filters are _id, _lastUpdated, identifier, patient, category, status and date. |
| Patient references | The patient filter matches a Patient-valued subject; Group subjects do not match. |
| Patient references | Patient supports direct references and :identifier. |
| Limitations | Identifier, category and status accept one unmodified token in code, system|code, |code or system| form; repeated tokens, comma alternatives and token modifiers are unsupported. |
| Resource rule | The implicit system for status is http://hl7.org/fhir/request-status. |
| Date filters | date searches CarePlan.period, the time period covered by the plan. |
| Date filters | Both date and _lastUpdated accept up to two bounds combined with AND using eq, ne, gt, lt, ge, le, sa, eb and ap. |
| Limitations | Activity, encounter, clinician and organization filters, new chains, composites and full-text search are not supported. |
GET /api/fhir/r4/CarePlan?patient=Patient/synthetic-patient&status=active&date=ge2026-01-01&date=lt2027-01-01Authorization and permanent deletion
- Authentication and Scopes: bearer tokens, scope configuration and constrained access. Required resource scopes are listed on each operation page.
- Data Deletion and Purge Operations: permanent-deletion eligibility and additional permissions.
- Hard Delete and Purge Deleted: resource endpoints and required scopes; see also shared purge guidance.
| Item | Requirement or behavior |
|---|---|
| Resource constraints | Constraints support _id, _lastUpdated, identifier, patient (including :identifier), category, status and date, including combined constraints. |