AssessmentTask

Perform activities such as patient registration or order authorization to capture information.

Special Access Rules

In Health Cloud, this object is available in API version 46.0 and later.

Supported Calls

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

Fields

AssessmentTaskDefinitionId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The assessment task definition that is referenced for the task. This field is a relationship field.
Relationship Name: AssessmentTaskDefinition
Refers To: AssessmentTaskDefinition

AssignedToId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Represents the user that’s assigned the task. This field is a polymorphic relationship field.

In Health Cloud, this field is available in API version 58.0 and later.

Relationship Name: AssignedTo
Relationship Type: Lookup
Refers To: User

Description

Type: textarea
Properties: Create, Filter, Nillable, Sort, Update
Description: Description of task that has to be performed at the store.

EndTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date and time when the assessment task is completed.

IsRequired

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicate whether a task must be completed to complete a visit.

In Health Cloud, this field is available in API version 48.0 and later.

Default value: False

LastReferencedDate

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

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The most recent date on which a user viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: Unique identification of the task.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The ID of the user who owns this assessment template. This field is a polymorphic relationship field.
Relationship Name: Owner
Refers To: Group, User

ParentId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The visit associated with an assessment task. This field is a relationship field.

In Health Cloud, this field is available in API version 48.0 and later.

Relationship Name: Parent
Refers To: Visit

ReferenceRecordId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Represents the record with which the associated task is related. This field is a polymorphic relationship field.

In Health Cloud, this field is available in API version 58.0 and later.

Relationship Name: ReferenceRecord
Relationship Type: Lookup
Refers To: CarePgmEnrolleeWkOrdStep, ActionPlan, PrvdEngmtComplianceCycle

Based on the availability of objects in your org.

SequenceNumber

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The sequence in which the tasks must be performed.

In Health Cloud, this field is available in API version 48.0 and later.

StartTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: Time when the task was started by a field rep.

Status

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description: View the status of a task.

In Health Cloud, this field is available in API version 48.0 and later.

Default value: Not Started
Possible values:
- Completed
- InProgress—In Progress
- NotStarted—Not Started
- Skipped

TaskType

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort
Description: Type of a task that the sales rep can perform during the visit.
Possible values:
ConductInStoreSurveys
InventoryCheck
Other
PlaceOrder
PlanogramCheck
PromotionCheck

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.