EVENT OBJECT

An EVENT is a communication object that can be used to send messages to other users of the platform or set reminders about TASKs that must be completed

1 EVENT PROPERTIES
- 1.1 PREDEFINED EVENT TYPES
- 1.2 EVENT COMMENTS PROPERTIES
- 1.3 EVENT POSTER PROPERTIES:
- 1.4 EVENT ASSIGNED PROPERTIES:
- 1.5 EVENT MODIFIER PROPERTIES:
- 1.6 EVENT ISSUER PROPERTIES:
- 1.7 EVENT STATUS PROPERTIES:
2 EVENT NOTIFICATIONS
- 2.1 Communication Channels
- 2.2 Notification content
3 WEB SERVICES:

EVENT PROPERTIES

PROPERTY	TYPE	TEXT	COMMENTS

PROPERTY	TYPE	TEXT	COMMENTS
REF	String	Unique reference of the event
TYPE	String	Type of event.	See more in table PREDEFINED EVENT TYPES
STATUS	String	Status of the event	See more in table EVENT STATUS
PRIORITY	String	Defines the priority of an event.	Possible values: "NULL" "LOW": Introduced in API Version 2.7.24 "MEDIUM" "HIGH"
PHONE_POSTER	String	Is the phone number of the event poster.
PHONE	String	Is the phone number of the other interlocutor
CALL_TYPE	String	Defines the direction of communication between phone and phone_poster.	Possible values: IN/OUT/VOID.
ISSUER	PROPERTY SET	Origin person that reports the event	See "EVENT:ISSUER" for details
COMMENTS	[EVENT_COMMENT]	List of comments of the EVENT	See "EVENT:COMMENT" for details
POSTER		Information about the creator of the event	See "EVENT:POSTER" for details.
ASSIGNED		Defines the next person assigned in the workflow of the event.	See "EVENT:ASSIGNED" for details.
MODIFIER		Defines the last person who modified the event.	See "EVENT:MODIFIER" for details.
ADMISSION	ADMISSION OBJECT	Admission object related to the event (if any)	See more in admission_get() function.
CASE	CASE OBJECT (PATIENT)	Case related to the event (if any)
TASKS	[TASK OBJECT ]	List of TASKS related to the event	It's possible to insert TASKS into an event, in two ways: Automatic when the event is inserted: In order to insert automatic forms in when the event is inserted (with the event:type), a task should be defined in the PROGRAM template, in stage: "EVENT" and with a TASK_CODE as: EVENT_CARE, EVENT_SOCIAL... (substitute ":" from event types list for "_"). If no TASK_CODE is provided, the form contained will be inserted in all the event types. Manually through action list: Select "Add activity" in the menu available below the EVENT.
MEMBERS	EVENT_MEMBER	List of people that are participants of the EVENT	Contains information about the "read" status of the EVENT for each of the participants

PREDEFINED EVENT TYPES

TYPE	DESCRIPTION (ID)

TYPE	DESCRIPTION (ID)
^EVENT:SOCIAL	Social
^EVENT:CARE	Health
^EVENT:ADMIN	Administrative
^EVENT:TECH	Monitoring / Technical issue
^{EVENT:ENROLL_REQ}	Enroll request
^{EVENT:OPINION_REQ}	Opinion request
^EVENT:CALL	Call
^{EVENT:TEAM_REQUEST}	Membership request
^{EVENT:TEAM_INVITATION}	Team invitation
^{EVENT:PROGRAM_REQUEST}	Program request
^EVENT:REPORT	Report
^{EVENT:PROFESSIONAL_INVITATION}	Professional invitation
^{EVENT:CASE_INVITATION}	Inclusion of a CASE in an ADMISSION. Used to send a notification to the CASE
^{EVENT:ASSOCIATE_INVITATION}	Invitation sent by a case requesting another person to be his/her associate (a person that will take care of the CASE)

EVENT COMMENTS PROPERTIES

PROPERTY	TYPE	TEXT	COMMENTS

PROPERTY	TYPE	TEXT
ORDER	String	Position of the comment in the list of comments
COMMENT	String	Text of the comment
USER_REF	String	Reference to the USER that placed the comment
DATE	Date	Date when the comment was placed

EVENT POSTER PROPERTIES:

PROPERTY	TYPE	TEXT	COMMENTS

PROPERTY	TYPE	TEXT	COMMENTS
POSTER:ROLE:ID		Role's ID of the poster
POSTER:ROLE:DESC		Description of the role according to active sessions language
POSTER:TEAM		Team of the poster
POSTER:ID		Internal identification of the person who posted the event.
POSTER:NICK		Nickname of the person who posted the event.
POSTER:NAME		Complete name of the person who posted the event.
POSTER:DATE	DATE	Creation date of the event.
POSTER:MINUTES		Duration between the start time of the event and the creation in the system of the event.	See more in elapsed_list() function.

EVENT ASSIGNED PROPERTIES:

PROPERTY	TYPE	TEXT	COMMENTS

PROPERTY	TYPE	TEXT
ASSIGNED:ROLE:ID		Role's ID of the user who got the event assigned.
ASSIGNED:ROLE:DESC		Description of the role according to active sessions language.
ASSIGNED:TEAM		Team who got the event assigned.
ASSIGNED:ID		Internal identification of the person who got the event assigned.
ASSIGNED:NICK		Nickname of the person who got the event assigned.
ASSIGNED:NAME		Complete name of the person who got the event assigned.
ASSIGNED:DATE	DATE	Assignment date.
ASSIGNED:MINUTES		???

EVENT MODIFIER PROPERTIES:

PROPERTY	NAME	TYPE	TEXT	COMMENTS

