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?) : Parcelable

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

Parameters

acceptedTerms

Whether or not the patient has accepted the terms of use. Patients cannot schedule a virtual visit without accepting terms.

assignmentQualifiers

Qualifications used to assign the visit to a provider. See DefaultVirtualVisitAssignmentQualifiers for the default supported values.

patientDeclaration

An enum used to determine who the visit should be scheduled for.

stateLicensure

A two-character state code, used to ensure the provider has a license to provide healthcare services to the patient.

visitReason

A short description describing the reason for scheduling the virtual visit.

visitTypeName

The type of virtual visit to schedule. See DefaultVirtualVisitTypes for the default supported values.

userEmail

An string representing the email address of the user. This should always be a non-empty email address which can be used to contact the app user.

contactPhoneNumber

An string representing the valid contact number of the user. This should always be a non-empty 10 digit phone number which can be used to contact the app user.

practiceId

The identifier of a practice to schedule the visit in. When not provided, a default is used.

assessmentToolUsed

If the patient has done a preassessment, which tool was used.

brand

A brand for the visit. When not provided, a default is used.

interpreterLanguage

Optional, language to request if interpreter services are available; ISO 639-3 Individual Language codes

preTriageTags

An optional list of tags to be used in analytics when scheduling the visit.

urgency

An integer representing the urgency of the visit. 0 is default urgency, and as of Aug. 31, 2021, 1 and anything higher than 0 is marked as "high priority".

homeMarket

Home market, if applicable.

initialStatus

status of the visit being created, look at VisitStatus for available values This is open to be changed in the future.

Constructors

VirtualVisitDetails

fun VirtualVisitDetails(acceptedTerms: Boolean, assignmentQualifiers: List<VirtualVisitAssignmentQualifier>, patientDeclaration: PatientDeclaration, stateLicensure: String, visitReason: String, visitTypeName: VirtualVisitTypeName, userEmail: String, contactPhoneNumber: String, practiceId: String? = null, assessmentToolUsed: String? = null, brand: String? = null, interpreterLanguage: String? = null, preTriageTags: List<String> = listOf(), urgency: Int? = null, homeMarket: String? = null, initialStatus: VisitStatus? = null)

Whether or not the patient has accepted the terms of use.