VirtualPracticeRegion Structure Reference


                    
                    
                    practiceRegionId

A UUID type of string for the VirtualPracticeRegion

Declaration

Swift

public var practiceRegionId: String


                    
                    
                    displayName

A plain text string for the name of the VirtualPracticeRegion

Declaration

Swift

public var displayName: String


                    
                    
                    regionCode

A grandfathered unique string representing a region, used in getCatchmentArea. Typically a two-character string code

Declaration

Swift

public var regionCode: String


                    
                    
                    active

A boolean indicating whether or not this PracticeRegion is active. If a practice region is not active, you should indicate so in your UI.

Warning

Any Virtual Visits booked with an inactive practice region will be rejected

Declaration

Swift

public var active: Bool


                    
                    
                    busy

A boolean indicating whether or not a practice region is busy and not available

Declaration

Swift

public var busy: Bool


                    
                    
                    busyMessage

A custom plain text string to display when a practice region is busy

Declaration

Swift

public var busyMessage: String


                    
                    
                    visitPrice

Price of the visit in dollars

Declaration

Swift

public var visitPrice: Decimal


                    
                    
                    availability

An array of PracticeRegionAvailabilitywhen a practice region is available.

Declaration

Swift

public var availability: [PracticeRegionAvailability]


                    
                    
                    pediatricsAgeRange

Pediatric age range

Declaration

Swift

public var pediatricsAgeRange: PediatricsAgeRange?


                    
                    
                    departments

An array of departments available for this region

Declaration

Swift

public var departments: [PracticeRegionDepartment]


                    
                    
                    init(from:)

An internal decoder for VirtualPracticeRegion

Declaration

Swift

public init(from decoder: Decoder) throws


                    
                    
                    init(practiceRegionId:displayName:regionCode:active:busy:busyMessage:visitPrice:availability:pediatricsAgeRange:departments:)

Undocumented

Declaration

Swift

public init(
    practiceRegionId: String,
    displayName: String,
    regionCode: String,
    active: Bool,
    busy: Bool,
    busyMessage: String,
    visitPrice: Decimal,
    availability: [PracticeRegionAvailability],
    pediatricsAgeRange: PediatricsAgeRange?,
    departments: [PracticeRegionDepartment]
)