Difference between revisions of "SMS and Email Setup"

From TMS Support Wiki
Jump to navigation Jump to search
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[File:PatientSMSExample.png|300px|right|thumb|PTS 5 can transcode any notes to SMS messages and send them to patients automatically.]]
[[File:PatientSMSExample.png|300px|right|thumb|PTS 5 can transcode any notes to SMS messages and send them to patients automatically.]]
In PTS 5, any note can be created with the capability to send itself as an SMS or email to patients, wards or the dispensary.
In PTS 5, any [[Notes|note]] can be created with the capability to send itself as an SMS or email to patients, wards or the dispensary.


Combined with the natural flexibility of PTS 5's notes utility you will be able to set up SMS and/or other messaging functionality for a variety of situations, to be sent either automatically via an auto-recorded note, or by recording the note manually (such as with a barcode scanner).  
Combined with the natural flexibility of PTS 5's notes utility you will be able to set up SMS and/or other messaging functionality for a variety of situations, to be sent either automatically via an automatic note, or by recording the note manually (such as with a barcode scanner).  


=Examples=
=Examples=
Line 14: Line 14:
<li>Sending an email to the dispensary when a certain error note is recorded.</li>
<li>Sending an email to the dispensary when a certain error note is recorded.</li>
</ol>
</ol>
Emailing must also be configured before the "Forgot Password" procedure will work.
=Connecting PTS to your Email server and account=
As a PTS administrator, go to Setup > Application Settings and do a search for "Email". The pertinent settings are as follows:
<blockquote>
EMAILFROM<br/>
EMAILPASS<br/>
EMAILPORT<br/>
EMAILSERV<br/>
EMAILSSL<br/>
EMAILUSER
</blockquote>
The correct settings can be provided by IT. Let them know that you are looking to configure PTS to send emails.


=Connecting PTS to your SMS provider=
=Connecting PTS to your SMS provider=
Line 24: Line 38:
SMSUSER
SMSUSER
</blockquote>
</blockquote>
The correct settings will be provided either by IT or by TMSi if using one of our SMS credit bundles.
The correct settings will be provided either by IT or by TMSi if using one of our SMS credit bundles. Your PTS server will need to be able to access the outside internet, specifically the URL that will be provided for the SMSURL setting.
 
<i>TMSi note: SMSUSER is an email address when using txtlocal.</i>
==TMSi SMS Credit Bundles==
==TMSi SMS Credit Bundles==
Contact us to purchase SMS credit bundles.
Contact us to purchase SMS credit bundles.
Line 41: Line 57:
</ul>
</ul>
===GOV.UK Notify===
===GOV.UK Notify===
[https://notifications.service.gov.uk GOV.UK Notify] support was implemented in PTS v5.0.3.3 and we think it may prove to be the de facto method for sending SMS (and email) messages from PTS due to the low cost and obvious ties to the NHS. Creating and setting up the GOV.UK Notify account is beyond the scope of this article; please contact your IT department if you're unable to create the account yourself.
[https://notifications.service.gov.uk GOV.UK Notify] support was implemented in PTS v5.0.3.3. Creating and setting up the GOV.UK Notify account is beyond the scope of this article; please contact your IT department if you're unable to create the account yourself.


Once the account is set up, you need to create an API Key and two templates (one for SMS, one for email) that have "((ptsmessage))" (without quotes but including the double brackets) as the text in the body of the template. The two templates will be given an auto-generated Template ID.
Once the account is set up, you need to create an API Key and two templates (one for SMS, one for email) that have "((ptsmessage))" (without quotes but including the double brackets) as the text in the body of the template. The two templates will be given an auto-generated Template ID.
If you intend to use GOV.UK Notify for email then the subject field needs to be set to "((subject))" (without quotes but including the double brackets) in the email template. Also note that the content cannot include any HTML; this may mean that the format of PTS user registration messages may need to be amended in application settings.


As a PTS administrator go to Application Settings and populate the settings as follows:
As a PTS administrator go to Application Settings and populate the settings as follows:
Line 53: Line 71:
|SMSAPIID
|SMSAPIID
|API Key
|API Key
|-
|SMSURL
|SMS Template ID
|-
|SMSTYPE
|GOV.UK Notify
|-
|-
|EMAILFROM
|EMAILFROM
|API Key
|API Key
|-
|SMSURL
|SMS Template ID
|-
|-
|EMAILUSER
|EMAILUSER
|Email Template ID
|Email Template ID
|-
|SMSTYPE
|GOV.UK Notify
|-
|-
|EMAILSERV
|EMAILSERV
Line 70: Line 88:
|}
|}


