ActivityTiming

Represents detailed information about an activity that’s repeated in regular intervals over a period of time. This object is available in API version 52.0 and later.

Supported Calls

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

Fields

Field	Details
ActivityCountPerRepetition	Type double Properties Create, Filter, Nillable, Sort, Update Description The recommended number of times the activity should be performed in a repetition cycle.
ActivityDuration	Type double Properties Create, Filter, Nillable, Sort, Update Description The length of time that the activity should be performed during each occurrence.
ActivityDurationUnitId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unit of the length of time that the activity should be performed during each occurrence. This is a relationship field. Referenced Object UnitOfMeasure
ActivityTime	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The approximate time of day or a daily event that acts as a point of reference for when the activity should be performed. Possible values are: `Default`
ActivityTimeOffset	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of minutes before or after the reference point specified in ActivityTime when the activity should be performed.
CountInPeriod	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The recommended number of times the activity should be performed in the specified period.
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 th reecord.
MaxActivityCountPerRepetition	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum number of times the activity should be performed in a repetition cycle.
MaxActivityDuration	Type double Properties Create, Filter, Nillable, Sort, Update Description The maximum length of time that the activity should be performed during each occurrence.
MaxCountInPeriod	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum number of times the activity should be performed in the specified period.
MaxRepetitionCycleLength	Type double Properties Create, Filter, Nillable, Sort, Update Description The maximum length of each cycle of repetition.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the ActivityTiming record. This value is generated automatically.
OwnerId	Type Polymorphic reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the ActivityTiming record. Relationship Name Owner Relationship Type Lookup Referenced Object Group, User
PeriodEndDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The end date of the period during which this activity should be performed.
PeriodLength	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The length of the period during which this activity should be performed.
PeriodLengthLowerLimit	Type double Properties Create, Filter, Nillable, Sort, Update Description The lower limit of the length of the period during which this activity should be performed.
PeriodLengthUnitId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unit of the period's length. This field is used to specify the unit for PeriodLength, PeriodLengthLowerLimit, and PeriodLengthUpperLimit. Referenced Object UnitOfMeasure
PeriodLengthUpperLimit	Type double Properties Create, Filter, Nillable, Sort, Update Description The upper limit of the length of the period during which this activity should be performed.
PeriodStartDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The start date of the period during which this activity should be performed.
RepetitionCycleLength	Type double Properties Create, Filter, Nillable, Sort, Update Description The recommended length of each cycle of repetition.
RepetitionCycleUnitId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unit of the length of each cycle of repetition. Referenced Object UnitOfMeasure
SourceSystem	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the system the record came from.
SourceSystemIdentifier	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the record in its source system.
SourceSystemModified	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the record was last changed in the source system.
TimingCodeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The system-defined code that represents the timing information of an activity. This code is expected to be a complete statement of what is specified in the other fields of this object, and either this code or the data in the other fields may be used to interpret the timing of an activity. This is a relationship field. Referenced Object CodeSet
UsageType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the type of activity the timing information is used for. Possible values are: `CareObservation`—Care Observation `ClinicalServiceRequest`—Clinical Service Request `MedicationDosage`—Medication Dosage
WeeklyActivityTimeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The day and time of the week when this activity should be performed. Referenced Object OperatingHours

Usage

ActivityTiming records are referenced from MedicationDosage records to specify the timing of their activities. Here’s an example of an activity’s timing information and how an ActivityTiming record would represent that information.

Scenario: Let’s say your doctor tells you that you have to run for 10 minutes every 2 days, 30 minutes after your meals. You need to run at least 5 times in the span of those 2 days. You have to do this for 3 to 4 weeks. You’re also told that you shouldn’t run for more than 15 minutes at a time, and that you shouldn’t do it more than 7 times in 3 days. So in those 3-4 weeks, you should run somewhere between 60-84 times.

Sample Record:

Id: 1CDR00000000006OAA
OwnerId: 005R0000000dNImIAM
IsDeleted: false
Name: AT-3147
CreatedDate: 2021-04-15T10:48:14.000+0000
CreatedById: 005R0000000dNImIAM
LastModifiedDate: 2021-04-15T10:49:47.000+0000
LastModifiedById: 005R0000000dNImIAM
SystemModstamp: 2021-04-15T10:49:47.000+0000
LastViewedDate: 2021-04-15T11:14:26.000+0000
LastReferencedDate: 2021-04-15T11:14:26.000+0000
TimingCodeId: null
PeriodStartDateTime: null
PeriodEndDateTime: null
PeriodLength: null
PeriodLengthLowerLimit: 3
PeriodLengthUpperLimit: 4
PeriodLengthUnitId: 0hER0000000001VMAQ
CountInPeriod: 60
MaxCountInPeriod: 84
ActivityDuration: 10
MaxActivityDuration: 15
ActivityDurationUnitId: 0hER0000000001aMAA
ActivityCountPerRepetition: 5
MaxActivityCountPerRepetition: 7
RepetitionCycleLength: 2
MaxRepetitionCycleLength: 3
RepetitionCycleUnitId: 0hER0000000001fMAA
ActivityTime: AfterMeal
ActivityTimeOffset: 30
WeeklyActivityTimeId: 0OHR00000000HanOAE
UsageType: MedicationDosage
SourceSystem: WWHR
SourceSystemIdentifier: 763851
SourceSystemModified: 2021-04-05T23:00:00.000+0000

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.

ActivityTimingChangeEvent (API Version 62.0): Change events are available for the object.
ActivityTimingFeed: Feed tracking is available for the object.
ActivityTimingHistory: History is available for tracked fields of the object.
ActivityTimingShare: Sharing is available for the object.