RetailVisitInformation

data class RetailVisitInformation(visitReason: String, patientDeclaration: PatientDeclaration, userEmail: String, contactPhoneNumber: String, actorRelationshipToPatient: RelationshipToPatient?, patientQuestions: List<PatientQuestion>?) : Parcelable

An object containing additional information required to schedule a retail visit.

Parameters

visitReason

A short description describing the reason for scheduling the retail 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.

actorRelationshipToPatient

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

patientQuestions

An optional list of PatientQuestion that will be passed through to the Epic appointment record.

Constructors

RetailVisitInformation

fun RetailVisitInformation(visitReason: String, patientDeclaration: PatientDeclaration, userEmail: String, contactPhoneNumber: String, actorRelationshipToPatient: RelationshipToPatient? = null, patientQuestions: List<PatientQuestion>? = null)

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

Functions

describeContents

abstract fun describeContents(): Int

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

actorRelationshipToPatient

val actorRelationshipToPatient: RelationshipToPatient? = null

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

contactPhoneNumber

val contactPhoneNumber: String

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

departmentId

var departmentId: String

Set and used internally by the SDK

ehrSystem

var ehrSystem: String

Set and used internally by the SDK

patientDeclaration

val patientDeclaration: PatientDeclaration

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

patientQuestions

val patientQuestions: List<PatientQuestion>? = null

An optional list of PatientQuestion that will be passed through to the Epic appointment record.

providerId

var providerId: String

Set and used internally by the SDK

slotId

var slotId: String

Set and used internally by the SDK

userEmail

val userEmail: String

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

visitReason

val visitReason: String

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