Message Templates

Message Templates in Nuntio

The Message Templates feature in the Nuntio Admin Site allows administrators to create and customize formatted messages to suit specific business processes and user needs. These templates can be configured with dynamic data, custom layouts, and behavior to enhance user experience.

---

Accessing Message Templates

1. Log in to the Admin Site:

   • Navigate to the Nuntio Admin Site at:

     [main Nuntio URL]/admin

   • Enter your administrator credentials to log in.

2. Go to Message Templates:

   • On the left-hand menu, click Message Templates to access the page where you can create or edit existing templates.

---

Creating or Editing a Message Template

1. Select Message Type to Edit:

   • Choose an existing message type from the dropdown list under Select Message Type to Edit. This will load the template settings for that message type.

2. Template Name:

   • This is the name of the message template (e.g., RAD_CRITICAL). You can rename it to match your specific use case.

---

Configurable Fields in the Template

• Message Type is a Multi-Row Console View:

  • Check this box if the message type requires a Multi-Row Console View. This feature allows you to send multiple rows in a single message, which is useful for scenarios like a patient console or any item that requires a read-only view.

  • Each row will represent a separate item, and users can see multiple data points in a structured format.

  • This setting is not related to acknowledgment but focuses on presenting information in a multi-row format for better readability and organization of complex data.

• Auto Timeout (min):

  • Set the time in minutes after which the message will automatically time out.

• Blink Console Item (min):

  • Configure the time in minutes after which the console item will start blinking to indicate the message has been sitting on the console for a certain amount of time. Set to 0 to disable this feature.

• Leave Acknowledged Items on Console (min):

  • Specify how long acknowledged or completed messages will remain visible on the console. This is the duration, in minutes, for which a message stays on the console after it has been acknowledged. Set 0 to disable this and remove the message immediately upon acknowledgment.

• Disappear on:

  • Choose whether the message should disappear on acknowledgment (OnAck) or based on other conditions.

---

Additional Options

• Allow Forwarding:

  • Check this box if you want users to forward the message to other recipients.

• Allow Any User to Acknowledge:

  • Check this box if you want anyone with access to the console to manually acknowledge the message. This means any user, regardless of their specific role or permissions, can acknowledge the message once they have access to the console interface.

• Console Data Field Headers:

  • Specify the headers for the console view, separated by the pipe | symbol. These will appear as columns in the console display.

  Example:

  Alert Level|Patient Name|Sex|DOB|Location|Test|Sent To

---

Customizing Message Formats

Nuntio allows the use of HTML in both the Console Template and Mobile Template. You can use dynamic data placeholders to insert real-time data into the message.

• Dynamic Data Fields:

  • Use {{datafield}} to place dynamic data elements in the template. These fields will be dynamically populated based on the dynamicdata values sent via the HTTP interface.

  Example dynamicdata payload from the HTTP interface:

  {
     "PatientName": "Smith, Nancy",
     "Room": "44",
     "AlertLevel": "Critical"
  }

  In the template, the placeholders would be:

  {{PatientName}}, {{Room}}, {{AlertLevel}}

---

Console Template with Pipe Delimiters

In the Console Template, the columns are separated using the pipe (|) symbol. This allows you to format how multiple pieces of data are displayed in a multi-row view on the console.

Example Console Template:

<h2 style="color:#0032d">
   <span class="icon ion-flag">{{AlertLevel}}</span>
</h2>
{{PatientName}}|{{Sex}}|{{DOB}}|{{Location}}|{{Test}}|{{SentTo}}

In this example:

• The message content is structured with pipe delimiters (|) between dynamic data fields.

• The message will display the following in a multi-column format:

  • Patient Name

  • Sex

  • Date of Birth (DOB)

  • Location

  • Test

  • Sent To

When sent, the values in {{PatientName}}, {{Sex}}, {{DOB}}, etc., will be dynamically replaced with actual data from the HTTP interface. The | symbol ensures that each piece of data appears in its own column on the console, improving readability.

---

Mobile Template

In the Mobile Template, you can customize how messages will appear on mobile devices.

Example Mobile Template:

<div style="text-align:center;background-color:red;color:white;">
   IMAGING {{AlertName}}
</div>
<div style="color:black;font-size:large;">
   {{PatientName}} ({{Sex}}) DOB: {{DOB}} - {{Room}}
</div>
<div style="font-size:small;">
   {{Test}}<br>Read at {{ReviewedTime}}
</div>

In this example:

• The message is formatted with background colors, font sizes, and other styling options that suit mobile screens.

• Dynamic data like PatientName, Room, and ReviewedTime is inserted into the message using placeholders.

---

Saving the Template

1. After customizing the template:

   • Click Save to apply the changes.

   • You can also choose to Cancel to discard the changes.

---

Dynamic Data Fields

The dynamic data fields used in the message templates are based on the dynamicdata values sent via the HTTP interface. Here are some commonly used dynamic fields:

• {{PatientName}}: The name of the patient.

• {{Room}}: The room number or location of the patient.

• {{AlertLevel}}: The severity or type of alert.

• {{Test}}: The specific test or action needed.

• {{TargetMD}}: The targeted doctor or medical professional for the alert.

You can define more custom data fields in your message payload, which will be automatically inserted into the template when the message is sent.