ProviderVisit

Represents the details of a field user's visit to a health care provider. For example, a sales representative visiting a health care provider to discuss product usage and efficacy to enhance adoption. This object is available in API version 65.0 and later.

Supported Calls

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

Fields

Field	Details
AccountId	Type reference Properties Filter, Group, Nillable, Sort Description The account associated with the provider visit. Derived from the related visit (Visit object). This field is a relationship field. Relationship Name Account Refers To Account
AdditionalInformation	Type textarea Properties Create, Nillable, Update Description Information captured on signature capture or provider visit submission for auditability including account name.
BookingStatus	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The booking status of the provider visit. Possible values are: `Accepted` `Proposed` `Rejected` `Retrieved`
BookingStatusReason	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the reason for a rejection of the provider visit.
Channel	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the channel type for the provider visit. Derived from the related visit (Visit object).
ComplianceStatements	Type textarea Properties Create, Nillable, Update Description Compliance statements displayed to the field user.
GeoLocOnSubmit	Type location Properties Nillable Description The GPS location captured upon the provider visit submission.
GeoLocOnSubmitLatitude	Type double Properties Create, Filter, Nillable, Sort, Update Description The GPS latitude captured upon the provider visit submission.
GeoLocOnSubmitLongitude	Type double Properties Create, Filter, Nillable, Sort, Update Description The GPS longitude captured upon the provider visit submission.
HasAttachments	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description On submission, indicates if the provider visit has attachments. The default value is `false`.
InvitationEmailAddress	Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address used to send an invitation for a remote visit.
InvitationEmailBouncedRsn	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Reason for a bounced email invitation for a remote visit.
InvitationEmailStatus	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Shows the status of an attendee’s email invitation for a remote visit. Possible values are: `Accepted` `Bounced` `Declined` `Pending` `Sent` `Tentative`
IsAdhocProviderVisit	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the provider visit was initiated spontaneously, without prior scheduling. The default value is `false`.
IsBackdatedSbmtVldSkipped	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether the backdated validation is skipped on provider visit submission. The default value is `false`.
IsBackdatedSgnVldSkipped	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether the backdated validation is skipped. The default value is `false`.
IsConfirmed	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a confirmation is received from the provider for the scheduled date and time of the planned visit. The default value is `false`.
IsOfflineModeSignature	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates that the provider visit is signed offline and online validation isn't applied to this visit. The default value is `false`.
IsOfflineModeSubmit	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates that provider visit is submitted offline and online validation isn't applied to this visit. The default value is `false`.
IsRecordOwner	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the user is the owner of the provider visit record. The default value is `false`. This field is a calculated field.
IsSignedAwayFrmAllowDstn	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates that the provider visit is signed outside the allowed distance. The default value is `false`.
IsSubmitAwayFrmAllowDstn	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates that the provider visit is submitted outside the allowed distance. The default value is `false`.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.
LifeScienceAccountListId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account list that's associated with the provider visit. This field is a relationship field. Relationship Name LifeScienceAccountList Refers To LifeScienceAccountList
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the provider visit.
NextProviderVisitObjective	Type textarea Properties Create, Filter, Nillable, Sort, Update Description Next visit objective for the provider.
NextPrvdVisitObjectiveType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Next visit objective type for the provider.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the owner or creator of this object. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User
PhysicalFormIdentifier	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The identifier of the physical form signed instead of an electronic signature.
PlannedEndTime	Type dateTime Properties Filter, Nillable, Sort Description The planned end date and time for the provider visit. Derived from the related visit (Visit object).
PlannedStartTime	Type dateTime Properties Filter, Nillable, Sort Description The planned start date and time for the provider visit. Derived from the related visit (Visit object).
PreProviderVisitNotes	Type textarea Properties Create, Nillable, Update Description The notes derived from the next provider visit objectives of the previous provider visit submitted on the account by the user.
ProvVisitDlvrSampleCount	Type double Properties Create, Filter, Nillable, Sort, Update Description The record count of delivered samples linked to the provider visit. Derived from the related visit (Visit object).
ProvVisitMktItemCount	Type double Properties Create, Filter, Nillable, Sort, Update Description The record count of marketing items linked to the provider visit. Derived from the related visit (Visit object).
ProvVisitProdDtlCount	Type double Properties Create, Filter, Nillable, Sort, Update Description The record count of detailing products linked to the provider visit. Derived from the related visit (Visit object).
ProvVisitReqSampleCount	Type double Properties Create, Filter, Nillable, Sort, Update Description The record count of requested samples linked to the provider visit. Derived from the related visit (Visit object).
RemoteAttendanceStatus	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether an attendee joined the remote call or missed it. Possible values are: `Attended` `NoShow`
RemoteChannelServiceProvider	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The service provider for the remote session. Possible values are: `MsTeams` `Twilio`
RemoteSessionStatus	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether the remote session was created successfully. Possible values are: `AddAttendeeFailed` `CreateFailed` `Pending` `Ready` `RemoveAttendeeFailed` `Retry` `UpdateAccountFailed` `UpdateChannelFailed` `UpdateDateTimeFailed`
RemoteSessionStatusReason	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The reason that remote session creation failed. Possible values are: `Unauthorized`
ShippingAddressId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The shipping address of the requested samples for the provider visit. This field is a relationship field. Relationship Name ShippingAddress Refers To ContactPointAddress
SourceSystemIdentifier	Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description An external ID from the source system for data integrations.
SourceSystemName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the source system for data integrations.
Status	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The status of the provider visit. Derived from the related visit (Visit object). Possible values are: `Abandoned` `Completed` `Error` `InProgress` `None` `Planned` `Unscheduled` The default value is `Planned`.
SubmitDelayReason	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The reason for a delay in submitting the provider visit.
SubmitDelayReasonType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The reason type for a delay in submitting the provider visit.
SubmitGeolcMissingReason	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Reason populated when GPS is not captured upon the provider visit submission. Possible values are: `BadData` `DeviceRestricted` `Offline` `UserRestricted`
SubmitGeolocationTimestamp	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date and time when GPS is captured upon the provider visit submission.
TerritoryId	Type reference Properties Filter, Group, Nillable, Sort Description The associated territory record. Derived from the related visit (Visit object). This field is a relationship field. Relationship Name Territory Refers To Territory2
TerritoryName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the territory associated with the provider visit.
VisitId	Type reference Properties Create, Filter, Group, Sort Description Required. The associated visit record. This field is unique within your organization. This field is a relationship field. Relationship Name Visit Relationship Type Master-detail Refers To Visit (the master object)
VisitSubmitDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the provider visit is submitted.

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.

ProviderVisitChangeEvent: Change events are available for the object.
ProviderVisitFeed: Feed tracking is available for the object.
ProviderVisitHistory: History is available for tracked fields of the object.

Life Sciences Cloud Developer Guide

ProviderVisit

Supported Calls

Fields

Associated Objects