=Recipients phone number and/or email address=
=Patient's phone number and/or email address=
[[File:BookingInWithMobileNumber.png|300px|thumb|The booking in screen with patient mobile number and email address fields.]]
[[File:BookingInWithMobileNumber.png|300px|thumb|The booking in screen with patient mobile number and email address fields.]]
To include the fields to capture the patient's phone number and/or email address on the booking in screen, go to Setup > Prescription Types > [click the prescription type] > Demographic Options and enable "Record mobile no." and/or "Record E-Mail". This will add these fields to the booking in screen for the chosen prescription type, but they will not be mandatory fields, and the patient can opt out of receiving any SMS and emails by simply not providing the information to the pharmacist.
To include the fields to capture the patient's phone number and/or email address on the booking in screen, go to Setup > Prescription Types > [click the prescription type] > Demographic Options and enable "Record mobile no." and/or "Record E-Mail". This will add these fields to the booking in screen for the chosen prescription type, but they will not be mandatory fields, and the patient can opt out of receiving any SMS and emails by simply not providing the information to the pharmacist.


=Wards and Dispensaries phone numbers and/or email addresses=
Notes configured to contact a dispensary or ward will attempt to send the note to any and all users assigned to the location who is set up to receive them. Go to Setup > Users > [click a user] and ensure that the "Phone Number" and "Email" fields are completed and the "Receive text/email alerts" setting is set to yes. See the Users setup guide for more on assigning users to wards and dispensaries. It's not uncommon to have a single generic user account representing wards, so it may be a case of identifying this user account and setting it up appropriately.
Notes configured to contact a dispensary or ward will attempt to send the note to any and all users assigned to the location who is set up to receive them. Go to Setup > Users > [click a user] and ensure that the "Phone Number" and "Email" fields are completed and the "Receive text/email alerts" setting is set to yes. See the Users setup guide for more on assigning users to wards and dispensaries. It's not uncommon to have a single generic user account representing wards, so it may be a case of identifying this user account and setting it up appropriately.


Line 92: Line 111:
</blockquote>
</blockquote>


In addition you could have this particular note auto-record when the prescription is completed/waiting for collection, which you can configure from the Prescription Types setup page. Alternatively you could print its barcode and record it manually.
In addition you could have this particular note auto-record when the prescription is completed/waiting for collection, which you can configure from the Prescription Types setup page. Alternatively you could print its barcode and record the note manually.


Any note or type of note can be configured to send an SMS or email.
Any note or type of note can be configured to send an SMS or email.

Latest revision as of 14:38, 2 October 2024

PTS 5 can transcode any notes to SMS messages and send them to patients automatically.

In PTS 5, any note can be created with the capability to send itself as an SMS or email to patients, wards or the dispensary.

Combined with the natural flexibility of PTS 5's notes utility you will be able to set up SMS and/or other messaging functionality for a variety of situations, to be sent either automatically via an automatic note, or by recording the note manually (such as with a barcode scanner).

Examples

Some examples include:

  1. Sending an automatic SMS to welcome the patient and confirm their prescription is now being dispensed.
  2. Sending an automatic SMS to a patient when their prescription is ready.
  3. Sending an SMS manually to alert the patient to a problem, and call them to the hatch.
  4. Sending an email to the ward to ask them to call the pharmacy to answer a query.
  5. Sending an email to the ward when an urgent prescription type becomes ready for collection.
  6. Sending an email to the dispensary when a certain error note is recorded.

Emailing must also be configured before the "Forgot Password" procedure will work.

Connecting PTS to your Email server and account

As a PTS administrator, go to Setup > Application Settings and do a search for "Email". The pertinent settings are as follows:

EMAILFROM
EMAILPASS
EMAILPORT
EMAILSERV
EMAILSSL
EMAILUSER

