VisitWorkType Class

Represents a work type configuration for recurring home visits.

Namespace 

healthcloudext

VisitWorkType Properties 

The following are properties for VisitWorkType.

  • additionalVisitInstructions

    Additional instructions attached to the visit for this work type.

  • alreadyScheduledDurationMinutes

    Total minutes of existing, non-canceled service appointments already scheduled for this work type under the clinical service request. The value is 0 when no clinical service request ID is provided. This property is output only.

  • duration

    Duration of each appointment, in minutes. This value overrides the work type’s default service appointment duration.

  • preferredResources

    IDs of the service resources preferred when scheduling this work type.

  • requiredResources

    IDs of the service resources required to schedule this work type.

  • skillIds

    IDs of the skills required for visits of this work type. Skills associated with the work type are removed before these IDs are used.

  • totalDurationMinutes

    Total duration, in minutes, of scheduled and already scheduled time for this work type. This property is output only.

  • workPlanTemplateIds

    IDs of the work plan templates used to create work plans on the work order for this work type.

  • workTypeId

    ID of the work type that this configuration applies to.

additionalVisitInstructions 

Additional instructions attached to the visit for this work type.

Signature 

@AuraEnabled global List<String> additionalVisitInstructions {get; set;}

Property Value 

Type: List<String>

alreadyScheduledDurationMinutes 

Total minutes of existing, non-canceled service appointments already scheduled for this work type under the clinical service request. The value is 0 when no clinical service request ID is provided. This property is output only.

Signature 

@AuraEnabled global Integer alreadyScheduledDurationMinutes {get; set;}

Property Value 

Type: Integer

duration 

Duration of each appointment, in minutes. This value overrides the work type’s default service appointment duration.

Signature 

@AuraEnabled global Integer duration {get; set;}

Property Value 

Type: Integer

preferredResources 

IDs of the service resources preferred when scheduling this work type.

Signature 

@AuraEnabled global List<String> preferredResources {get; set;}

Property Value 

Type: List<String>

requiredResources 

IDs of the service resources required to schedule this work type.

Signature 

@AuraEnabled global List<String> requiredResources {get; set;}

Property Value 

Type: List<String>

skillIds 

IDs of the skills required for visits of this work type. Skills associated with the work type are removed before these IDs are used.

Signature 

@AuraEnabled global List<String> skillIds {get; set;}

Property Value 

Type: List<String>

totalDurationMinutes 

Total duration, in minutes, of scheduled and already scheduled time for this work type. This property is output only.

Signature 

@AuraEnabled global Integer totalDurationMinutes {get; set;}

Property Value 

Type: Integer

workPlanTemplateIds 

IDs of the work plan templates used to create work plans on the work order for this work type.

Signature 

@AuraEnabled global List<String> workPlanTemplateIds {get; set;}

Property Value 

Type: List<String>

workTypeId 

ID of the work type that this configuration applies to.

Signature 

@AuraEnabled global String workTypeId {get; set;}

Property Value 

Type: String