VirtualVisitDetails

public struct VirtualVisitDetails : Encodable, Equatable

An object containing additional information used to scheduled a virtual visit

  • Whether or not the patient has accepted the terms of use. Patients cannot schedule a virtual visit without accepting terms

    Declaration

    Swift

    public var acceptedTerms: Bool

  • Qualifications used to assign the visit to a provider. If a regular visit, or your environment does not support special assignment qualifiers, set to nil.

    Declaration

    Swift

    public var assignmentQualifiers: [VirtualVisitAssignmentQualifier]?

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

    Declaration

    Swift

    public var patientDeclaration: PatientDeclaration

  • A two-character state code, used to ensure the provider has a license to provide healthcare services to the patient.

    Declaration

    Swift

    public var stateLicensure: String

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

    Declaration

    Swift

    public var visitReason: String

  • The type of virtual visit to schedule. See static properties on VirtualVisitType for the default supported values.

    Declaration

    Swift

    public var visitTypeName: VirtualVisitTypeName

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

    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

  • If not provided, default practice will be used

    Declaration

    Swift

    public var practiceId: String?

  • If the patient has done a pre-assessment, which tool was used.

    Declaration

    Swift

    public var assessmentToolUsed: String?

  • A brand for the visit. When not provided, a default is used.

    Declaration

    Swift

    public var brand: String?

  • Optional, language to request if interpreter services are available; ISO 639-3 Individual Language codes

    Declaration

    Swift

    public var interpreterLanguage: String?

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

    Declaration

    Swift

    public var preTriageTags: [String]?

  • 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”. This is open to be changed in the future.

    Declaration

    Swift

    public var urgency: Int?

  • This should always be filled in when booking a Virtual Visit for a dependent. When booking for self, this can be nil.

    Declaration

    Swift

    public var actorRelationshipToPatient: RelationshipToPatient?

  • Home market of the region, if applicable.

    Declaration

    Swift

    public var homeMarket: String?

  • Sets the initial status of a virtual visit. If not set, VisitStatus.requested will be used.

    Note

    Some VisitStatus options may not be supported for initialStatus

    Declaration

    Swift

    public var initialStatus: VisitStatus?

  • Should the patient be considered traveling

    Note

    Your environment may not use this property. Leave nil otherwise.

    Declaration

    Swift

    public var traveling: Bool?

  • Any additional meta data/information you wish to be saved with the visit.

    Declaration

    Swift

    public var additionalDetails: AdditionalDetails?

  • Undocumented

    Declaration

    Swift

    public init(acceptedTerms: Bool, assignmentQualifiers: [VirtualVisitAssignmentQualifier]?, patientDeclaration: PatientDeclaration, stateLicensure: String, visitReason: String, visitTypeName: VirtualVisitTypeName, userEmail: String, contactPhoneNumber: String, practiceId: String? = nil, assessmentToolUsed: String? = nil, brand: String? = nil, interpreterLanguage: String? = nil, preTriageTags: [String]? = nil, urgency: Int? = nil, actorRelationshipToPatient: RelationshipToPatient? = nil, homeMarket: String? = nil, initialStatus: VisitStatus? = nil, traveling: Bool? = nil, additionalDetails: AdditionalDetails? = nil)

  • Function called internally to validate the VirtualVisitDetails that is passed in when starting a virtual visit. You can use this function to validate yourself before passing it up

    Throws

    An error of type String indicating what is invalid

    Declaration

    Swift

    public func validate(validateEmail: Bool) throws

    Parameters

    validateEmail

    Skips the EmailValidator checks.