Newer Version Available

This content describes an older version of this product. View Latest

CareServiceVisitPlan

Associates a service request with the series of visits that are planned as part of that visit. The series of visits is represented using MaintenancePlan. 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

Field Details
ApprovedVisitCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of approved visits in the planned care service.
This field is available in API version 59.0 and later.
AssignedVisitCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of visits assigned with resources in a planned service.
AuthorizationReferenceId
Type
Lookup
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The care request item that’s the record of authorization for the visit.
Relationship Name
AuthorizationReference
Refers To
CareRequestItem
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.
ClinicalServiceRequestId
Type
Lookup
Properties
Filter, Group, Nillable, Sort
Description
The request for the service.
Relationship Name
ClinicalServiceRequest
Refers To
ClinicalServiceRequest
CompletedVisitCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of visits that have been completed as part of the service.
CreatedVisitCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of created visits in the planned care service.
This field is available in API version 59.0 and later.
IsServiceAuthorizationRequired
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the service has to be authorized before it’s provided.
The default value is false.
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.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the record.
OwnerId
Type
Polymorphic lookup
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The owner of the record.
Relationship Name
Owner
Refers To
  • Group
  • User
ServiceRequestId
Type
Lookup
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The service request for the service.
Relationship Name
ServiceRequest
Refers To
ClinicalServiceRequest
UnassignedVisitCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of unassigned visits in a planned service.
VisitPlanId
Type
Lookup
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The series of visits planned for a service.
Relationship Name
VisitPlan
Refers To
MaintenancePlan

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.

CareServiceVisitPlanFeed
Feed tracking is available for the object.
CareServiceVisitPlanHistory
History is available for tracked fields of the object.
CareServiceVisitPlanShare
Sharing is available for the object.