CarePlan Conditional Update

put

CarePlan Conditional Update

The conditional update interaction is used to update an existing CarePlan based on some identification criteria, rather than by logical id.

FHIR documentation for CarePlan.

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400
    400

    CarePlan could not be parsed or failed basic FHIR validation rules (or multiple matches were found).

  • 403
    403

    Not Authorized.

  • 412
    412

    The given criteria is not selective enough.

Environment URL
Live

https://fhirsandbox-prod.apigee.net/fhir/v1/CarePlan

Name Values Description
Authorization

Specify access token for API in the given format: Bearer [access_token].

Accept

The Accept request-header field can be used to specify certain media types which are acceptable for the response.

Content-Type
(required)

Specifies the format of data in body

Name Values Description
_content

Search the contents of the resource's data using a fulltext search

_id

The resource identity

_language

The resource language

_lastUpdated

Only return resources which were last updated as specified by the given range. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). The prefixes >, >=, <= and < may be used on the parameter value.

_lastUpdated

Only return resources which were last updated as specified by the given range. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). Two dates can be used to specify an interval. The prefixes >, >=, <= and < may be used on the parameter value.

_profile

Search for resources which have the given profile

_security

Search for resources which have the given security labels

_tag

Search for resources which have the given tag

_text

Search the contents of the resource's narrative using a fulltext search

activitycode

Detail type of activity

activitydate

Specified date occurs within period specified by CarePlan.activity.timingSchedule. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). The prefixes >, >=, <= and < may be used on the parameter value.

activitydate

Specified date occurs within period specified by CarePlan.activity.timingSchedule. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). Two dates can be used to specify an interval. The prefixes >, >=, <= and < may be used on the parameter value.

activityreference

Activity details defined in specific resource

condition

Health issues this plan addresses

date

Time period plan covers. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). The prefixes >, >=, <= and < may be used on the parameter value.

date

Time period plan covers. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). Two dates can be used to specify an interval. The prefixes >, >=, <= and < may be used on the parameter value.

goal

Desired outcome of plan

participant

Who is involved

patient

Who care plan is for

performer

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.)

relatedcode

includes | replaces | fulfills

relatedcode-relatedplan

A combination of the type of relationship and the related plan

relatedplan

Plan relationship exists with

subject

Who care plan is for

The request body should be a valid data payload.

Working...