The correct settings can be provided by IT. Let them know that you are looking to configure PTS to send emails.

Connecting PTS to your SMS provider

As a PTS administrator, go to Setup > Application Settings and do a search for "SMS". The pertinent settings are as follows:

SMSAPIID
SMSPASSWORD
SMSTYPE
SMSURL
SMSUSER

The correct settings will be provided either by IT or by TMSi if using one of our SMS credit bundles. Your PTS server will need to be able to access the outside internet, specifically the URL that will be provided for the SMSURL setting.

TMSi note: SMSUSER is an email address when using txtlocal.

TMSi SMS Credit Bundles

Contact us to purchase SMS credit bundles.

If it's your first purchase we will also set up your SMS API and provide you with the details you'll need to connect your PTS installation to the API.

You'll be able to view your remaining credits via the Contracts & Licenses page at tmsinsight.com.

Other compatible third party providers

  • GOV.UK Notify
  • Clickatell
  • Textlocal
  • Email to SMS
  • Soprano
  • Envoy

GOV.UK Notify

GOV.UK Notify support was implemented in PTS v5.0.3.3. Creating and setting up the GOV.UK Notify account is beyond the scope of this article; please contact your IT department if you're unable to create the account yourself.

Once the account is set up, you need to create an API Key and two templates (one for SMS, one for email) that have "((ptsmessage))" (without quotes but including the double brackets) as the text in the body of the template. The two templates will be given an auto-generated Template ID.

If you intend to use GOV.UK Notify for email then the subject field needs to be set to "((subject))" (without quotes but including the double brackets) in the email template. Also note that the content cannot include any HTML; this may mean that the format of PTS user registration messages may need to be amended in application settings.

As a PTS administrator go to Application Settings and populate the settings as follows:

Application Setting GOV.UK Notify Setting
SMSAPIID API Key
SMSURL SMS Template ID
SMSTYPE GOV.UK Notify
EMAILFROM API Key
EMAILUSER Email Template ID
EMAILSERV GOV.UK Notify

Patient's phone number and/or email address

The booking in screen with patient mobile number and email address fields.

To include the fields to capture the patient's phone number and/or email address on the booking in screen, go to Setup > Prescription Types > [click the prescription type] > Demographic Options and enable "Record mobile no." and/or "Record E-Mail". This will add these fields to the booking in screen for the chosen prescription type, but they will not be mandatory fields, and the patient can opt out of receiving any SMS and emails by simply not providing the information to the pharmacist.

Wards and Dispensaries phone numbers and/or email addresses

Notes configured to contact a dispensary or ward will attempt to send the note to any and all users assigned to the location who is set up to receive them. Go to Setup > Users > [click a user] and ensure that the "Phone Number" and "Email" fields are completed and the "Receive text/email alerts" setting is set to yes. See the Users setup guide for more on assigning users to wards and dispensaries. It's not uncommon to have a single generic user account representing wards, so it may be a case of identifying this user account and setting it up appropriately.

Creating an applicable note

Note details tab of a note to be used with SMS. This note aims to text the patient when the prescription is ready for them to collect.

See the Notes page to go in-depth on setting up notes.

Suffice to say that it's possible to create a note that optionally autofills certain data (patient's name, their ticket number, etc.) around a template of your choosing. For example a note built as such:

Dear ~, your Prescription (no. #) is ready for collection from the pharmacy.

Would be reinterpreted as:

Dear Joe Bloggs, your Prescription (no. 1471) is ready for collection from the pharmacy.

In addition you could have this particular note auto-record when the prescription is completed/waiting for collection, which you can configure from the Prescription Types setup page. Alternatively you could print its barcode and record the note manually.

Any note or type of note can be configured to send an SMS or email.

Configuring note messaging options to send an SMS or email

The note messaging options. These settings apply when valid phone numbers or email addresses are available for the patient, ward or dispensary.

Any note can be configured to be sent to either the patient, ward or dispensary as either an SMS or an email.

Once the note is set up and working as expected, go to Setup > Notes > [click the note] > Messaging Options, and configure the messaging options as you see fit. Now whenever the note is recorded, whether automatically or manually, the note text will be sent to any applicable recipients.