PROPERTY	NAME	TEXT
MODIFIER:DATE	Modification date	Date when the event has been last modified.
MODIFIER:HOUR	Modification hour	Hour when the event has been last modified.
MODIFIER:USER:ID	Id of the last modifier	Internal identification of the last modified the event.
MODIFIER:USER:NICK	Modifier's nickname	Nickname of the person who last modified the event.
MODIFIER:USER:NAME	Modifier's complete name	Complete name of the person who last modified the event.

EVENT ISSUER PROPERTIES:

PROPERTY	TYPE	TEXT	COMMENTS

PROPERTY	TYPE	TEXT	COMMENTS
ISSUER:TYPE	TEXT	Indicates who posted the issue.	Possible values: POSTER /CASE / OTHER
ISSUER:PHONE		The phone number that created the event issue.
ISSUER:USER:ID		Internal identification of the issuer.	If the issuer is POSTER or OTHER this tag show the contact information
ISSUER:USER:NICK		Nickname of the issuer.	If the issuer is POSTER or OTHER this tag show the contact information
ISSUER:USER:NAME		Complete name of the issuer.	If the issuer is POSTER or OTHER this tag show the contact information

EVENT STATUS PROPERTIES:

An EVENT can have one of the following status:

VALUE	DESCRIPTION

VALUE	DESCRIPTION
OPEN	The EVENT is still active and more messages can be appended
CLOSED	The EVENT is closed. It is not possible to append further comments nor modify the properties of the EVENT
PENDING	Used with of the INVITATION Event types: EVENT:TEAM_REQUEST EVENT:TEAM_INVITATION EVENT:PROGRAM_REQUEST Indicates that the invitation is pending to be accepted
REJECTED	Used with of the INVITATION Event types: EVENT:TEAM_REQUEST EVENT:TEAM_INVITATION EVENT:PROGRAM_REQUEST Indicates that the invitation has been rejected
ACCEPTED	Used with of the INVITATION Event types: EVENT:TEAM_REQUEST EVENT:TEAM_INVITATION EVENT:PROGRAM_REQUEST Indicates that the invitation ha been accepted
RESEND	Used with of the INVITATION Event types: EVENT:TEAM_REQUEST EVENT:TEAM_INVITATION EVENT:PROGRAM_REQUEST Indicates that the invitation has been resent
Cancel	Used with of the INVITATION Event types: EVENT:TEAM_REQUEST EVENT:TEAM_INVITATION EVENT:PROGRAM_REQUEST Indicates that the invitation has been canceled by the inviter

EVENT NOTIFICATIONS

A Notification is a message sent through a communication channel (email, SMS, etc.).

In some circumstances, the system sends automatically a notification to the user assigned to the EVENT:

The EVENT is created (at least one comment must be set). The notification is only sent if the EVENT is assigned to a specific USER (there will be no notification if it is assigned only to a ROLE or ROLE/TEAM)
A new comment has been added to the EVENT. The notification will be sent to all the participants of the EVENT
The EVENT assignment is changed to a different user

Communication Channels

The communication channels used to send a notification depend on the following factors:

The communication channels defined in the target user profile (email, phone, etc)
The preferences of the user: each user can define which communication channels can be used to send his notifications

The default configuration for notifications is set in WEB SERVICES CONFIGURATION into the $GLOBALS['NOTIFICATIONS'] parameter. When a USER is created, the default configuration is stored in his preferences, but they can be modified using the API functions user_set (), case_set ().

Notification content

The content of the message depends on the type of EVENT and the communication channel used. See MESSAGE CODE for more information about the content of the notifications.

WEB SERVICES:

WS	DESCRIPTION

WS	DESCRIPTION
event_action_list ()	Returns a list of possible choices related with an event
event_list_pending ()	Lists all pending events that have been posted by the active user or are assigned to the active user.
event_user_list ()	Retrieves a list of users if the current session’s active center. If a certain role or program is defined the list will only include users with the specified role and program.
event_delete ()	Delete an event in the Linkcare Internal System.
event_form_list ()	Returns a list of forms associated to an Event.
event_get ()	Retrieves all information about an event
event_insert ()	Inserts an event into a case.
event_issuer_list ()	Retrieves a list of possible issuers from the issuers field shown in the event tab screen.
event_role_list ()	Retrieves a list of possible roles of the event. If the type is ASSIGNED show the roles for the assigned_to field in the event tab. The same occurs for the POSTED type.
event_set ()	Sets all information to an event.
event_task_list ()	Retrieves a list of tasks associated to an event.
event_template_list ()	Retrieves a list of forms or/and templates associated to an event
event_type ()	Lists possible event types. If the sessions current user’s role is System Manager it will return all the language descriptions. Otherwise, it will return the descriptions in the session’s active language
event_admission_list ()	Lists all the admissions of a case that the event's team has access to. If the ADMISSION's TEAM owner have other TEAMS as members (with Staff, Case Manager or Coordinator roles); Those TEAMS can see the admissions also.
event_team_list ()	Used to show the list of TEAMS that : are members of the subscription to the EVENT ADMISSION with the selected role the list of TEAMS that are members of TEAM owner of the EVENT with selected role if you do not have an associated EVENT ADMISSION. TEAMS belonging to the professionals who are members of the Subscription of the EVENT ADMISSION with the selected role (in case the EVENT is associated to a ADMISSION) TEAM list of professionals who are members of TEAM owner of the EVENT with the selected role if you do not have an associated ADMISSION. Team previously associated if there was an associated TEAM EVENT (to avoid that if is written off as a member of TEAM SUBSCRIPTION owner or the owner TEAM EVENT if that is not associated EVENT one associated SUBSCRIPTION TEAM "disappear" by pressing the "edit" button)

Linkcare Server WS API