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.

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. You can get avaialble assignment qualifiers via the VirtualService.getAssignmentQualifiers() call.

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

traveling
  • should the patient be considered traveling

actorRelationshipToPatient

An enum of RelationshipToPatient representing the patient's relationship to the patient if scheduling for someone else

This is open to be changed in the future.

Constructors

VirtualVisitDetails
Link copied to clipboard
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, traveling: Boolean? = null, actorRelationshipToPatient: RelationshipToPatient? = null, additionalDetails: AdditionalDetails? = null)
Whether or not the patient has accepted the terms of use.

Functions

describeContents
Link copied to clipboard
abstract fun describeContents(): Int
validate
Link copied to clipboard
fun validate(): MissingInformationError?
writeToParcel
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

acceptedTerms
Link copied to clipboard
val acceptedTerms: Boolean
Whether or not the patient has accepted the terms of use.
actorRelationshipToPatient
Link copied to clipboard
val actorRelationshipToPatient: RelationshipToPatient? = null
An enum of RelationshipToPatient representing the patient's relationship to the patient if scheduling for someone elseThis is open to be changed in the future.
additionalDetails
Link copied to clipboard
val additionalDetails: AdditionalDetails? = null
assessmentToolUsed
Link copied to clipboard
val assessmentToolUsed: String? = null
If the patient has done a preassessment, which tool was used.
assignmentQualifiers
Link copied to clipboard
Qualifications used to assign the visit to a provider.
brand
Link copied to clipboard
val brand: String? = null
A brand for the visit.
contactPhoneNumber
Link copied to clipboard
val contactPhoneNumber: String
An string representing the valid contact number of the user.
detectedLanguage
Link copied to clipboard
val detectedLanguage: String
homeMarket
Link copied to clipboard
val homeMarket: String? = null
Home market, if applicable.
initialStatus
Link copied to clipboard
val initialStatus: VisitStatus? = null
  • status of the visit being created, look at VisitStatus for available values

interpreterLanguage
Link copied to clipboard
val interpreterLanguage: String? = null
Optional, language to request if interpreter services are available; ISO 639-3 Individual Language codes
patientDeclaration
Link copied to clipboard
val patientDeclaration: PatientDeclaration
An enum used to determine who the visit should be scheduled for.
practiceId
Link copied to clipboard
val practiceId: String? = null
The identifier of a practice to schedule the visit in.
preTriageTags
Link copied to clipboard
val preTriageTags: List<String>
An optional list of tags to be used in analytics when scheduling the visit.
stateLicensure
Link copied to clipboard
val stateLicensure: String
A two-character state code, used to ensure the provider has a license to provide healthcare services to the patient.
traveling
Link copied to clipboard
val traveling: Boolean? = null
  • should the patient be considered traveling

urgency
Link copied to clipboard
val urgency: Int? = null
An integer representing the urgency of the visit.
userEmail
Link copied to clipboard
val userEmail: String
An string representing the email address of the user.
visitReason
Link copied to clipboard
val visitReason: String
A short description describing the reason for scheduling the virtual visit.
visitTypeName
Link copied to clipboard
val visitTypeName: VirtualVisitTypeName
The type of virtual visit to schedule.