VirtualPracticeRegion

public struct VirtualPracticeRegion : Codable, Equatable

A structure representing a physical area serviced by a VirtualPractice

  • A UUID type of string for the VirtualPracticeRegion

    Declaration

    Swift

    public var practiceRegionId: String

  • A plain text string for the name of the VirtualPracticeRegion

    Declaration

    Swift

    public var displayName: String

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

    Declaration

    Swift

    public var regionCode: String

  • 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

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

    Declaration

    Swift

    public var busy: Bool

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

    Declaration

    Swift

    public var busyMessage: String

  • Price of the visit in dollars

    Declaration

    Swift

    public var visitPrice: Decimal

  • An array of PracticeRegionAvailabilitywhen a practice region is available.

    Declaration

    Swift

    public var availability: [PracticeRegionAvailability]

  • An internal decoder for VirtualPracticeRegion

    Declaration

    Swift

    public init(from decoder: Decoder) throws

  • Undocumented

    Declaration

    Swift

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