#CODE:ID_STANDARD_CODE

#MESSAGE

#CODE:ID_CODE

e.g. "ACCOUNT.PASSWORD_RESET.EMAIL.SUBJECT"

#CODE:ID_LANGUAGE

"ES"|"IT"|"EN"

Available languages....

#CODE:CODE_DESCRIPTION

 Description of ID_CODE (e.g. "Account password reset")

Communication message #CODE:ID_CODE

In order to reset your password use this code: {{reset_token}}

In order to reset your password use this code: 988766

We have used the reset_token variable in the template. This variable is replaced by the platform with corresponding token value. 

{% if name %}
<p>Dear {{ name }},</p>
<p></p>
{% endif %}
<p>You have requested to have your password reset for your account.</p>
<p></p>
<p>Please visit this url to reset your password. </p>
<p></p>
<p>{{ reset_password_url }}</p>
<p></p>

<p>Dear John Martin,</p>
<p></p>
<p>You have requested to have your password reset for your account.</p>
<p></p>
<p>Please visit this url to reset your password. </p>
<p></p>
<p>https://www.linkcareapp.com/password</p>
<p></p>

This is a more complex example where apart of using variables name and reset_password_url, TWIG scripting has been used format the message depending on the existence of the name variable. If it is defined, then a greeting heading will be included.

EMAIL

• SUBJECT

• BODY

The content of the BODY of an email accepts HTML.

SMS

Must be plain text.

PUSH_NOTIFICATION

• SUBJECT

• BODY

Must be plain text.

WEBALERT

• SUBJECT

• BODY

Accepts HTML.

Web alerts are sent to those clients that have subscribed to the alert service (see alert_subscribe () API function)

Introduced in API version 2.7.15

HIS

• BODY

Accepts HTML.

Messages sent to users that have been imported from one external HIS using the interoperability capabilities

Introduced in API version 2.7.30

Predefined variables FOR TWIG scripting

name

Name of the person to whom the message is sent

ACCOUNT.SEND_CODE

ACCOUNT.PASSWORD_RESET

ACCOUNT.SEND_CODE

code

Code used to validate user accounts

ACCOUNT.SEND_CODE

poster

name of the person sending the request

ASSOCIATE.INVITATION.

reset_password_url

LC2 link to reset the password

ACCOUNT.PASSWORD_RESET

reset_token

Token required by the platform to reset the password

ACCOUNT.PASSWORD_RESET

url

The URL value depends on the type notification

ACCOUNT.SEND_CODE

ASSOCIATE.INVITATION.

ACCOUNT.PASSWORD_RESET

*.EMAIL.SUBJECT

Account password reset

Message sent when a user requests a password reset for his ACCOUNT.

API functions involved:

• session_password_reset()

*.EMAIL.BODY

{% if name %}
<p>Dear {{ name }},</p>
<p></p>
{% endif %}
<p>You have requested to have your password reset for your account.</p>
<p></p>
<p>Please visit this url to reset your password. </p>
<p></p>
<p>{{ reset_password_url }}</p>
<p></p>
<p>If you received this email in error, you can safely ignore this email.</p>

*.SMS

In order to reset your password use this code: {{ reset_token }}

ACCOUNT.SEND_CODE

*.EMAIL.SUBJECT

Use the following code to validate your new account: {{ code }}

Message sent when a user creates a new ACCOUNT to indicate the validation code

API functions involved:

• account_create()

• account_send_code()

*.EMAIL.BODY

{% if name %}
<p>Dear {{ name }},</p>
<p></p>
{% endif %}
<p>Use the following code to validate your account: {{ code }}</p>
<p></p>
<p>Please visit this url to validate the account:</p>
<p></p>
<p>{{ url }}</p>
<p></p>
<p>If you received this email in error, you can safely ignore this email.</p>

*.SMS

Use the following code to validate your new account: {{ code }}

Predefined variables FOR TWIG scripting

event_type

description of the EVENT type. In customized EVENTS it is the name of the EVENT TEMPLATE

All EVENT messages

event_url

