CarePlanActivity

Represents an activity that’s part of a care plan. This object is a child of CarePlan. 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

ActivityCodeId

Type: Polymorphic lookup
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system-defined code that represents an standardized activity in a care plan.
Relationship Name: ActivityCode
Relationship Type: Lookup
Refers To:
- CodeSet
- CodeSetBundle

ActivityTimingId

Type: Lookup
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Represent schedule following which the activity is meant to be performed. This information includes period during which the activity recurs and the frequency with which it recurs during that period.
Relationship Name: ActivityTiming
Refers To: ActivityTiming

ActivityType

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the type of the activity.
Possible values:
- Appointment
- Communication Request
- Device Request
- Medication Request
- Medication Statement
- Nutrition Order
- Service Request
- Task
- Vision Prescription

AdministeredProductCodeId

Type: Lookup
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system-defined code that represents the product administered as part of the activity.

This field is a polymorphic relationship field.
Relationship Name: AdministeredProductCode
Relationship Type: Lookup
Refers To: CodeSet, CodeSetBundle

AdministeredProductId

Type: Lookup
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The medication that’s administered as part of the activity.
Relationship Name: AdministeredProduct
Refers To: Medication

CarePlanId

Type: Master-detail
Properties: Create, Filter, Group, Sort
Description: The parent care plan that the activity is a part of.

This field is a relationship field.
Relationship Name: CarePlan
Relationship Type: Lookup
Refers To: CarePlan

DailyDoseQuantity

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The amount of medication administered daily as part of the activity.

DailyDoseUnitId

Type: Lookup
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unit for DailyDoseQuantity
Relationship Name: DailyDoseUnit
Relationship Type: Lookup
Refers To: UnitOfMeasure

Description

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The description for the activity.

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.

LocationId

Type: Polymorphic Lookup
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The location where the activity was performed. This could be a healthcare facility, or even the patient or member’s home.
Relationship Name: Location
Relationship Type: Lookup
Refers To:
- HealthcareFacility
- Location

Name

Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: The name of the record.

OwnerId

Type: Lookup
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The owner of the record.

This field is a polymorphic relationship field.
Relationship Name: Owner
Relationship Type: Lookup
Refers To: Group, User

ProhibitedActivity

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Indicates whether the recorded activity is a prohibited activity. For instance, creating a CarePlanActivity record for Smoking and setting the ProhibitedActivity field to true to indicate that smoking is prohibited in the care plan.
Possible values:
- Default
- False
- True

ReferenceRecordId

Type: Polymorphic Lookup
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: References a clinical record that represents the activity. For instance, a medication statement to represent an activity that administers medication as part of the care plan.
Relationship Name: LookupRecord
Refers To:
- ClinicalServiceRequest
- MedicationRequest
- MedicationStatement

ReferenceTaskId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: References a task record that represents the activity.
Relationship Name: ReferenceTask
Relationship Type: Lookup
Refers To: Task

ScheduleDescription

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The schedule for the activity represent as plain text.

ScheduledPeriodEndDateTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The scheduled date and time when the activity ends.

ScheduledPeriodStartDateTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The scheduled date and time when the activity begins.

Status

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The status of the activity.
Possible values:
- Cancelled
- Completed
- Entered-In-Error
- In Progress
- Not Started
- On Hold
- Scheduled
- Stopped
- Unknown

StatusReasonCodeId

Type: Polymorphic Lookup
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system-defined code that represents the reason for the activity’s status.

This field is a polymorphic relationship field.
Relationship Name: StatusReasonCode
Relationship Type: Lookup
Refers To:
- CodeSet
- CodeSetBundle

SuppliedQuantity

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total quantity of medication that is meant to be administered as part of the activity during the course of its full period.

SuppliedQuantityUnitId

Type: Lookup
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unit for SuppliedQuantityUnitId.

This field is a relationship field.
Relationship Name: SuppliedQuantityUnit
Relationship Type: Lookup
Refers To: UnitOfMeasure

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.

CarePlanActivityFeed: Feed tracking is available for the object.
CarePlanActivityHistory: History is available for tracked fields of the object.
CarePlanActivityOwnerSharingRule: Sharing rules are available for the object.
CarePlanActivityShare: Sharing is available for the object.