Salesforce Docs Portal

Visit

Track information related to a field rep’s visit to a health care provider.

Special Access Rules

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

Supported Calls

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

Fields

AccountId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The account that is associated with a visit.

    In Health Cloud, this field is available in the Account Management feature.

  • Relationship Name: Account
  • Refers To: Account

ActualVisitEndTime

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time when the visit ended.

ActualVisitStartTime

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time when the visit started.

InstructionDescription

  • Type: textarea
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Special instructions provided by a sales manager or an admin that a sales rep refers to during a visit.

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.

Name

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: Unique identifier for the visit record.

OwnerId

  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: ID of the visit record owner.

PlaceId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: ID of the location that sales reps visit.

    In Health Cloud, this field is available in the Account Management feature.

  • Relationship Name: Place
  • Refers To: Address, ContactPointAddress, Location, RetailStore

PlannedVisitEndTime

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time when the visit is expected to end.

PlannedVisitStartTime

  • Type: dateTime
  • Properties: Create, Filter, Sort, Update
  • Description: The date and time when the visit is expected to start.

    In Health Cloud, this field is available in the Account Management feature.

Start Geolocation Missing Reason

  • Type: staticenum
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The reason why geolocation was not captured at the start of the visit. Possible values:
    • Device Restricted
    • User Restricted
    • Offline
    • Bad Conectivity

Status

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
  • Description: The status of a visit.

    In Health Cloud, this field is available in the Account Management feature.

  • Default value: Planned
  • Possible values:
    • Abandoned
    • Completed
    • InProgress
    • Planned

StatusRemarks

  • Type: textarea
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The reasons for abandoning or completing the visit as provided by the sales rep.

VisitPriority

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The priority of the visit.
  • Possible values:
    • High
    • Low
    • Medium

VisitorId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: ID of the sales representative visiting the store.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.