CarePlanActivity

Represents a planned action that’s part of a care plan. For example, knowledge campaigns, physiotherapy appointments, medication regimens, etc. This object is a child object 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: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system-defined code that represents an activity.

You can either specify your care plan activity using a generic code with the ActivityCodeId field, or you use the ReferenceRecordId field to reference a record in your system that represents the specific instance of the activity.
Tip

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

ActivityTimingId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The schedule prescribed for the activity. You can use use an ActivityTiming record to specifiy how long and how often the activy has to be repeated.

This field is a relationship field.

You use the ActivityTimingId field if you want to represent the activity’s schedule as a timing value, the ScheduleDescription field if you want to use a text value, and the ScheduledPeriodStartDateTime and ScheduledPeriodEndDateTime fields if you want to use a period value. You can pick any one of these data types, but you can’t use more than one in the same record.
Note
Relationship Name: ActivityTiming
Relationship Type: Lookup
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: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system-defined code that represents the product that’s administered as part of the activity.

You can’t use both the AdministeredProductCodeId and AdministeredProductId fields together in the same record.
Note

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

AdministeredProductId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the product in that’s administered as part of the activity.

You can’t use both the AdministeredProductCodeId and AdministeredProductId fields together in the same record.
Note

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

CarePlanId

Type: reference
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: Master-Detail
Refers To: CarePlan

DailyDoseQuantity

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The quantity of product that’s administered or consumed each day as part of the activity.

DailyDoseUnitId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unit of the values specified in DailyDoseQuantity.

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

Description

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The description of 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: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The place where the activity is intended to happen. This could be provider facility, the patient’s home, etc.

This field is a polymorphic relationship field.
Relationship Name: Location
Relationship Type: Lookup
Refers To: HealthcareFacility, Location

Name

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

OwnerId

Type: Polymorphic lookup
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The owner of the record. Available in API version 57.0.
Relationship Name: Owner
Relationship Type: Lookup
Refers To:
- Group
- User

ProhibitedActivity

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Indicates whether the activity described in the record is prescribed as something that the patient should avoid doing. Use the Default value if you’d rather not specify this as true or false.
Possible values:
- Default
- False
- True

ReferenceRecordId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The activity that’s prescribed as part of the care plan.

You can either specify your care plan activity using a generic code with the ActivityCodeId field, or you use the ReferenceRecordId field to reference a record in your system that represents the specific instance of the activity.
Tip

This field is a polymorphic relationship field.
Relationship Name: ReferenceRecord
Relationship Type: Lookup
Refers To: ClinicalServiceRequest, MedicationRequest, MedicationStatement

ScheduleDescription

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The schedule for when the activty is intended to be performed.

You use the ActivityTimingId field if you want to represent the activity’s schedule as a timing value, the ScheduleDescription field if you want to use a text value, and the ScheduledPeriodStartDateTime and ScheduledPeriodEndDateTime fields if you want to use a period value. You can pick any one of these data types, but you can’t use more than one in the same record.
Note

ScheduledPeriodEndDateTime

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

You use the ActivityTimingId field if you want to represent the activity’s schedule as a timing value, the ScheduleDescription field if you want to use a text value, and the ScheduledPeriodStartDateTime and ScheduledPeriodEndDateTime fields if you want to use a period value. You can pick any one of these data types, but you can’t use more than one in the same record.
Note

ScheduledPeriodStartDateTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date and time when the activity’s prescribed time period starts.

You use the ActivityTimingId field if you want to represent the activity’s schedule as a timing value, the ScheduleDescription field if you want to use a text value, and the ScheduledPeriodStartDateTime and ScheduledPeriodEndDateTime fields if you want to use a period value. You can pick any one of these data types, but you can’t use more than one in the same record.
Note

Status

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

StatusReasonCodeId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system-defined code that represents the reason for why the value specified in Status is valid.

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 product that’s supplied, administered, or consumed as part of the activity during the course of the care plan.

SuppliedQuantityUnitId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unit of the value specified in SuppliedQuantity.

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 (API version 57.0): Sharing rules are available for the object.
CarePlanActivityShare (API version 57.0): Sharing is available for the object.