hyperlink to the EVENT in LC2

All EVENT messages

opening_remarks

Text of the first message that is included in the EVENT

All EVENT messages

poster

name of the person sending the request

All EVENT messages

issuer

name of the issuer of the request

All EVENT messages

program

Name of the PROGRAM. Used in EVENTS that are bound to a PROGRAM

All EVENT messages

requester_team

name of the TEAM sending the request

All EVENT messages

target

name of the person to which the request is addressed

All EVENT messages

target_team

name of the TEAM to which the message is addressed

All EVENT messages

task_url

Used in EVENTS that are bound to a TASK. For example, an EVENT of type REPORT are usually bound to a TASK that contains a REPORT.

The TASK to which the EVENT is referred is defined as a parameter in FORMULA EVENT_INSERT()

All EVENT messages.

url

The URL value depends on the type EVENT:

• EVENT.TEAM_REQUEST: hyperlink to the Team Administration Dashboard in LC2

• EVENT.TEAM_INVITATION: hyperlink to the Team Administration Dashboard in LC2

• EVENT.PROFESSIONAL_INVITATION: hyperlink to the SIGN_UP screen in LC2

• EVENT.CASE_INVITATION:

  • hyperlink to the SIGN_IN screen in LC2 if the CASE invited already exists

  • hyperlink to the SIGN_UP screen in LC2 if the CASE invited is new

• EVENT.ASSOCIATE_INVITATION:

  • hyperlink to the SIGN_IN screen in LC2 if the ASSOCIATE invited already exists

  • hyperlink to the SIGN_UP screen in LC2 if the ASSOCIATE invited is new

• EVENT.TEAM_REQUEST

• EVENT.TEAM_INVITATION

• EVENT.PROFESSIONAL_INVITATION

• EVENT.CASE_INVITATION

• EVENT.ASSOCIATE_INVITATION

password

A temporary password that can be used by a new User to log in the platform. This variable only has a value when the notification is sent to a user that never logged in the platform before, and allows to sign-up using the temporary password (which will be required to be changed after the first login)

• EVENT.CASE_INVITATION

• EVENT.ASSOCIATE_INVITATION

EVENT:SOCIAL

SOCIAL

Social issue

EVENT:CARE

CARE

Care issue

EVENT:ADMIN

ADMIN

Administrative Issue

EVENT:TECH

TECH

Technical Issue

EVENT:ENROLL_REQ

ENROLL_REQ

Enrollment Request

EVENT:OPINION_REQ

OPINION_REQ

Opinion Request

EVENT:CALL

CALL

Call

EVENT:REPORT

REPORT

Report

EVENT:CASE_INVITATION

CASE_INVITATION

Invitation

EVENT:NEW_CASE_INVITATION

NEW_CASE_INVITATION

Invitation

SOCIAL, CARE, ADMIN, TECH, ENROLL_REQ, OPINION_REQ, CALL

EVENT.*.EMAIL.SUBJECT⁽¹⁾

You have a pending {{ event_type }} notification.

API functions involved:

• event_insert ()

• FORMULA EVENT_INSERT()

• action_exec (): when executing an action for inserting an EVENT. This kind of actions are generally returned by action_list_case (), action_list_user (), action_list_patient ()

EVENT.*.EMAIL.BODY⁽¹⁾

<p>An event has been assigned to you.</p>
<p></p>
<p>{{ opening_remarks }}</p>
<p></p>
<p>Created by {{ poster }}</p>
<p></p>
<p><a href="{{ url }}">{{ url }}</a></p>

EVENT.*.SMS⁽¹⁾

You have a pending {{ event_type }} notification.

EVENT.*.PUSH_NOTIFICATION.SUBJECT⁽¹⁾

You have a new message

EVENT.*.PUSH_NOTIFICATION.BODY⁽¹⁾

{{opening_remarks}}

EVENT.*.WEBALERT.SUBJECT⁽¹⁾⁽²⁾

New notification

EVENT.*.WEBALERT.BODY⁽¹⁾⁽²⁾

{{opening_remarks}}

