List of epi-me Events, their triggers and Message Template parameters

MESSAGE TEMPLATE PARAMETERS


Patient Portal Account Management (Invitation & Reset Password)

Invitation via Admin Portal

%%Name%%

Invitation from Patient Administration System or Acute eReferral

%%FirstName%%,

%%HospitalName%%

%%AdmissionDate%%

Reset Password

Reset Password must have the following syntax exactly: https://yourcustomerpatientportalURL/Login/ResetPassword?UserID=%%UserID%%&Token=%%token%%

%%Name%%

Multi Factor Authentication

%%Code%%

%%FacilityGroupName%%

Events related to the eAdmission

%%FirstName%% (of Accountholder)

%%LastName%% (of Accountholder)

%%PatientFirstName%%

%%PatientLastName%%

%%HospitalName%%

%%SubmissionDate%%

%%AdmissionDate%%

%%FacilityGoogleMapAddress%%

%%PrivacyPolicyURLAddress%%

%%RightsURLAddress%%

%%PatientInformationBookletURL%%

%%FacilityPhone%%

%%FacilityAddress%%

%%FacilityEmail%%

Appointments

%%AppointmentDate%%

%%AppointmentTime%%

%%Department%%

Session/Class-type Appointments only

%%FirstApptDate%%

%%FirstApptTime%%

%%LastApptDate%%

%%LastApptTime%%

%%SessionCost%%

%%SessionName%%

%%SessionTemplateName%%

%%PatientMRN%%

%%AdmissionID%%

%%EpisodeIDExternal%% (Visit ID or Episode Number from the PAS)

%%PaymentReference%% (provided by the payment gateway)

%%ReceiptNumber%% (generated by EpiSoft)

%%PaymentDate%% (does not take into account timezone)

%%FacilityTimezone%%

%%PaymentDateAndTime%% (does take into account timezone)

Financial Preadmission (IFC & Payments) & Session-type Appointments Only

%%UserEmail%%

%%PatientMRN%%

%%AdmissionID%%

%%EpisodeIDExternal%% (Visit ID or Episode Number from the PAS)

%%TotalGap%%

%%ClaimType%% (NOTE: If Estimate of Fees is being delivered by the PAS, note this field is optional so might not be needed in the Message Template)

%%PaymentPreference%% (synonymous with the payment option)

%%TotalPaymentAmount%%

%%SurchargePercent%% (this refers to the percentage surcharge that was applied to the transaction)

%%SurchargeAmount%% (this is the absolute amount of the surcharge charged to the payor)

%%TotalAmountWithSurcharge%%

%%PaymentReference%% (provided by the payment gateway)

%%ReceiptNumber%% (generated by EpiSoft)

%%PaymentDate%% (does not take into account timezone)

%%FacilityTimezone%%

%%PaymentDateAndTime%% (does take into account timezone)

eReferrals


Received the Referrer Portal

%%ReferralType%%

%%ReferringHospitalName%%

%%PatientFirstName%%

%%PatientLastName%%

%%HospitalName%%

Referrer Account ManagementInvitation to Register on the Referrer Portal

%%ToFirstName%%

%%ToLastName%%

%%FromOrganisation%% (used for Referrer Account Invitation - from Referrer only)

%%FromFirstName%%

%%FromLastName%%

Referrer Account Invitation - from Referrer must have the following syntax exactly https://customerereferrerportalURL/Login/RegisterInvitation?t=%%InviteToken%%

%%Email%%

Invitation to submit via Secure Messaging

%DoctorFullName%%

%%DoctorSendMethod%%.

%%FacilityName%%

%%FacilitySendMethod%%

%%FacilityMailbox%%

%%FacilityUniversalID%%

%%HospitalSecureMessageEndpointAddress%%

Referrer

Password Reset Referrer must have the following syntax exactly https://customerereferrerportalURL/Login/ResetPassword?UserID=%%UserID%%&Token=%%token%%

Multi Factor Authentication

%%Code%%

EVENTS AND THEIR TRIGGERS

