Salesforce Docs Portal

CareServiceVisit

Associates a service request or a referral request (ClinicalServiceRequest) with a visit (ServiceAppointment) that’s part of that service or referral. This object is available in API version 58.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 ID of the account associated with the patient who received the care service.

    This field is a relationship field.

  • Relationship Name: Account
  • Relationship Type: Lookup
  • Refers To: Account

    This field is available in API version 59.0 and later.

AutoVerifiedVisitEndDtTm

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The end date and time of the care service visit that's automatically updated from the care giver's mobile device.

    This field is available in API version 59.0 and later.

AutoVrfyVisitEndLoc

  • Type: location
  • Properties: Nillable
  • Description: The end location of the care service visit that's automatically updated from the care giver's mobile device.

    This field is available in API version 59.0 and later.

AutoVrfyVisitStartDtTm

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The start date and time of the care service visit that's automatically updated from the care giver's mobile device.

    This field is available in API version 59.0 and later.

AutoVrfyVstStartLoc

  • Type: location
  • Properties: Nillable
  • Description: The start location of the care service visit that's automatically updated from the care giver's mobile device.

    This field is available in API version 59.0 and later.

CarePlanContextId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the care plan, care plan detail, goal assignment, or action plan associated with the care service visit.

    This field is a polymorphic relationship field.

  • Relationship Name: CarePlanContext
  • Relationship Type: Lookup
  • Refers To: ActionPlan, CarePlan, CarePlanDetail, GoalAssignment, GoalAssignmentDetail

    This field is available in API version 59.0 and later.

CareServiceVisitPlanId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the care service visit plan associated with the care service visit.

    This field is a relationship field.

  • Relationship Name: CareServiceVisitPlan
  • Relationship Type: Lookup
  • Refers To: CareServiceVisitPlan

    This field is available in API version 59.0 and later.

ClinicalServiceRequestId

  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Description: The service request that the visit is related to.
  • Relationship Name: ClinicalServiceRequest
  • Refers To: ClinicalServiceRequest

EndedById

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the care giver who ends the care service visit.

    This field is a relationship field.

  • Relationship Name: EndedBy
  • Relationship Type: Lookup
  • Refers To: ServiceResource

    This field is available in API version 59.0 and later.

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.

ManVerifiedVisitEndDtTm

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The end date and time of the care service visit that's verified and updated by a care professional from the Home Health agency.

    This field is available in API version 59.0 and later.

ManVerifiedVisitStartDtTm

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The start date and time of the care service visit that's verified and updated by a care professional from the Home Health agency.

    This field is available in API version 59.0 and later.

ManVrfyVisitEndLoc

  • Type: location
  • Properties: Nillable
  • Description: The end location of the care service visit that's verified and updated by a care professional from the Home Health agency.

    This field is available in API version 59.0 and later.

ManVrfyVisitStartLoc

  • Type: location
  • Properties: Nillable
  • Description: The start location of the care service visit that's verified and updated by a care professional from the Home Health agency.

    This field is available in API version 59.0 and later.

Name

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

OwnerId

  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: The owner of the record.
  • Relationship Name: Owner
  • Refers To:
    • Group
    • User

RelatedVisitId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the ID of a related care service visit that’s associated with a care service visit.

    This field is a relationship field.

  • Relationship Name: RelatedVisit
  • Relationship Type: Lookup
  • Refers To: CareServiceVisit

    This field is available in API version 60.0 and later.

RelatedVisitType

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Specifies the type of related visit that's associated with the care service visit.

    This field is available in API version 60.0 and later.

  • Possible values:
    • Dependent
    • None

SchedulingInputs

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: The inputs specified by the scheduler to schedule the home visits such as clinical service request, work type, and more.

ServiceRequestId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: A derived field that’s used for internal purposes.

    This field is a polymorphic relationship field.

  • Relationship Name: ServiceRequest
  • Refers To: ClinicalServiceRequest

SourceReferenceRecordId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The quote or party appointment request that's the source of the care service visit.

    This field is a polymorphic relationship field.

  • Relationship Name: SourceReferenceRecord
  • Refers To: PartyAppointmentRequest

    This field is available in API version 62.0 and later.

StartedById

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the care giver who starts the care service visit.

    This field is a relationship field.

  • Relationship Name: StartedBy
  • Relationship Type: Lookup
  • Refers To: ServiceResource

    This field is available in API version 59.0 and later.

VisitId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The visit that’s related to the service request.

    This field is a relationship field.

  • Relationship Name: Visit
  • Refers To: ServiceAppointment

VisitType

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: The type of the care service visit.

    This field is available in API version 59.0 and later.

  • Possible values:
    • Assessment
    • Recurring
    • StartOfCare

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.

CareServiceVisitChangeEvent (API version 60.0)
Change events are available for the object.
CareServiceVisitFeed
Feed tracking is available for the object.
CareServiceVisitHistory
History is available for tracked fields of the object.
CareServiceVisitShare
Sharing is available for the object.