EVENT.*.HIS.BODY⁽¹⁾⁽³⁾

You have a new message in the PHM: {{opening_remarks}}

EVENT.REPORT

*.EMAIL.SUBJECT

You have a new report available

API functions involved:

• event_insert ()

• FORMULA EVENT_INSERT()

*.EMAIL.BODY

<p>You have a new report available.</p><br/><p>{{ opening_remarks }}</p><p><a href="{{event_url}}">Click here to access the report</a></p>

*.SMS

You have a new report available

*.PUSH_NOTIFICATION.SUBJECT

You have a new report available

*.PUSH_NOTIFICATION.BODY

{{opening_remarks}}

*.WEBALERT.SUBJECT⁽²⁾

You have a new report available

*.WEBALERT.BODY⁽²⁾

{{opening_remarks}}

*.HIS.BODY⁽³⁾

A new report is available for you in the PHM. Open your “medical records” section form you PHM to find your new report.

CASE_INVITATION

EVENT.CASE_INVITATION.EMAIL.SUBJECT

You have been invited to participate in {{program}} platform

API functions involved:

• event_insert ()

• FORMULA EVENT_INSERT()

This message is sent when an invitation is sent to an existing CASE (one that already existed in the platform and can sign-in with his account)

EVENT.CASE_INVITATION.EMAIL.BODY

<p>{{target}}, ha estat invitat participar a la plataforma {{program}}</p>{% if opening_remarks %}<p style="white-space:pre-wrap;">{{opening_remarks}}</p><p></p>{% endif %}<p><a href="{{url}}">Veure l'invitació</a></p>

EVENT.CASE_INVITATION.SMS

{% if target != "" %} {{target}}, you {% else %} You {% endif %}have been invited to participate in {{program}} platform. View the invitation: {{url}}

EVENT.CASE_INVITATION.WEBALERT.SUBJECT

Invitation for accessing {{program}} platform

EVENT.CASE_INVITATION.WEBALERT.BODY

You have been invited to participate in {{program}} platform. {% if opening_remarks %}{{opening_remarks}}{% endif %}

EVENT.CASE_INVITATION.AIMED.BODY⁽³⁾

You have been invited to participate to the {{program}} care plan in the PHM

NEW_CASE_INVITATION

EVENT.NEW_CASE_INVITATION.EMAIL.SUBJECT

You have been invited to participate in {{program}} platform

API functions involved:

• event_insert ()

• FORMULA EVENT_INSERT()

