VirtualVisitInformation

fun VirtualVisitInformation(visitReason: String, patientDeclaration: PatientDeclaration, userEmail: String, contactPhoneNumber: String, acceptedTerms: Boolean = true, pretriageTags: List<String> = listOf(), actorRelationshipToPatient: RelationshipToPatient? = null, practiceRegionId: String = "")
Content copied to clipboard

Parameters

visitReason

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

patientDeclaration

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

userEmail

This should always be a non-empty email address which can be used to contact the app user. Note: the patient email address as returned by Epic is not guaranteed to be present. For this reason, it is recommended to always collect this information from an alternative source, e.g. Auth0 email.

contactPhoneNumber

A phone number that can be used to communicate with the patient.

acceptedTerms

Whether or not the user has accepted the Terms and Conditions required to schedule a virtual visit.

pretriageTags

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

actorRelationshipToPatient

A RelationshipToPatient enum which is required when patientDeclaration is PatientDeclaration.Other.

practiceRegionId

A unique identifier of a VirtualPracticeRegion in which the visit will be booked. Required when booking to a particular practiceId.