ScheduledVisit Structure Reference

id

A unique identifier representing this visit

Declaration

Swift

public let id: String


                    
                    
                    type

The type of visit: Retail, Virtual or At Home

Declaration

Swift

public let type: ScheduledVisitType


                    
                    
                    status

An enum representing the current status of the visit

Declaration

Swift

public let status: ScheduledVisitStatus


                    
                    
                    address

The patient’s address

Declaration

Swift

public let address: Address


                    
                    
                    appointmentDetails

An AppointmentDetails object containing additional details about the appointment

Declaration

Swift

public let appointmentDetails: AppointmentDetails


                    
                    
                    departmentId

The ID of the department where the visit is scheduled

Declaration

Swift

public let departmentId: String


                    
                    
                    ehrSystemName

The ehrSystem in which the visit is scheduled

Declaration

Swift

public let ehrSystemName: String


                    
                    
                    isNewPatient

A flag to indicate if a new patient record was created or not for a visit

Declaration

Swift

public let isNewPatient: Bool


                    
                    
                    isReadyForVisit

A flag to indicate whether a PRR or a provider indicates that the visit is ready to happen

Declaration

Swift

public let isReadyForVisit: Bool


                    
                    
                    patientEmail

The patient’s contact email

Declaration

Swift

public let patientEmail: String?


                    
                    
                    patientGuid

The unique identifier representing a DexCare Patient

Declaration

Swift

public let patientGuid: String


                    
                    
                    patientPhone

The patient’s contact phone number

Declaration

Swift

public let patientPhone: String?


                    
                    
                    timestamps

A Timestamps object containing specific dateTimes indicating when the visit was updated

Declaration

Swift

public let timestamps: Timestamps


                    
                    
                    clinic

A Clinic containing information about the clinic where the visit was scheduled. Present only for Retail visit type, nil otherwise.

Declaration

Swift

public var clinic: Clinic?


                    
                    
                    init(id:type:status:address:appointmentDetails:departmentId:ehrSystemName:isNewPatient:isReadyForVisit:patientEmail:patientGuid:patientPhone:timestamps:clinic:)

Undocumented

Declaration

Swift

public init(

    id: String, 

    type: ScheduledVisitType, 

    status: ScheduledVisitStatus, 

    address: Address, 

    appointmentDetails: AppointmentDetails, 

    departmentId: String, 

    ehrSystemName: String, 

    isNewPatient: Bool, 

    isReadyForVisit: Bool, 

    patientEmail: String?, 

    patientGuid: String, 

    patientPhone: String?, 

    timestamps: Timestamps, 

    clinic: Clinic?

)


                    
                    
                    AppointmentDetails

Additional details about the appointment

Declaration

Swift

public struct AppointmentDetails : Equatable, Codable


                    
                    
                    Timestamps

An struct representing various times at wchich a ScheduledVisit was updated

Declaration

Swift

public struct Timestamps : Equatable, Codable