Other Enumerations Reference


                    
                    
                    DexcareSDKLogLevel

The detail level of the logging

Declaration

Swift

@frozen
public enum DexcareSDKLogLevel : Int


                    
                    
                    ProviderAvailabilitySort

Provider availability sort return options

Declaration

Swift

public enum ProviderAvailabilitySort : String, Codable


                    
                    
                    PaymentMethod

Representing how a user will pay for their visit

Declaration

Swift

public enum PaymentMethod : Equatable


                    
                    
                    Gender

A generic representation of a Gender

Declaration

Swift

@frozen
public enum Gender : String, Equatable

extension Gender: Codable


                    
                    
                    PatientDeclaration

Specifies who the patient will be for a visit

Declaration

Swift

@frozen
public enum PatientDeclaration : String, Codable, Equatable


                    
                    
                    PracticeCareMode

An enum representing a type of care provided by a VirtualPractice.

Declaration

Swift

public enum PracticeCareMode : String, Codable


                    
                    
                    ScheduleProviderAppointmentFailedReason

Undocumented

Declaration

Swift

public enum ScheduleProviderAppointmentFailedReason : Error, FailedReasonType


                    
                    
                    ScheduledVisitType

An enum representing the type of a ScheduledVisit: Retail, Virtual, or At Home.

Any new ScheduledVisitTypes that are not supported will automatically return .unknown

Declaration

Swift

public enum ScheduledVisitType : String, Codable, Equatable


                    
                    
                    ScheduledVisitStatus

An enum representing the status of a ScheduledVisit

Any new ScheduledVisitStatus that are not supported will automatically return .unknown

Declaration

Swift

public enum ScheduledVisitStatus : String, Codable, Equatable


                    
                    
                    IncidentStatus

The various stages of progress towards resolution that a DexcareIncident could be at.

Declaration

Swift

public enum IncidentStatus : String, Codable


                    
                    
                    IncidentImpact

The degree at which a DexcareIncident]` affects a DexCare platform or component.

Declaration

Swift

public enum IncidentImpact : String, Codable


                    
                    
                    DexcareComponentType

An enum representing the DexCare service component. During incidents and scheduled maintenances, multiple components may be effected

Declaration

Swift

public enum DexcareComponentType : String, Codable


                    
                    
                    DexcareComponentStatus

An enum representing a status of a component. During regular operations, this will be operational

Declaration

Swift

public enum DexcareComponentStatus : String, Codable


                    
                    
                    PaymentHolderDeclaration

Specifies who is paying for the visit.

Declaration

Swift

@frozen
public enum PaymentHolderDeclaration : String

extension PaymentHolderDeclaration: Codable


                    
                    
                    FailedReason

A enum of possible errors that may come from the SDK More specific errors may be returned in VirtualVisitFailedReason,

Declaration

Swift

public enum FailedReason : Error

extension FailedReason: LocalizedError


                    
                    
                    ScheduleRetailAppointmentFailedReason

Based on visit-service controller source code here: https://github.com/providenceinnovation/visit-service/blob/517f56d0aae74f7edf14db40a1d2007da1999a0a/app/src/controllers/retailvisitcontroller.ts#L323

Server-side unit tests: https://github.com/providenceinnovation/visit-service/blob/517f56d0aae74f7edf14db40a1d2007da1999a0a/app/test/unit/controllers/retailvisitcontroller.test.ts#L1726

Declaration

Swift

public enum ScheduleRetailAppointmentFailedReason : Error, FailedReasonType


                    
                    
                    CouponCodeFailedReason

An Error enum returned for VerifyCouponCode

Declaration

Swift

public enum CouponCodeFailedReason : Error, FailedReasonType


                    
                    
                    VirtualVisitFailedReason

An Error enum returned when ScheduleVirtualVisit

Declaration

Swift

public enum VirtualVisitFailedReason : Error, FailedReasonType


                    
                    
                    WaitTimeFailedReason

An Error enum returned for Estimated Wait Times

Declaration

Swift

public enum WaitTimeFailedReason : Error, FailedReasonType, Equatable


                    
                    
                    RelationshipToPatient

The relationship that a child/other has to their main user account.

This is required in the PatientService.createDependentPatient call when setting up demographics and subsequently calling RetailService.scheduleRetailAppointment

Declaration

Swift

public enum RelationshipToPatient : String, Codable, Equatable


                    
                    
                    VirtualVisitEventError

Various errors that can happen during a virtual visit session.

Note

These should be used for logging purposes only. Any fatal errors will return in the failure closure when starting or resuming a visit.

Declaration

Swift

public enum VirtualVisitEventError : Error, Equatable


                    
                    
                    DevicePairError

Various errors that can happen during the pairing of a external device.

Declaration

Swift

public enum DevicePairError : Error, Equatable


                    
                    
                    VisitCompletionReason

Undocumented

Declaration

Swift

public enum VisitCompletionReason : String


                    
                    
                    TytoCareFailedReason

Failure Reasons during the TytoCare integration setup

Declaration

Swift

public enum TytoCareFailedReason : Error