VirtualVisitInformation

public struct VirtualVisitInformation
extension VirtualVisitInformation: Equatable

An struct containing additional information required to schedule a virtual visit.

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

    Declaration

    Swift

    public var visitReason: String
  • An enum used to determine who the visit should be scheduled for.

    Declaration

    Swift

    public var patientDeclaration: PatientDeclaration
  • Whether or not the user has accepted the Terms and Conditions required to schedule a virtual visit.

    Declaration

    Swift

    public var acceptedTerms: Bool
  • 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.

    Declaration

    Swift

    public var userEmail: String
  • This should always be a non-empty 10 digit phone number which can be used to contact the app user.

    Declaration

    Swift

    public var contactPhoneNumber: String
  • Any tags to indicate source of user’s visit booking.

    Declaration

    Swift

    public var preTriageTags: [String]?
  • This should always be filled in when booking a Virtual Visit for a dependent. When booking for self, this can be nil.

    Note

    This is to replace the PatientDemographic.actorRelationshipToPatient

    Declaration

    Swift

    public var actorRelationshipToPatient: RelationshipToPatient?
  • Which VirtualPracticeRegion the virtual visit is taking place.

    Declaration

    Swift

    public var practiceRegionId: String?
  • Undocumented

    Declaration

    Swift

    public init(
        visitReason: String, 
        patientDeclaration: PatientDeclaration,
        acceptedTerms: Bool, 
        userEmail: String, 
        contactPhoneNumber: String, 
        preTriageTags: [String]?, 
        actorRelationshipToPatient: RelationshipToPatient?,
        practiceRegionId: String?
    )