PartyAppointmentRequest

AdditionalNotes

• Type: textarea
• Properties: Create, Nillable, Update
• Description: The additional notes such as comments from the party or the recurrence pattern of appointments associated with the appointment request.

  This field is available in API version 63.0 and later.

AppointmentRecurrencePattern

• Type: textarea
• Properties: Create, Nillable, Update
• Description: The recurrence pattern of the appointment that's associated with the appointment request.

  This field is available in API version 62.0 and later.

AppointmentReferenceId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: References to an existing appointment that's associated with either a Reschedule or Cancel appointment request.

  This field is a polymorphic relationship field.

• Relationship Name: AppointmentReference
• Relationship Type: Lookup
• Refers To: ServiceAppointment

AppointmentType

• Type: picklist
• Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
• Description: Specifies the type of appointment that's associated with the appointment request.

  This field is available in API version 62.0 and later.

• Default value: StartOfCare
• Possible values:
  • Recurring
  • StartOfCare

ClinicalServiceRequestId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The clinical service request that's associated with the appointment request.

  This field is a relationship field.

• Relationship Name: ClinicalServiceRequest
• Refers To: ClinicalServiceRequest

  This field is available in API version 62.0 and later.

EndDateTime

• Type: dateTime
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The end date of the requested appointment.

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.

OperatingHoursId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The operating hours of the appointment that's associated with the appointment request.

  This field is a relationship field.

• Relationship Name: OperatingHours
• Refers To: OperatingHours

  This field is available in API version 62.0 and later.

OwnerId

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

  This field is a polymorphic relationship field.

• Relationship Name: Owner
• Relationship Type: Lookup
• Refers To: Group, User

PartyId

• Type: reference
• Properties: Create, Filter, Group, Sort, Update
• Description: The ID of the patient for whom the appointment request is created.

  This field is a polymorphic relationship field.

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

QuoteId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The quote that's associated with the appointment request.

  This field is a relationship field.

• Relationship Name: Quote
• Refers To: Quote

  This field is available in API version 62.0 and later.

RecurringAppointmentCount

• Type: int
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The count of recurring appointments associated with the appointment request.

  This field is available in API version 63.0 and later.

RelatedRequestId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The related appointment request for a dependent home visit.

  This field is a relationship field.

• Relationship Name: RelatedRequest
• Refers To: PartyAppointmentRequest

  This field is available in API version 62.0 and later.

RequestType

• Type: picklist
• Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
• Description: Specifies the type of appointment request.
• Default value: Schedule
• Possible values:
  • Cancel
  • Reschedule
  • Schedule

RequestedById

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Specifies the user who raised the appointment request on behalf of another user.

  This field is a polymorphic relationship field.

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

ServiceContextId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Specifies the service of the requested appointment.

  This field is a polymorphic relationship field.

• Relationship Name: ServiceContext
• Relationship Type: Lookup
• Refers To: WorkType

ServiceLocation

• Type: address
• Properties: Filter, Nillable
• Description: Specifies the service location of the requested appointment.

ServiceTerritoryId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The service territory of the appointment that's associated with the appointment request.

  This field is a relationship field.

• Relationship Name: ServiceTerritory
• Refers To: ServiceTerritory

  This field is available in API version 62.0 and later.

SourceReferenceRecordId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The referral or opportunity that's the source of the appointment request.

  This field is a polymorphic relationship field.

• Relationship Name: SourceReferenceRecord
• Refers To: Opportunity

  This field is available in API version 62.0 and later.

StartDateTime

• Type: dateTime
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The start date of the requested appointment.

Status

• Type: picklist
• Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
• Description: Specifies the status of the appointment request.
• Default value: Submitted
• Possible values:
  • Approved
  • Rejected
  • Submitted

StatusReason

• Type: textarea
• Properties: Create, Nillable, Update
• Description: The reason for the appointment request.

StatusReasonType

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Specifies the reason type for the status of the appointment request.

UsageType

• Type: picklist
• Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
• Description: Specifies the feature that the created record is applicable for.
• Default value: HomeHealth
• Possible values:
  • HomeHealth

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.

PartyAppointmentRequestFeed

Feed tracking is available for the object.

PartyAppointmentRequestHistory

History is available for tracked fields of the object.

PartyAppointmentRequestShare

Sharing is available for the object.