This message is sent when an invitation is sent to a new CASE (one that didn't exist in the platform and must sign-up)

EVENT.NEW_CASE_INVITATION.EMAIL.BODY

<p>{{target}}, you have been invited to participate in {{program}} platform</p>{% if opening_remarks %}<p style="white-space:pre-wrap;">{{opening_remarks}}</p><p></p>{% endif %}<p><a href="{{url}}">View the invitation</a></p>

EVENT.NEW_CASE_INVITATION.SMS

{% if target != "" %} {{target}}, you {% else %} You {% endif %}have been invited to participate in {{program}} platform. View the invitation: {{url}}

EVENT.NEW_CASE_INVITATION.WEBALERT.SUBJECT

Invitation for accessing {{program}} platform

EVENT.NEW_CASE_INVITATION.WEBALERT.BODY

You have been invited to participate in {{program}} platform. {% if opening_remarks %}{{opening_remarks}}{% endif %}

EVENT.NOTIFICATION

*.EMAIL.SUBJECT

You have a pending {{ event_type }} notification.

API functions involved:

• FORMULA EVENT_INSERT()

• action_exec (): when executing an action for inserting an EVENT. This kind of actions are generally returned by action_list_case (), action_list_user (), action_list_patient ()

*.EMAIL.BODY

<p>An event has been assigned to you.</p>
<p></p>
<p>{{ opening_remarks }}</p>
<p></p>
<p>Created by {{ poster }}</p>
<p></p>
<p><a href="{{ event_url }}">{{ event_url }}</a></p>

*.SMS

You have a pending {{ event_type }} notification.

*.PUSH_NOTIFICATION.SUBJECT

You have a pending {{ event_type }} notification.

*.PUSH_NOTIFICATION.BODY

{{opening_remarks}}

*.WEBALERT.SUBJECT⁽¹⁾

New notification

*.WEBALERT.BODY⁽¹⁾

<p>An event has been assigned to you.</p><br/><p style="white-space:pre-wrap;">{{ opening_remarks }}</p>

*.HIS.BODY⁽²⁾

You have a new message in the PHM: {{opening_remarks}}

EVENT.EMAIL.SUBJECT

{{ event_type }}

EVENT.EMAIL.BODY

<p>{{ opening_remarks }}</p>

EVENT.SMS

{{ opening_remarks }}

EVENT.PUSH_NOTIFICATION.SUBJECT

{{ event_type }}

EVENT.PUSH_NOTIFICATION.BODY

{{opening_remarks}}

EVENT.WEBALERT.SUBJECT⁽¹⁾

New notification

EVENT.WEBALERT.BODY⁽¹⁾

{{ opening_remarks }}

EVENT.HIS.BODY⁽²⁾

{{ opening_remarks }}

EVENT:TEAM_REQUEST

TEAM_REQUEST

Team Request

EVENT:TEAM_INVITATION

TEAM_INVITATION

Team Invitation

EVENT:PROFESSIONAL_INVITATION

PROFESSIONAL_INIVITATION

Professional Invitation

EVENT:ASSOCIATE_INVITATION

ASSOCIATE_INVITATION

Invitation

TEAM_REQUEST

*.SMS

Membership in team {{ target_team }} requested by {{ requester_team }}

Used when a TEAM sends a request to become member of a TEAM

API functions involved:

• action_exec (): when executing an action for requesting membership in a TEAM. This kind of actions are generally returned by team_action_list ()

*.EMAIL.SUBJECT

Membership in team {{ target_team }} requested by {{ requester_team }}

*.EMAIL.BODY

<p>{{ requester_team }} has sent a request to join the TEAM "{{ target_team }}" administered by you</p>

<p>Please visit your Team Administration Dashboard to manage the request</p>

<p>{{ opening_remarks }}</p>

TEAM_INVITATION

*.SMS

{{target_team}} has been invited to join the team {{requester_team}}

Used when sending an invitation to a TEAM to join another TEAM

API functions involved:

• team_team_insert()

• action_exec (): when executing an action for inviting a TEAM. This kind of actions are generally returned by team_action_list ()

*.EMAIL.SUBJECT

{{target_team}} has been invited to join the team {{requester_team}}

*.EMAIL.BODY

<p>{{target_team}} has received an invitation to join the team {{requester_team}}.</p>

<p>You are receiving this mail because you are administrator of team {{target_team}}<p>

<p>Please visit your Team Administration Dashboard to manage the invitation</p><p>{{opening_remarks}}</p>

PROFESSIONAL_INVITATION

*.SMS

You have been invited to join the team {{requester_team}}

Used when sending an invitation to a PROFESSIONAL to join a TEAM

API functions involved:

• team_user_insert ()

• action_exec (): when executing an action for inviting a PROFESSIONAL. This kind of actions are generally returned by team_action_list ()

*.EMAIL.SUBJECT

You have been invited to join the team {{requester_team}}

*.EMAIL.BODY

<p>You have received an invitation to join the team {{requester_team}}.</p><p><a href="{{url}}">Ver la invitación</a></p>

ASSOCIATE_INVITATION

*.EMAIL.SUBJECT

{{ poster }} has sent a request to be cared by you

API functions involved:

• case_insert_associate()

• associate_set_contact(): When a previous invitation has been sent, not yet responded and the email address of the associate is modified

This message is sent when an invitation is sent to an existing ASSOCIATE (one that already existed in the platform and can sign-in with his account)

*.EMAIL.BODY

<p>{{ poster }} has sent a request to be cared by you</p>
<p></p>
<p><a href="{{ url }}">View the invitation</a></p>