ProviderVisitInformation

data class ProviderVisitInformation(visitReason: String, patientDeclaration: PatientDeclaration, userEmail: String, contactPhoneNumber: String, actorRelationshipToPatient: RelationshipToPatient?, patientQuestions: List<PatientQuestion>?, providerFlowPayment: Boolean) : Parcelable
Content copied to clipboard

Contains additional information required to book a Provider visit.

Parameters

visitReason

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

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

providerFlowPayment

  • A boolean for the provider-flow-payment feature flag

Constructors

ProviderVisitInformation
Link copied to clipboard
fun ProviderVisitInformation(visitReason: String, patientDeclaration: PatientDeclaration, userEmail: String, contactPhoneNumber: String, actorRelationshipToPatient: RelationshipToPatient? = null, patientQuestions: List<PatientQuestion>? = null, providerFlowPayment: Boolean)
Content copied to clipboard
A short description describing the reason for scheduling the provider visit.

Functions

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

Properties

actorRelationshipToPatient
Link copied to clipboard
val actorRelationshipToPatient: RelationshipToPatient? = null
Content copied to clipboard
A RelationshipToPatient enum which is required when patientDeclaration is PatientDeclaration.Other.
contactPhoneNumber
Link copied to clipboard
val contactPhoneNumber: String
Content copied to clipboard
A phone number that can be used to communicate with the patient.
departmentId
Link copied to clipboard
var departmentId: String
Content copied to clipboard
Set and used internally by the SDK.
ehrSystem
Link copied to clipboard
var ehrSystem: String
Content copied to clipboard
Set and used internally by the SDK.
nationalProviderId
Link copied to clipboard
var nationalProviderId: String
Content copied to clipboard
Set and used internally by the SDK.
patientDeclaration
Link copied to clipboard
val patientDeclaration: PatientDeclaration
Content copied to clipboard
An enum used to determine who the visit should be scheduled for.
patientQuestions
Link copied to clipboard
val patientQuestions: List<PatientQuestion>? = null
Content copied to clipboard
An optional list of PatientQuestion that will be passed through to the Epic appointment record.
providerFlowPayment
Link copied to clipboard
var providerFlowPayment: Boolean
Content copied to clipboard

  • A boolean for the provider-flow-payment feature flag

slotId
Link copied to clipboard
var slotId: String
Content copied to clipboard
Set and used internally by the SDK.
userEmail
Link copied to clipboard
val userEmail: String
Content copied to clipboard
This should always be a non-empty email address which can be used to contact the app user.
visitReason
Link copied to clipboard
val visitReason: String
Content copied to clipboard
A short description describing the reason for scheduling the provider visit.
visitTypeId
Link copied to clipboard
var visitTypeId: String
Content copied to clipboard
Set and used internally by the SDK.