VirtualService
public protocol VirtualService
Base Protocol to create, setup, cancel Virtual Visits
-
Resumes a Virtual Visit
Precondition
Must callpatientService.getPatient()
before calling this methodDeclaration
Swift
func resumeVirtualVisit(visitId: String, presentingViewController: UIViewController, dexCarePatient: DexcarePatient, onCompletion: @escaping VisitCompletion, success: @escaping () -> Void, failure: @escaping (VirtualVisitFailedReason) -> Void)
Parameters
visitId
An existing VisitId that is active
presentingViewController
A ViewController from which the DexcareSDK will present the waiting room view and eventually the virtual meeting
dexCarePatient
The DexcarePatient for this visit, loaded from a previous
patientService.getPatient()
call. This patient’s display name will be used during the visit.onCompletion
A closure called when a visit has been completed successfully or has ended with an error. A VisitCompletionReason is passed in as a paramter.
success
A closure called when a visit is successfully resumed.
failure
A closure called if any VirtualVisitFailedReason errors are returned
-
Resumes a Virtual Visit
Declaration
Swift
func resumeVirtualVisit(visitId: String, presentingViewController: UIViewController, ehrPatient: EhrPatient, onCompletion: @escaping VisitCompletion, success: @escaping () -> Void, failure: @escaping (VirtualVisitFailedReason) -> Void)
Parameters
visitId
An existing VisitId that is active
presentingViewController
A ViewController from which the DexcareSDK will present the waiting room view and eventually the virtual meeting
ehrPatient
The EhrPatient for this visit. This patient’s display name will be used during the visit.
onCompletion
A closure called when a visit has been completed successfully or has ended with an error. A VisitCompletionReason is passed in as a paramter.
success
A closure called when a visit is successfully resumed.
failure
A closure called if any VirtualVisitFailedReason errors are returned
-
Updates a push notification device token
Declaration
Swift
func updatePushNotificationDeviceToken(token: Data)
Parameters
token
a device token that is returned by an iOS device in AppDelegate.application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data)
-
Submit the patient feedback questions and answers for a virtual visit.
Precondition
Must callvisitService.startVirtualVisit
orvisitService.resumeVirtualVisit
before calling this methodDeclaration
Swift
func postFeedback(feedbacks: [VirtualFeedback], success: @escaping () -> Void, failure: @escaping (FailedReason) -> Void)
Parameters
feedbacks
An array of
VirtualFeedback
enums, each representing a single feedback question and answer asked to the patient.success
closure when the feedback has been posted successfully
failure
closure when the feedback posting failed
-
Cancels an existing valid virtual visit.
Declaration
Swift
func cancelVirtualVisit(visitId: String, success: @escaping () -> Void, failure: @escaping (VirtualVisitFailedReason) -> Void)
Parameters
visitId
The visitId that you wish to cancel
success
closure when the visit was successfully cancelled
failure
closure when the cancel visit fails. If
VirtualVisitFailedReason.virtualVisitNotFound
is returned it means the visit no longer exists. -
Sets the delegate to invoke various events allowing you to capture analytics.
Note
SeeVirtualEventDelegate
for more informationDeclaration
Swift
func setVirtualEventDelegate(delegate: VirtualEventDelegate?)
-
Fetches the estimated
WaitTime
for a virtual visitImportant
WaitTime
is estimated and may change. The time returned should not be used as a definitive time when a Virtual Visit will begin.Declaration
Swift
func getEstimatedWaitTime(visitId: String, success: @escaping (WaitTime) -> Void, failure: @escaping (WaitTimeFailedReason) -> Void)
Parameters
visitId
A
id
from a start or a resume virtual visit.success
A closure called with a
WaitTime
return valuefailure
A closure called if any
WaitTimeFailedReason
errors are returned -
Gets the statistics report from the OpenTok (Vonage) SDK from a virtual visit. Virtual Visit must have been started in the current app session, and the Provider must have started the visit for this method to return any results. These statistics are only stored in memory, and are cleared upon starting a new visit, calling DexCareSDK.signOut(), or by closing the app (since they’re only in memory)
Note
SeeVideoCallStatistics
for more information on values returnedDeclaration
Swift
func getVideoCallStatistics() -> VideoCallStatistics?
Return Value
An optional
VideoCallStatistics
object containing stats about the visit -
Fetches the latest status for a virtual visit
Declaration
Swift
func getVirtualVisitStatus(visitId: String, success: @escaping (VisitStatus) -> Void, failure: @escaping (FailedReason) -> Void)
Parameters
visitId
A
id
from a start or a resume virtual visit.success
A closure called with a
VisitStatus
enum return valuefailure
A closure called if any
FailedReason
errors are returned -
getWaitTimeAvailability(regionCodes:
assignmentQualifiers: visitTypeNames: practiceId: homeMarket: success: failure: ) Fetches the WaitTimes and Availabilities
If no extra parameters are passed in to filter on, all
WaitTimeAvailability
are returned, including any that are currently not available.Declaration
Swift
func getWaitTimeAvailability(regionCodes: [String]?, assignmentQualifiers: [VirtualVisitAssignmentQualifier]?, visitTypeNames: [VirtualVisitTypeName]?, practiceId: String?, homeMarket: String?, success: @escaping ([WaitTimeAvailability]) -> Void, failure: @escaping (FailedReason) -> Void)
Parameters
regionCodes
An optional array of RegionCodes to filter the results on
assignmentQualifiers
An optional array of
VirtualVisitAssignmentQualifier
to filter the results onvisitTypeNames
An optional array of
VirtualVisitType
representing VisitTypeNames to filter the results onpracticeId
A
VirtualPractice.practiceId
to filter the results onhomeMarket
A string to filter the results for a homeMarket
success
A closure called with a
WaitTimeAvailability
array return valuefailure
A closure called if any
FailedReason
errors are returned -
Fetches the supported
VirtualVisitAssignmentQualifier
objects that can be used to schedule a virtual visit and filterWaitTimeAvailability
.Declaration
Swift
func getAssignmentQualifiers(success: @escaping ([VirtualVisitAssignmentQualifier]) -> Void, failure: @escaping (FailedReason) -> Void)
Parameters
success
A closure called with a
VirtualVisitAssignmentQualifier
array return valuefailure
A closure called if any
FailedReason
errors are returned -
Fetches the supported
VirtualVisitModality
objectsDeclaration
Swift
func getModalities(success: @escaping ([VirtualVisitModality]) -> Void, failure: @escaping (FailedReason) -> Void)
Parameters
success
A closure called with a
VirtualVisitModality
array return valuefailure
A closure called if any
FailedReason
errors are returned -
createVirtualVisit(presentingViewController:
dexcarePatient: virtualVisitDetails: paymentMethod: actor: onCompletion: success: failure: ) Starts or creates a virtual visit with a
DexcarePatient
Call this method to create a new virtual visit and show its full-screen user interface on the specified view controller. Before calling this method, at least one patient must be created by calling patientService.findOrCreatePatient() if the current user is the patient, patientService.findOrCreateDependentPatient() if the patient is a dependent (anyone other than the logged in user) must call.
If the patient already exists, you do not need to call the above method, but the demographic must exist in the ehrSystem you are trying to book to.
Important
If you pass upVirtualVisitDetails.visitTypeName
of.phone
theonCompletion
closure will be called with aVisitCompletionReason.phoneVisit
. This does not mean the visit is complete, but that you have successfully scheduled a visit and the provider will phone you. The full screen user interface will not show on a phone visit.Declaration
Swift
func createVirtualVisit(presentingViewController: UIViewController, dexcarePatient: DexcarePatient, virtualVisitDetails: VirtualVisitDetails, paymentMethod: PaymentMethod, actor: DexcarePatient?, onCompletion: @escaping VisitCompletion, success: @escaping (String) -> Void, failure: @escaping (VirtualVisitFailedReason) -> Void)
Parameters
presentingViewController
A view controller from which the virtual visit UI (waiting room, video call screen, feedback) will be presented.
dexcarePatient
a
DexcarePatient
object used to book the virtual visit under. When booking for a dependent, this will be the dependent patientvirtualVisitDetails
A struct containing details specific to this visit request
paymentMethod
An enumeration with payment/billing information for this visit
actor
a
DexcarePatient
object when booking a virtual visit for a dependent. ArelationshipToPatient
must be set on the virtualVisitDetails property in order to book.onCompletion
A closure called when a visit has been completed successfully or has ended with an error. A VisitCompletionReason is passed in as a parameter.
success
A closure called when a visit is successfully created. The new visitId is passed back as the only parameter.
failure
A closure called if any FailedReason errors are returned
-
createVirtualVisit(presentingViewController:
ehrPatient: virtualVisitDetails: paymentMethod: actor: onCompletion: success: failure: ) Starts or creates a virtual visit with an
EhrPatient
Call this method to create a new virtual visit and show its full-screen user interface on the specified view controller.
Important
If you pass upVirtualVisitDetails.visitTypeName
of.phone
theonCompletion
closure will be called with aVisitCompletionReason.phoneVisit
. This does not mean the visit is complete, but that you have successfully scheduled a visit and the provider will phone you. The full screen user interface will not show on a phone visit.Declaration
Swift
func createVirtualVisit(presentingViewController: UIViewController, ehrPatient: EhrPatient, virtualVisitDetails: VirtualVisitDetails, paymentMethod: PaymentMethod, actor: EhrPatient?, onCompletion: @escaping VisitCompletion, success: @escaping (String) -> Void, failure: @escaping (VirtualVisitFailedReason) -> Void)
Parameters
presentingViewController
A view controller from which the virtual visit UI (waiting room, video call screen, feedback) will be presented.
ehrPatient
an
EhrPatient
object used to book the virtual visit under. When booking for a dependent, this will be the dependent patientvirtualVisitDetails
A struct containing details specific to this visit request
paymentMethod
An enumeration with payment/billing information for this visit
actor
a
EhrPatient
object when booking a virtual visit for a dependent. ArelationshipToPatient
must be set on the virtualVisitDetails property in order to book.onCompletion
A closure called when a visit has been completed successfully or has ended with an error. A VisitCompletionReason is passed in as a parameter.
success
A closure called when a visit is successfully created. The new visitId is passed back as the only parameter.
failure
A closure called if any FailedReason errors are returned
-
postFeedback(feedbacks:
Asynchronous) Submit the patient feedback questions and answers for a virtual visit.
- feedbacks: An array of
VirtualFeedback
enums, each representing a single feedback question and answer asked to the patient.
Throws
Throws:FailedReason
Precondition
Must callvisitService.startVirtualVisit
orvisitService.resumeVirtualVisit
before calling this methodDeclaration
Swift
func postFeedback(feedbacks: [VirtualFeedback]) async throws
Return Value
When the feedback has been posted successfully
- feedbacks: An array of
-
cancelVirtualVisit(visitId:
Asynchronous) Cancels an existing valid virtual visit.
Throws
Throws:When the cancel visit fails. IfVirtualVisitFailedReason.virtualVisitNotFound
is returned it means the visit no longer exists.Declaration
Swift
func cancelVirtualVisit(visitId: String) async throws
Parameters
visitId
The visitId that you wish to cancel
Return Value
When successfully cancelled
-
getEstimatedWaitTime(visitId:
Asynchronous) Fetches the estimated
WaitTime
for a virtual visitImportant
WaitTime
is estimated and may change. The time returned should not be used as a definitive time when a Virtual Visit will begin.Throws
Throws:WaitTimeFailedReason
Declaration
Swift
func getEstimatedWaitTime(visitId: String) async throws -> WaitTime
Parameters
visitId
A
id
from a start or a resume virtual visit.Return Value
WaitTime
object -
getAssignmentQualifiers()
AsynchronousFetches the supported
VirtualVisitAssignmentQualifier
objects that can be used to schedule a virtual visit and filterWaitTimeAvailability
.Throws
Throws:FailedReason
Declaration
Swift
func getAssignmentQualifiers() async throws -> [VirtualVisitAssignmentQualifier]
Return Value
: A
VirtualVisitAssignmentQualifier
array -
getModalities()
AsynchronousFetches the supported
VirtualVisitModality
objectsThrows
Throws:FailedReason
Declaration
Swift
func getModalities() async throws -> [VirtualVisitModality]
Return Value
VirtualVisitModality
array -
Resumes a Virtual Visit
Throws
VirtualVisitFailedReason
Precondition
Must callpatientService.getPatient()
before calling this methodDeclaration
Swift
func resumeVirtualVisit(visitId: String, presentingViewController: UIViewController, dexCarePatient: DexcarePatient, onCompletion: @escaping VisitCompletion) async throws
Parameters
visitId
An existing VisitId that is active
presentingViewController
A ViewController from which the DexcareSDK will present the waiting room view and eventually the virtual meeting
dexCarePatient
The DexcarePatient for this visit, loaded from a previous
patientService.getPatient()
call. This patient’s display name will be used during the visit.onCompletion
A closure called when a visit has been completed successfully or has ended with an error. A VisitCompletionReason is passed in as a parameter.
Return Value
When a visit is successfully resumed
-
Resumes a Virtual Visit
Throws
VirtualVisitFailedReason
Declaration
Swift
func resumeVirtualVisit(visitId: String, presentingViewController: UIViewController, ehrPatient: EhrPatient, onCompletion: @escaping VisitCompletion) async throws
Parameters
visitId
An existing VisitId that is active
presentingViewController
A ViewController from which the DexcareSDK will present the waiting room view and eventually the virtual meeting
ehrPatient
The EhrPatient for this visit. This patient’s display name will be used during the visit.
onCompletion
A closure called when a visit has been completed successfully or has ended with an error. A VisitCompletionReason is passed in as a parameter.
Return Value
When a visit is successfully resumed
-
getWaitTimeAvailability(regionCodes:
AsynchronousassignmentQualifiers: visitTypeNames: practiceId: homeMarket: ) Fetches the WaitTimes and Availabilities
If no extra parameters are passed in to filter on, all
WaitTimeAvailability
are returned, including any that are currently not available.Throws
FailedReason
Declaration
Swift
func getWaitTimeAvailability(regionCodes: [String]?, assignmentQualifiers: [VirtualVisitAssignmentQualifier]?, visitTypeNames: [VirtualVisitTypeName]?, practiceId: String?, homeMarket: String?) async throws -> [WaitTimeAvailability]
Parameters
regionCodes
An optional array of RegionCodes to filter the results on
assignmentQualifiers
An optional array of
VirtualVisitAssignmentQualifier
to filter the results onvisitTypeNames
An optional array of
VirtualVisitType
representing VisitTypeNames to filter the results onpracticeId
A
VirtualPractice.practiceId
to filter the results onhomeMarket
A string to filter the results for a homeMarket
Return Value
WaitTimeAvailability
array -
getVirtualVisitStatus(visitId:
Asynchronous) Fetches the latest status for a virtual visit
Throws
FailedReason
Declaration
Swift
func getVirtualVisitStatus(visitId: String) async throws -> VisitStatus
Parameters
visitId
A
id
from a start or a resume virtual visit.Return Value
VisitStatus
enum