Prototype

EVENT_INSERT(EVENT_CODE, [DATE_TIME], [CONDITION], [TASK_ID], [ASSIGNTO_TEAM], 
   [ASSIGNTO_ROLE], [ASSIGNTO_USER], [OPENING_REMARKS], [PRIORITY], 
   [SENT_BY_SESSION], [NOTIFY_BY], [NOTIFY_ADDRESS], [INSERT_CLOSED])

This formula inserts a EVENT OBJECT in the current ADMISSION.

The EVENT will not be inserted if already exists another open EVENT with the same EVENT_TYPE in the same date for the ADMISSION to which the EVENT refers.

Depending on the EVENT TYPE and system configuration , a notification will be sent to the assigned person/team. See EVENT NOTIFICATIONS

Parameters	Type	Default	Required	Description	Default
EVENT_CODE	String		Yes	Code of the EVENT to be inserted. It can be a predefined EVENT CODE (see EVENT OBJECT) or a custom code. In the latter case, an EVENT TEMPLATE with that code will be searched in the LIBRARY and if found, the new EVENT generated will be cloned from the template. Otherwise a completely new EVENT will be created
DATE_TIME	Datetime	NULL	No	Parameter to define when the EVENT should be inserted. The following date expressions are supported: Date-time formatted string (dd/mm/yyyy hh:mm) “NOW” "MONDAY" .. "SUNDAY": The name of a week's day. The date assigned to the EVENT will be the first specified day after the current date (i.e. if today is thursday and we request to insert the event on MONDAY, it will be inserted on next week's MONDAY).	NOW
CONDITION	Boolean	true	No	Condition to satisfy in order to execute the EVENT_INSERT.	1
TASK_ID	Number			ID of task that will be linked to the EVENT. Obtained from "answer" field from a TASK_INSERT (). The link between the TASK and the EVENT is a 'soft link', what means that if the EVENT is deleted, the TASK will not be deleted because it is not considered part of the EVENT.
ASSIGNTO_TEAM	String	NULL	No	Specify which will be the TEAM_CODE in the field “ASSIGN_TO” of the EVENT and the USER who will receive the notification. See Assignation considerations below for more information about EVENT assignation
ASSIGNTO_ROLE	Number	NULL	No	Specify which will be the ROLE in the field “ASSIGN_TO” of the EVENT (type int). See Assignation considerations below for more information about EVENT assignation
ASSIGNTO_USER	String/Number	NULL	No	User assigned to the EVENT by default. This value can be: An string representing a USERNAME A numeric expression representing a USER reference See Assignation considerations below for more information about EVENT assignation
OPENING_REMARKS	String	NULL	No	Text that will appear as “Opening remarks” in the EVENT and in the NOTIFICATION (It should support formulas).
PRIORITY	String	NULL	No	Priority for inserted event. Supported values: "NULL" or empty: No priority assigned to the EVENT "LOW": Introduced in API Version 2.7.24 "MEDIUM" "HIGH"
SENT_BY_SESSION	Boolean	true	No	(true/false. default = true): This property defines who will appear as "creator" of the EVENT. If TRUE, the creator will be the active session user. Otherwise, the creator will be the system (not a USER) and the EVENT will not belong to any user (so, cannot be edited or deleted manually). Anyway, the issuer will always be the session user. This option should be used with care, and ensuring that at least the EVENT is assigned to any ROLE, TEAM or USER because otherwise it will not be seen by anyone.
NOTIFY_BY	String	NULL	No	If provided, a communication will be sent after the EVENT is inserted. This parameter specifies the channel by which the notification will be sent. Accepted values are: "SMS" "EMAIL"
NOTIFY_ADDRESS	String	NULL	No	If NOTIFY_BY has a valid value, then the notification will be sent using the address specified in this field. Depending not eh value of NOTIFY_BY: "EMAIL": NOTIFY_ADDRESS should take a valid email address (e.g. 'johndoe@mail.com") "SMS": NOTIFY_ADDRESS should take a complete phone number including country prefix (e.g. "+34678876543")
INSERT_CLOSED	Boolean	false	No	If true, the EVENT will be closed immediately after insertion

Return value

Type	Description
Number	Returns a reference to the EVENT inserted

Comments

An EVENT inserted with this FORMULA will always belong to an ADMISSION (which is known from the context in which the FORMULA is executed)

Note that this FORMULA will send a notification to ASSIGNTO_USER if the following circumstances are true:

The EVENT has been assigned to a USER
The USER has indicated in his preferences that he wants to receive notifications by some communication channel (email, SMS...)
The USER profile contains at least one channel of the type informed in USER's preferences

Execution

On closing the form. The ITEM containing this FORMULA must be defined as type 'ACTION' (which are always executed when a FORM is closed)

Examples

Formula	Description
EVENT_INSERT("EVENT_SOCIAL","2014-08-30")	A new EVENT of the predefined type "SOCIAL" will be created and the date will be set to "2014-08-30"
EVENT_INSERT("MY_CUSTOM_CODE","2014-08-30")	A new EVENT created from a custom EVENT TEMPLATE with TASK_CODE="MY_CUSTOM_CODE" will be inserted, the date will be set to "2014-08-30"
EVENT_INSERT($1,$2)	A new EVENT with an EVENT CODE obtained from ITEM $1 will be created and the date will be set to the value obtained from ITEM $2
EVENT_INSERT("EVENT_SOCIAL","2014-08-30",1)	A new EVENT of the predefined type "SOCIAL" will be created and the date will be set to "2014-08-30". The condition is 1, so the EVENT will always be created
EVENT_INSERT("EVENT_SOCIAL","2014-08-30",$1)	A new EVENT of the predefined type "SOCIAL" will be created and the date will be set to "2014-08-30". The condition depends on the value of ITEM $1, so the EVENT will only be created if that value is evaluated to be "true"
EVENT_INSERT(EVENT_TECH, NOW,$19,, "PROACTIVE", 24, ,"Stepcounter battery level below 30%. The patient should charge it", "HIGH")	A new EVENT of the predefined type "TECH" will be created and the date will be set to the current date time when the FORMULA is executed. Additionally, the new EVENT will be assigned to TEAM "PROACTIVE" with role 24 ("Case Manager") The priority will be set to 'HIGH'

Event assignation considerations

An EVENT can be assigned to:

ROLE
ROLE and TEAM: It is not possible to assign an EVENT to a TEAM without specifying a ROLE
ROLE, TEAM and USER: It is not possible to assign an EVENT to a USER without specifying a TEAM and ROLE. Nevertheless it is allowed to leave the ASSIGNTO_TEAM parameter empty if it is possible to infer the TEAM from the ASSIGNTO_USER and ASSIGNTO_ROLE as explained below

ASSIGNTO_TEAM inference

As it was explained before, and EVENT inserted using EVENT_INSERT() always belongs to an ADMISSION, which was created for a specific SUBSCRIPTION.

When invoking EVENT_INSERT() specifying values for ASSIGNTO_USER and ASSIGNTO_ROLE parameters, but leaving ASSIGNTO_TEAM empty, the system will try to infer the TEAM inspecting the SUBSCRIPTION members using the following RULES:

If ASSIGNTO_USER is direct member of the SUBSCRIPTION with the ROLE indicated in ASSIGNTO_ROLE, then the TEAM OWNER of the SUBSCRIPTION will be used as ASSIGNTO_TEAM
If ASSIGNTO_USER has ASSIGNTO_ROLE in a TEAM that is member of the SUBSCRIPTION with ASSIGNTO_ROLE, then it will be used as ASSIGNTO_TEAM

If no valid TEAM is found, then the inserted TASK will only be assigned to the specified ROLE

NOTIFICATIONS and COMMUNICATIONS sent by EVENTS

When an EVENT is created, it may send automatically a NOTIFICATION or COMMUNICATION by email or SMS. The difference between them is the following:

NOTIFICATIONS: are generated when the EVENT has been assigned to a USER or TEAM. In this cases, the preferences of the destination USER/TEAM will determine if he wants to receive a notification about the new EVENT and also which channel should be used (email or SMS). The destination address is obtained from the profile of the destination USER/TEM
COMMUNICATIONS: Are regular emails or SMS that must be sent independently of the preferences of the destination user. In this case a specific destination address must be provided manually.

NOTIFICATIONS are sent when the EVENT is assigned to a TEAM or USER, and the parameters NOTIFY_BY and NOTIFY_ADDRESS are empty.

COMMUNICATIONS are sent when EVENT_INSERT() is invoked specifying a NOTIFY_BY and NOTIFY_ADDRESS parameters. It does not matter whether the EVENT has been assigned to someone or not. The destination address will always be the one provided

Language used in NOTIFICATIONS and COMMUNICATIONS

The system always tries to send the messages translated to the preferred language of the destination user.

In the case of COMMUNICATIONS, the destination may be a person that is not a user of the platform, so it is not possible to know the appropriate language that should be used. Nevertheless, when EVENT_INSERT() is executed, it will try to locate an existing user with the destination address (email or phone), and if found, the language of that user will be used (since API version 2.7.20)

Browser not supported