Package org.dexcare.services.virtualvisit.models

Types

Answer

data class Answer(id: String, type: String, value: String, text: String) : Parcelable

CatchmentArea

data class CatchmentArea(ehrSystem: String, departmentId: String)

Represents an area serviced by a hospital/health system.

Conference

data class Conference(conferenceId: String?, conferenceSessionId: String?, rating: Int?, startTime: String?, endTime: String?, visitId: String?, userDisplayName: String?, userID: String?) : Parcelable

CouponCode

data class CouponCode(code: String, status: CouponCode.Status, discountAmount: Double) : Parcelable

DefaultVirtualVisitTypes

enum DefaultVirtualVisitTypes : Enum<DefaultVirtualVisitTypes> , Parcelable

DefaultVisitStatus

enum DefaultVisitStatus : Enum<DefaultVisitStatus>

Represents the status of a virtual visit.

Feedback

data class Feedback(id: String?, type: String?, text: String?, answers: MutableList<Answer>) : Parcelable

FeedbackQuestions

enum FeedbackQuestions : Enum<FeedbackQuestions> , Parcelable

Represents various feedback question/answer pairs supported by the feedback service.

Lang

sealed class Lang

PediatricsAgeRange

data class PediatricsAgeRange(min: Double?, max: Double?) : Parcelable

Represents the minimum and maximus age range for Pediatrics for providers that support pediatric visits

RegionAvailabilityReason

enum RegionAvailabilityReason : Enum<RegionAvailabilityReason> , Parcelable

RegisterPushNotification

data class RegisterPushNotification(appId: String, fcmToken: String, platform: String) : Parcelable

A model containing information required to register an android device to receive push notifications.

VirtualActor

data class VirtualActor(firstName: String, lastName: String, gender: Gender, dateOfBirth: LocalDate, phone: String, email: String, address: Address, relationshipToPatient: RelationshipToPatient, ehrIdentifier: String?, ehrIdentifierType: String?, homeEhr: String?) : Parcelable

Represents the app user when scheduling a virtual visit for someone else.

VirtualFeedback

sealed class VirtualFeedback

A base class representing user-given feedback.

VirtualPractice

data class VirtualPractice(practiceId: String, displayName: String, careMode: PracticeCareMode, paymentAvailability: PracticePaymentAvailability, epicBookingEnabled: Boolean, practiceRegions: List<VirtualPracticeRegion>) : Practice, Parcelable

A Practice is a collection of resources that provides a type of care to patients.

VirtualPracticeRegion

data class VirtualPracticeRegion(practiceRegionId: String, displayName: String, regionCode: String, active: Boolean, busy: Boolean, busyMessage: String, priceInCents: Int, practiceRegionAvailability: List<PracticeRegionAvailability>, pediatricsAgeRange: PediatricsAgeRange?) : Parcelable

Represents a physical area serviced by a VirtualPractice.

VirtualVisitDetails

data class VirtualVisitDetails(acceptedTerms: Boolean, assignmentQualifiers: List<VirtualVisitAssignmentQualifier>?, patientDeclaration: PatientDeclaration, stateLicensure: String, visitReason: String, visitTypeName: VirtualVisitTypeName, userEmail: String, contactPhoneNumber: String, practiceId: String?, assessmentToolUsed: String?, brand: String?, interpreterLanguage: String?, preTriageTags: List<String>, urgency: Int?, homeMarket: String?, initialStatus: VisitStatus?, traveling: Boolean?, actorRelationshipToPatient: RelationshipToPatient?, additionalDetails: AdditionalDetails?) : Lang, Parcelable

An object containing additional information used to schedule a virtual visit.

WaitTime

data class WaitTime(estimatedWaitTimeSeconds: Int, estimatedWaitTimeMessage: String?, generatedAt: ZonedDateTime, waitTimeLocalizationInfo: WaitTimeLocalizationInfo?) : Parcelable

Contains information about an estimated wait time for a Virtual Practice Region, or a Virtual Visit.

WaitTimeAvailability

data class WaitTimeAvailability(generatedAt: Instant, estimatedWaitTimeSeconds: Int?, estimatedWaitTimeMessage: String?, available: Boolean, reason: WaitTimeAvailability.Reason?, regionCode: String?, practiceId: String, visitTypeName: VirtualVisitTypeName?, assignmentQualifiers: List<VirtualVisitAssignmentQualifier>?, homeMarket: String?)

Contains information about a particular virtual visit provider queue.

WaitTimeLocalizationInfo

data class WaitTimeLocalizationInfo(modality: VirtualVisitModality, waitTimeMapKey: String, timeMinSeconds: Int?, timeMaxSeconds: Int?) : Parcelable

Contains localization information about an estimated wait time for a Virtual Practice Region, or a Virtual Visit.

Functions

isVisitStatusActive

fun isVisitStatusActive(status: VisitStatus): Boolean

A helper function that can be used to determine whether or not a visit can be reconnected to using org.dexcare.services.virtualvisit.VirtualService.resumeVirtualVisit.

key

fun WaitTimeLocalizationInfo.key(): String