CarePlan
Semantical type
The FHIR resource type is also used as semantical type of the resource. Include the FHIR resource name CarePlan into your applications access filter if you need to use this resource.
Resource owner
If the resource contains a subject which is a Patient or Practitioner that user is the owner of the resource. Otherwise the creator of the resource is the owner.
Default value for “subject”
If a resource with no subject field is send to MIDATA, the backend will set the subject to the current user.
Read
Read a single CarePlan by id.
Request:
[GET] /fhir/CarePlan/<id>
Read specific version
Read a specific version of a single CarePlan by id.
Request:
[GET] /fhir/CarePlan/<id>/_history/<version>
Retrieve history
Retrieve all versions of a single resource.
Request:
[GET] /fhir/CarePlan/<id>/_history
Search
Search for resources of type CarePlan
Request:
[GET] /fhir/CarePlan?searchParams
List of supported search parameters:
Supported query parameters:
| Name | Type | Description |
|---|---|---|
| _id | token | The ID of the resource |
| _lastUpdated | date | Only return resources which were last updated as specified by the given range |
| _page | string | |
| activity-code | token | Detail type of activity |
| activity-date | date | Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x] |
| activity-reference | reference | Activity details defined in specific resource |
| based-on | reference | Fulfills CarePlan |
| care-team | reference | Who's involved in plan? |
| category | token | Type of plan |
| condition | reference | Health issues this plan addresses |
| date | date | Time period plan covers |
| encounter | reference | Encounter created as part of |
| goal | reference | Desired outcome of plan |
| identifier | token | External Ids for this plan |
| instantiates-canonical | reference | Instantiates FHIR protocol or definition |
| instantiates-uri | uri | Instantiates external protocol or definition |
| intent | token | proposal - plan - order - option |
| part-of | reference | Part of referenced CarePlan |
| patient | reference | Who the care plan is for |
| performer | reference | Matches if the practitioner is listed as a performer in any of the "simple" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.) |
| replaces | reference | CarePlan replaced by this CarePlan |
| status | token | draft - active - on-hold - revoked - completed - entered-in-error - unknown |
| subject | reference | Who the care plan is for |
Create
Create a new resource of type CarePlan.
Request:
[POST] /fhir/CarePlan
Update
Updates a resource of type CarePlan.
Request:
[PUT] /fhir/CarePlan/<id>