Available for use?	Event ID	Event	Triggered By	Notes
Y	1	On Admission Form submitted	This triggers when the first half of the patient eAdmission form (admission / registration) has been submitted
Y	2	On book appointment	This triggers when a Clinician-type appointment has been booked in epi-me and displays the appointment details to the patient	This is for Clinician Appointments only - see On book classes/sessions Events for those appointment types. Only current use-case is the Maternity Pre Admission appointment - see section #4 of this article.
Y	3	On estimate of fees received	This triggers an IFC being sent to the patient user either from the PAS or via the in-app estimate builder.	See section #5 of this other article.
N	4	On payment enabled	N/A
N	5	On admission paperwork enabled	N/A
N	6	On feedback form receive	N/A
Y	7	Follow up form complete	User completion and submission of a followup form	Only current use-case is the Current Infection Screening Form - see this other article.
Y	8	Preadmission forms incomplete	Reminder to the patient user that their Admission and/or History Form is incomplete - will trigger if one or both forms are not submitted
N	9	Preadmission appointment incomplete	N/A
Y	10	Estimate of fees incomplete	At a set number of days and a particular time before the date of admission, and when the user has been sent an IFC which they haven't completed / submitted
Y	11	Payment incomplete	At a set number of days and a particular time before the date of admission, when the patient has a gap payment or token selection they haven't yet paid
N	12	Admission paperwork incomplete	N/A
N	13	Feedback incomplete	N/A
N	14	Post-discharge form incomplete	N/A
N	15	On appointment changed	An appointment date and or time has been amended and displays the new date and time to the patient
N	16	On Patient Enquiry/Chat Create (by staff member)	Message creation by an Admin Portal User to a particular Patient Portal User
N	17	On Patient Enquiry/Chat Reply (by staff member)	Message Reply by an Admin Portal User to the Patient Portal User who sent the original message
Y	18	Password Reset	Admin Portal-initiated Password Reset
Y	19	Account Invitation	'Invite New User' function on the Admin portal
N	20	Account Approval	N/A
N	21	On Appointment Cancel	Patient’s Clinician appointment has been cancelled	This is for Clinician Appointments only - there is currently no Event for cancelling Session/Class-type appointments. See section #2 of this other article.
Y	22	On History Form submitted	Second half of the patient eAdmission form (history) has been submitted
Y	23	Staff Clinical Alerts Email	Based on a scheduled time and date relative to Admission Date, emails a deidentified PDF attachment containing all Clinical Alerts for that Admission Date for a particular Role Group. The email address is configurable per instance of the Event.	See section #3 of this other article for configuration of the Role Groups and their assigned Clinical Alerts. SMS Message Templates are not supported for this Event.
Y	24	On Admission	A time and date scheduled relative to Admission Date. Can be used to send Patient Portal Users instructions about their upcoming admission and can be restricted to admission type and configured by form e.g an email with fasting instructions can be sent to Day Stay patients 3 days before the date, or Maternity users can be sent specific instructions prior to their admission date
N	25	On Discharge	A time and date scheduled relative to Discharge Date of an eAdmission.	Requires a discharge message from the customer Patient Administration System to be implemented.
Y	26	Maternity Preadmission Classes Not Booked	A time and date scheduled relative to Admission Date of an eAdmission. When a Patient Portal patient is eligible for a Pre-admission Maternity class and they haven’t booked any.	See section #3 of this other article.
Y	27	Follow Up Form User Invitation	An Admin Portal user inviting an eReferred Mental Health patient to complete their eAdmission.
Y	28	Request Patient Feedback	A time and date scheduled relative to Discharge Date of an eAdmission. Sends the Patient Hospital Experience Survey form.	See this other article. Requires a discharge message from the customer Patient Administration System to be implemented.
Y	29	Preadmission Follow Up Form Invite to Complete	A time and date scheduled relative to Admission Date of an eAdmission.	Only current use-case is the Current Infection Screening Form - see this other article.
N	30	Discharge Follow Up Form Invite to Complete	A time and date scheduled relative to Discharge Date of an eAdmission.
Y	31	Preadmission Follow Up Form Incomplete	A time and date scheduled relative to Admission Date of an eAdmission. Reminds Patient Portal User to complete a Preadmission Follow Up Form if it remains incomplete.	Only current use-case is the Current Infection Screening Form - see this other article.
Y	32	Discharge Follow Up Form Incomplete	A time and date scheduled relative to Discharge Date of an eAdmission. Reminds Patient Portal User to complete a Discharge Follow Up Form.	Only current use-case is the Patient Hospital Experience Survey - see this other article.
Y	33	Payment Receipt	A payment of a gap on the IFC Payment page on the Patient Portal.	See section #6 of this other article.
Y	34	Payment Receipt (Token only)	A successful tokenisation on the IFC Payment page on the Patient Portal.
Y	35	On book classes/sessions (with payment)	Patient Portal User books a Maternity Class and there is an associated payment with that class	See section #4 of this other article.
Y	36	On book classes/sessions (no charge)	Patient Portal User books a Maternity Class which is free.
Y	37	payment receipt against token	Admin Portal User processes a charge against a patient’s token.	See section #4 of this other article.
Y	38	payment receipt ad hoc	Admin Portal User processes an ad-hoc payment on the Patient Portal User’s behalf.
Y	39	payment receipt refund	Admin Portal User refunds a Patient Portal User’s payment (of any kind).	See section #6 of this other article.
N	99	No event - ad hoc	N/A
Y	100	Password Reset Referrer	Admin Portal User-initiated password reset of a Referrer Portal User.
Y	101	Referrer MFA Verification Code	Referrer Portal Login when portal is configured for Multi Factor Authentication, and portal has not been authenticated in the last 30 days, user has not clicked ‘Remember Me’ or a new browser or device is being used.
Y	102	Referrer Account Invitation (from Referrer)	Referrer invited to use the referrer portal by their colleague in their organisation using the 'Invite New User' function on the referrer portal under 'Manage Additional users'
Y	103	Referrer Account Invitation (from Hospital)	Staff member invites referrer to sign up to eReferrals using the 'Invite New Referrer User' function on the Admin / Portal
N	104	Secure Messaging Invitation	Invites an Admitting Dr to submit eReferrals via secure messaging. Initiated from the Manage Providers page.	See https://episoft.atlassian.net/wiki/spaces/EPIME/pages/1282016368?search_id=87631b65-88f9-4c86-9ff6-90037689b4ae for more detail.
Y	105	On Rehab Referral received	Submission of an External Rehab eReferral.	Can be sent to a specific email address per instance of the Event.
Y	106	On Mental Health Referral received	Submission of an External Mental Health eReferral.
Y	107	On Acute Referral received	Submission of an External Acute eReferral.
Y	108	Maternity Preadmission Appointment Required	Submission of a Maternity eAdmission from the Patient Portal and patient is eligible for a Maternity pre-admission appointment	Only current use-case is the Maternity Pre Admission appointment - see section #1 of this article.
N	109	Medeor Settlement Download	N/A	EpiSoft Only Event
Y	110	Patient MFA Verification Code	Patient Portal Login when portal is configured for Multi Factor Authentication, and portal has not been authenticated in the last 30 days, user has not clicked ‘Remember Me’ or a new browser or device is being used.
N	111	Invite to complete acute admission (initial invite)	Invite to Patient Portal User from Patient Administration System OR from acute eReferral submission, where no matching eAdmission exists.
N	112	Invite to complete acute admission (initial invite with form link)	Same as Invite to complete acute admission (initial invite) except link directs recipient to login page with tokenised invite.
N	113	Invite to complete acute admission (reminder)	Reminder to Patient Portal User where they have already been sent the Invite to complete acute admission (initial invite) Event and a matching eAdmission has still not been started.
N	114	Invite to complete acute admission (reminder with form link)	Same as Invite to complete acute admission (reminder) except link directs recipient to login page with tokenised invite.
Y	115	Payment preference selection incomplete	At a set number of days and a particular time before the date of admission, and when the user has acknowledged an IFC but they have not elected a payment preference.
N	116	Staff notification - booking change after submit	Notification to healthcare provider staff that an eReferral has been amended after submission.	eReferral Form must be configured by EpiSoft to allow amendments after submission in order for this Event to be useful.
N	117	Staff notification - Practice API key request	EpiSoft-only Event: Notification to staff in EpiSoft Information Security committee that a Referrer Portal User has requested API key to link their practice management system.
N	118	On Patient Enquiry/Chat Create (by patient portal user)	Confirmation Enquiry/Chat creation by a Patient Portal User to themselves.
N	119	On estimate of fees received (No user account)	Same as 'On estimate of fees received' Event but where the IFC comes in from PAS but can't match to an existing Patient Portal user.
N	120	Estimate of fees incomplete (Guest user)	Follow-up reminder for IFC for a Guest (no match to Patient Portal account) at a set number of days and time before admission.