ScheduledVisit

data class ScheduledVisit(address: Address, appointmentDetails: ScheduledVisit.AppointmentDetails, departmentId: String, ehrSystemName: String, id: String, isNewPatient: Boolean, isReadyForVisit: Boolean, patientEmail: String?, patientGuid: String, patientPhone: String?, status: ScheduledVisitStatus, timestamps: ScheduledVisit.Timestamps, type: ScheduledVisitType, retailDepartment: RetailDepartment?) : Parcelable
Content copied to clipboard

Contains details about an upcoming scheduled visit.

See also

Constructors

ScheduledVisit
Link copied to clipboard
fun ScheduledVisit(address: Address, appointmentDetails: ScheduledVisit.AppointmentDetails, departmentId: String, ehrSystemName: String, id: String, isNewPatient: Boolean, isReadyForVisit: Boolean, patientEmail: String? = null, patientGuid: String, patientPhone: String? = null, status: ScheduledVisitStatus, timestamps: ScheduledVisit.Timestamps, type: ScheduledVisitType, retailDepartment: RetailDepartment? = null)
Content copied to clipboard

Types

AppointmentDetails
Link copied to clipboard
data class AppointmentDetails(appointmentId: String, endDateTime: ZonedDateTime, slotId: String, startDateTime: ZonedDateTime, timezone: ZoneId) : Parcelable
Content copied to clipboard
Contains details about a specific ScheduledVisit appointment.
Timestamps
Link copied to clipboard
data class Timestamps(cancelled: ZonedDateTime?, done: ZonedDateTime?, requested: ZonedDateTime?, staffdeclined: ZonedDateTime?) : Parcelable
Content copied to clipboard
Contains various times at which a ScheduledVisit's status was updated

Functions

describeContents
Link copied to clipboard
abstract fun describeContents(): Int
Content copied to clipboard
writeToParcel
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)
Content copied to clipboard

Properties

address
Link copied to clipboard
val address: Address
Content copied to clipboard
The patient's address
appointmentDetails
Link copied to clipboard
val appointmentDetails: ScheduledVisit.AppointmentDetails
Content copied to clipboard
An object containing additional details about the appointment
departmentId
Link copied to clipboard
val departmentId: String
Content copied to clipboard
The ID of the department where the visit is scheduled
departmentIdentifier
Link copied to clipboard
val departmentIdentifier: String
Content copied to clipboard
ehrSystemName
Link copied to clipboard
val ehrSystemName: String
Content copied to clipboard
The ehrSystem in which the visit is scheduled
id
Link copied to clipboard
val id: String
Content copied to clipboard
A unique identifier representing this visit.
isNewPatient
Link copied to clipboard
val isNewPatient: Boolean
Content copied to clipboard
A flag to indicate if a new patient record was created or not for a visit
isReadyForVisit
Link copied to clipboard
val isReadyForVisit: Boolean
Content copied to clipboard
A flag to indicate whether a PRR or a provider indicates that the visit is ready to happen
patientEmail
Link copied to clipboard
val patientEmail: String? = null
Content copied to clipboard
The patient's contact email
patientGuid
Link copied to clipboard
val patientGuid: String
Content copied to clipboard
The unique identifier representing a DexCare Patient
patientPhone
Link copied to clipboard
val patientPhone: String? = null
Content copied to clipboard
The patient's contact phone number
retailDepartment
Link copied to clipboard
val retailDepartment: RetailDepartment? = null
Content copied to clipboard
An object containing information about the clinic\department where the visit was scheduled.
status
Link copied to clipboard
val status: ScheduledVisitStatus
Content copied to clipboard
An enum representing the current status of the visit
timestamps
Link copied to clipboard
val timestamps: ScheduledVisit.Timestamps
Content copied to clipboard
An object containing specific dateTimes indicating when the visit was updated
type
Link copied to clipboard
val type: ScheduledVisitType
Content copied to clipboard
The type of visit: Retail, Virtual or At Home