ProviderAvailabilityOptions

public struct ProviderAvailabilityOptions : Encodable, Equatable

Options when searching for provider availability - AvailabilityService.getProviderAvailability

  • Health system defined visit type name filter.

    Declaration

    Swift

    public var visitTypeNames: [String]?

  • Start date of slots with yyyy-MM-dd format, default set to today if not present.

    Declaration

    Swift

    public var startDate: Date?

  • End date of slots with yyyy-MM-dd format, end days will be certain days after start date if not present.

    Declaration

    Swift

    public var endDate: Date?

  • Provider specialty filter

    Declaration

    Swift

    public var specialty: String?

  • Provider gender filter

    Declaration

    Swift

    public var gender: Gender?

  • EHR Instance Identifiers filter

    Declaration

    Swift

    public var ehrInstances: [String]?

  • Clinic type filter

    Declaration

    Swift

    public var clinicType: [String]?

  • How you want the results to be sorted

    Note

    defaults to ProviderAvailabilitySort.mostAvailable

    Declaration

    Swift

    public var sortBy: ProviderAvailabilitySort?

  • Can be used on AvailabilityService.getProviderAvailabilitySlots to rerun a previous search

    Declaration

    Swift

    public var searchContext: String?

  • Undocumented

    Declaration

    Swift

    public init(
    visitTypeNames: [String]? = nil,
    startDate: Date? = nil,
    endDate: Date? = nil,
    specialty: String? = nil,
    gender: Gender? = nil,
    ehrInstances: [String]? = nil,
    clinicType: [String]? = nil,
    sortBy: ProviderAvailabilitySort? = nil,
    searchContext: String? = nil
)