CarePlan

Represents a care plan that is created to help improve a patient or member’s health. This object is based on the CarePlan FHIR resource. 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()

Special Access Rules

Fields

Field	Details
AuthorId	Type Polymorphic lookup Properties Create, Filter, Group, Nillable, Sort, Update Description The author of the care plan. Relationship Name Author Relationship Type Lookup Refers To Account CareRegisteredDevice HealthcarePractitionerFacility HealthcareProvider
AuthorizationType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of authorization provided for the care plan. Possible values are: `Option` `Order` `Plan` `Proposal`
CarePlanTemplateId	Type Lookup Properties Create, Filter, Group, Nillable, Sort, Update Description The care plan template from which the care plan was instantiated. Relationship Name CarePlanTemplate Refers To CarePlanTemplate
CaseId	Type Master-detail Properties Create, Filter, Group, Sort, Update Description The parent case record that the care plan is associated to. This field is a relationship field. Relationship Name Case Refers To Case
ClinicalEncounterId	Type Lookup Properties Create, Filter, Group, Nillable, Sort, Update Description The encounter during which the care plan was created. Relationship Name ClinicalEncounter Refers To ClinicalEncounter
Description	Type textarea Properties Create, Nillable, Update Description The description of the care plan.
EndDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the care plan ends.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The date and time when the record was last referenced.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The date and time when the record was last viewed.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the record.
ParticipantId	Type Polymorphic lookup Properties Create, Filter, Group, Sort, Update Description The patient or member that the care plan is created for. This field is a polymorphic relationship field. Relationship Name Participant Relationship Type Lookup Refers To Account, Contact
RecordedDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the care plan was first recorded.
StartDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the care plan begins.
Status	Type picklist Properties Create, Filter, Group, Sort, Update Description The status of the care plan. Possible values are: `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 are: `Completed` `Failed` `InProgress`—In Progress `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.

Salesforce Health Cloud Developer Guide

CarePlan

Supported Calls

Special Access Rules

Fields

Associated Objects