CarePlan

Stores information about a care plan associated with a medication therapy review. Care plans are used to assign tasks to patients as part of medication therapy reviews. This object is available in API version 56.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

CarePlanTemplateId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The care plan template associated with the care plan.

    This field is a relationship field.

  • Relationship Name: CarePlanTemplate
  • Relationship Type: Lookup
  • Refers To: CarePlanTemplate

CaseId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The case associated with the care plan.

    This field is a relationship field.

  • Relationship Name: Case
  • Relationship Type: Master-Detail
  • Refers To: Case

Description

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: A description of the care plan.

EndDate

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date until when the care plan is effective.

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The most recent date on which a user referenced the record.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The most recent date on which a user viewed the record.

MedicationTherapyReviewId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The medication therapy review that's associated with this care plan.

    This field is a relationship field.

  • Relationship Name: MedicationTherapyReview
  • Relationship Type: Lookup
  • Refers To: MedicationTherapyReview

Name

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The unique name of the care plan.

ParticipantId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The account associated with the care plan.

    This field is a polymorphic relationship field.

  • Relationship Name: Participant
  • Relationship Type: Lookup
  • Refers To: Account, Contact

StartDate

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date from when the care plan is effective.

Status

  • Type: picklist
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The status of the care plan.
  • Possible values:
    • Active
    • Cancelled
    • Completed
    • Draft
    • Proposed

TaskJobStatus

  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Description: The job status of tasks associated with the care plan. This field is currently not used.
  • Possible values:
    • Completed
    • Failed
    • InProgress
    • Submitted

TaskJobStatusMessage

  • Type: textarea
  • Properties: Nillable
  • Description: The job status message of tasks associated with the care plan. This field is currently not used.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

CarePlanFeed
Feed tracking is available for the object.
CarePlanHistory
History is available for tracked fields of the object.