start
Provides an api to schedule a virtual visit. This method returns a unique id for the visit, and an intent which should be used to start the SDK's virtual visit activity and listen for results.
Return
The visitId, as well as an intent which can be used to launch the virtual visit activity.
See also
Parameters
A FragmentActivity that can be used for the SDK to check for required permissions.
A RegisterPushNotification object used to register the Android device for push notifications during the virtual visit. Optional, but highly recommended to be used.
A PaymentMethod object containing the patient's payment information
A VirtualVisitInformation object containing additional details required to schedule the virtual visit.
A CatchmentArea that can be retrieved from org.dexcare.services.patient.PatientService.getCatchmentArea. Alternatively, if your health system has a single EHR system, the CatchmentArea's values should be already known and can be hardcoded.
A DexCarePatient object containing demographics information about the patient.
Optional, a DexCarePatient object containing information about a parent or app user who's booking the visit for someone else. This is only used when VirtualVisitInformation.patientDeclaration is org.dexcare.services.models.PatientDeclaration.Other.
The unique id of the practice in which the visit will be created.
Throws
Returned when required permissions were denied by the app user.
Returned when the device does not support a camera or a microphone.
Returned when any of the following required properties are empty string:
This error is additionally returned when:
VirtualVisitInformation.userEmail does not meet validation requirements (see org.dexcare.util.EmailValidator)
VirtualVisitInformation.contactPhoneNumber does not meet validation requirements (see org.dexcare.util.PhoneValidator)
patientDexCarePatient does not have a demographic link in the EHR system specified by CatchmentArea.ehrSystem,
patientDexCarePatient's address list is empty or the first address contains an invalid zip code (see org.dexcare.util.ZipCodeValidator)
actorDexCarePatient is non-null but has no demographic links,
VirtualVisitInformation.actorRelationshipToPatient is null when booking a "someone else" visit,
actorDexCarePatient is not set when VirtualVisitInformation.patientDeclaration is set to org.dexcare.services.models.PatientDeclaration.Other.
Provides an api to schedule a virtual visit. This method returns a unique id for the visit, and an intent which should be used to start the SDK's virtual visit activity and listen for results.
Return
The visitId, as well as an intent which can be used to launch the virtual visit activity.
See also
Parameters
A Fragment that can be used for the SDK to check for required permissions.
A RegisterPushNotification object used to register the Android device for push notifications during the virtual visit. Optional, but highly recommended to be used.
A PaymentMethod object containing the patient's payment information
A VirtualVisitInformation object containing additional details required to schedule the virtual visit.
A CatchmentArea that can be retrieved from org.dexcare.services.patient.PatientService.getCatchmentArea. Alternatively, if your health system has a single EHR system, the CatchmentArea's values should be already known and can be hardcoded.
A DexCarePatient object containing demographics information about the patient.
Optional, a DexCarePatient object containing information about a parent or app user who's booking the visit for someone else. This is only used when VirtualVisitInformation.patientDeclaration is org.dexcare.services.models.PatientDeclaration.Other.
The unique id of the practice in which the visit will be created.
Throws
Returned when required permissions were denied by the app user.
Returned when the device does not support a camera or a microphone.
Returned when any of the following required properties are empty string:
This error is additionally returned when:
VirtualVisitInformation.userEmail does not meet validation requirements (see org.dexcare.util.EmailValidator)
VirtualVisitInformation.contactPhoneNumber does not meet validation requirements (see org.dexcare.util.PhoneValidator)
patientDexCarePatient does not have a demographic link in the EHR system specified by CatchmentArea.ehrSystem,
patientDexCarePatient's address list is empty or the first address contains an invalid zip code (see org.dexcare.util.ZipCodeValidator)
actorDexCarePatient is non-null but has no demographic links,
VirtualVisitInformation.actorRelationshipToPatient is null when booking a "someone else" visit,
actorDexCarePatient is not set when VirtualVisitInformation.patientDeclaration is set to org.dexcare.services.models.PatientDeclaration.Other.