Read CarePlan Version
Read CarePlan Version using FHIR R4 4.0.1.
Resource category: CarePlan.
Endpoint
| Method | Endpoint |
|---|---|
GET | /api/fhir/r4/CarePlan/{rid}/_history/{vid} |
Use the R4 base URL from your DDFS instance. Send Authorization: Bearer <access-token> and accept application/fhir+json.
Parameters
| Parameter | Location | Required | Type | Description |
|---|---|---|---|---|
rid | Path | Yes | FHIR logical ID | The logical ID of the CarePlan resource. |
vid | Path | Yes | Version ID | The retained version ID returned in resource metadata or a version-specific Location. |
Authorization
| Context | Resource scope |
|---|---|
| Resource-server definition / issued token | system/CarePlan.r |
| Client grant / token request | ddfssystem/CarePlan.r |
Resource constraints still apply. Use the least privilege needed for this operation; see authentication and scope configuration.
Behavior
Return the requested retained CarePlan version. Later updates do not replace that historical representation; permanent deletion removes retained versions.
- Resource lifecycle and version history: shared operation semantics.
- CarePlan resource guidance: resource-specific requirements and restrictions.
- R4 CapabilityStatement and R4 metadata: supported capabilities.
Example Request
Replace the example logical IDs, version IDs and connection values with values for your workflow.
GET /api/fhir/r4/CarePlan/{rid}/_history/{vid}Responses
| Successful status | Meaning |
|---|---|
| 200 | The requested historical resource representation. |
For common error statuses and FHIR-formatted error bodies, see OperationOutcome errors. Authentication/authorization responses follow the shared policy; a protected resource can be concealed as 404. See also interaction responses.
FHIR Definition
FHIR R4 definition: https://hl7.org/fhir/R4/careplan.html. Canonical profile URI: http://hl7.org/fhir/StructureDefinition/CarePlan.