AppointmentID

Number (Integer)

Check the below image

This is the unique identifier of the appointment. If the appointment is part of a series, all occurrences within that series will have the same ID until they are verified. Once verified, they will get their unique ID and the series ID will be updated from null to the series ID

AppointmentGroupID

Number

Group ID always shows the series ID of the appointment

SeriesID

Number

is null until the appointment occurrence is created

AppointmentDate

Date

Scheduled date of the appointment

AppointmentWeekDay

String

Scheduled day of the appointment (e.g., Monday, Tuesday, etc.)

AppointmentType

String

A field showing whether the appointment is:

• BIllable

• Non-Billable

• Travel

AppointmentStartDate

Date

AppointmentStartTime

String

Scheduled start time of the appointment (e.g., 10:00 AM, 11:35 AM, etc.)

AppointmentEndTime

String

Scheduled end time of the appointment (e.g., 10:00 AM, 11:35 AM, etc.)

ActualStartTime

String

Actual start time of the appointment (e.g., 10:00 AM, 11:35 AM, etc.)

ActualEndTime

String

Actual end time of the appointment (e.g., 10:00 AM, 11:35 AM, etc.)

DurationMin

Number

Length of the scheduled appointment, in minutes.

ActualDurationMin

Number

Verified actual length of the appointment, in minutes.

DurationHours

String

A text presentation of the length of the scheduled appointment, in hours and minutes (e.g., “1 Hour 30 Min”)

ActualDurationHours

String

A text presentation of the actual verified length of the appointment, in hours and minutes (e.g., “1 Hour 30 Min”)

AppointmentTag

String

The tag assigned to the appointment

ServiceLine

String

Service Line of the appointment. This is passed from the client authorization

Service

String

Name of the service on the appointment.

ServiceID

Number

[Service ID number]

BillingCodeID

Number

Foreign Key to the client authorization table. Used along with the clientAuthorizationID to link the appointment to the proper authorization to get the authorization details

DiagnosisID

Number

[Diagnosis ID number]

DiagnosisCode

String

The ICD10 diagnosis code attached to the appointment. This is passed from the client authorization.

DiagnosisDescription

String

ICD10 diagnosis description

AppointmentLocation

String

Refers to the drop down on the appointment screen indicating whether the appointment is at the client home, staff home, or certain facility

PlaceOfService

String

Standard Place of Service for the claim. This refers to the drop-down on the appointment screen (e.g., 11-Office, 12-Home, etc.)

StaffID

Number

This is the ID number of the staff member scheduled for the appointment. This is used to link the appointment with staff table to retrieve information about the staff member

Modifier1

String

A text string for modifier 1 based on the funder service setup

Modifier2

String

A text string for modifier 2 based on the funder service setup

AuthorizationNumber

String

This refers to the authorization number linked to the appointment

CancellationNote

String

If the appointment is canceled, there is an option to add a cancelation note. This field refers to this note

CancellationType

String

Indicates whether the cancelation is staff or client cancellation

CancellationTypeID

Number

Back-end ID of Cancellation Type

1 - Staff Member
2 - Client

ClientVerification

String

[Indicates “Yes” if the client verified the appointment, “No” otherwise]

ClientVerificationDate

Datetime

Datetime when the parent/guardian verified the appointment. Displays “null” if not verified

ClientAuthorizationID

Number

Used to link to the appointment table with the client authorization table to retrieve information about the authorization

ClientID

Number

ID number of the staff client scheduled for the appointment. This is used to link the appointment with client table to retrieve information about the client.

Copay

Float

Refers to on-screen field allowing users to enter a copayment amount entered on the appointment level.

CopaymentReferenceNumber

String

Refers to on-screen field allowing users to enter a reference number for the copayment amount entered on the appointment level

DateLastModified

Datetime

Date when the appointment was last modified

DeletedDate

Datetime

Date when the appointment was deleted

ActualDurationMin

Number

Actual Duration of the Appointment in minutes

[THIS IS A DUPLICATE]

BaseRate

Number

The base rate at which the service is defined for the company account

Company Account → Service Lines → Services → Base Rate

ContractRate

Number

The contract rate at which the service is defined for the associated funder in company account

Company Account → Funder → PICK FUNDER → Service Lines → Billing Code

CopaymentAmountCollected

Number

Refers to on-screen field in Appointment > Enter a copayment > Amount collected:*

DurationMin

Scheduled duration of appointment in minutes

[THIS IS A DUPLICATE]

MileageCalculated

Number

For travel appointments, this is the mileage calculated based on the distance between the origin and destination

MileageCost

Number

The cost calculated for the travel appointment based on the company account setting for mileage cost

MileageCostTotal

[NEED DESCRIPTION - WHAT IS DIFFERENCE BETWEEN THIS AND MILEAGE COST?]

NumberOfUnits

Number

Total number of units of service delivered based on the duration of the appointment and the unit type. For example, if the appointment is 1 hour and the unit type of the service scheduled is “15 min”, the number of units will be 4.

SeriesRecurrenceFrequency

Refers to the recurrence pattern selected if an appointment is part of a series

PayType

String

Indicates if the Staff Member assigned to the appointment has an Hourly or Salary Pay Type

StaffPayHourly

Number

The scheduling provider total pay based on the selected pay code on the appointment.

This is calculated based on the duration of the appointment multiplied by the pay rate

StaffPaySalary

Number

If the scheduled staff is a salaries employee, the StaffPayHourly will be 0 and this field will show the salary defined for the employee per pay period

TotalCharges

Number

The total charges calculated for the appointment according to:

• Duration

• Rate for the funder

• Credential

UnitRate

Number

The unit rate at which the appointment is calculated