A TASK is a set of required actions to implement by a Linkcare actors or the system and planned in a given date.

A TASK is created from the combination of the 2 following objects:

TASK TEMPLATE OBJECT: The properties of the TASK TEMPLATE will be replicated in the TASK OBJECT when it is created
WORKPLAN OBJECT: Schedule information associated to a TASK TEMPLATE OBJECT that will be copied in the new TASK OBJECT

TASK PROPERTIES:

PROPERTY	NAME	TYPE	DESCRIPTION	COMMENTS
REF	Reference	TEXT	Reference of the task
REFS	References	PROPERTY SET		See "TASK REFERENCES" for details.
DESC	Description	TEXT	Description of the task in the current language
NAME	Name	TEXT	Name of the task
MODIFIED	Modified	PROPERTY SET		See "TASK MODIFIED" for details.
ASSIGNMENTS	Assignments	ARRAY OF PROPERTY SET	List of roles of the task with the users that can modify the task	See "TASK ASSIGNMENTS" for details.
TYPE	Type	TEXT	Type of the task. In general this property is only informative and has no special meaning for the API, except for the case of the "SYS" type. TASKS with type = "SYS" are always hidden for the users (professionals or patients) and are only visible to users with role "service". Therefore, the API functions user_get_task_list () and case_get_task_list () will ignore them unless the active role is "service"	Possible values: CASE: Task assigned to a CASE CALL TELE CARE: Task assigned to a PROFESSIONAL SYS EDU: EDUCATIONAL TASKS (Introduced in API Version 2.7.25)
CLASS	Class	TEXT	Determines if it's a system task or a member task	Possible values: PRO_TASK or SYS_TASK
CATEGORY	Category	#TASK:CATEGORY:ID	Category assigned to the task	See "TASK CATEGORY CODE" for details
DATE	Date of task	DATE	Date of the task	Format: YYYY-MM-DD. If the task is PENDING, is the planning date-hour. If the task is DONE, is the last modify date-hour.
HOUR	Hour of task	HOUR	Hour of the task	Format: HH:MM:SS. If the task is PENDING, is the planning date-hour. If the task is DONE, is the last modify date-hour.
UNSCHEDULED	Unscheduled	BOOLEAN	Introduced in API Version 2.7.25 Indicates whether the TASK is not scheduled for a specific time. Unscheduled TASKS can be done at any time of the day. When this property is true, the HOUR is ignored
DURATION	Duration	TEXT	Prevision of the duration of the task
EXPIRATION	Expiration	TEXT	Introduced in API Version 2.7.21 Represents a period after which a TASK created from this WORKPLAN should expire if the TASK hasn't been closed. Expired TASKs will be cancelled automatically by a system daemon. Expiration values are formed by a number and a time unit. For example "2 days". The allowed units are: MINUTES: the TASK will be cancelled if its has not been closed within the specified number of minutes since its scheduled date. HOURS: the TASK will be cancelled if its has not been closed within the specified number of hours since its scheduled date. DAYS: the TASK will be cancelled if its has not been closed within the specified number of days since its scheduled date. NOTE: the scheduled time is not taken into account. For example, if the TASK is scheduled for 2021-09-15 15:00:00 and the expiration is "1 DAYS", then the TASK will consider to be expired at 2021-09-16 00:00:00 (i.e. it must be completed in the day it was scheduled) WEEKS: the TASK will be cancelled if its has not been closed within the specified number of weeks (7 days) since its scheduled date. NOTE: the scheduled time is not taken into account. For example, if the TASK is scheduled for 2021-09-15 15:00:00 and the expiration is "1 WEEKS", then the TASK will consider to be expired at 2021-09-22 00:00:00 MONTHS: the TASK will be cancelled if its has not been closed within the specified number of weeks (30/31 days) since its scheduled date. NOTE: the scheduled time is not taken into account. For example, if the TASK is scheduled for 2021-09-15 15:00:00 and the expiration is "1 MONTHS", then the TASK will consider to be expired at 2021-10-15 00:00:00 YEARS: the TASK will be cancelled if its has not been closed within the specified number of years (365/366 days) since its scheduled date. NOTE: the scheduled time is not taken into account. For example, if the TASK is scheduled for 2021-09-15 15:00:00 and the expiration is "1 WEEKS", then the TASK will consider to be expired at 2022-09-15 00:00:00
FOLLREP	Follow report	BOOLEAN	Determines if the task is included in the follow up report.	Possible values: Y or N
STATUS	Status	#TASK:STATUS:ID	Determines if the task is done or pending.	See TASK STATUS OBJECT
ADMREF	Reference of the admission
CASEREF	Reference to the case of the admission
FORMS	Forms	PROPERTY SET	Lists of forms of the task
DOCSREF	Document referenced		Reference of the document linked to the task
EDIT	Editable	BOOLEAN	Determines if the task is editable by Professional	Possible values: True or False
DELETE	Deleted	#TRASH:ID	Key to relate the TASK deleted with the entry in TRASH table
CREATOR	Creator	#TASK:REF	Reference to the TASK or ACTIVITY that created this TASK if ANY
FREQUENCY	Frequency	TEXT	Defines if the TASK must be executed only once or it will be repeated recursively. The value of this property determines the frequency of repetition. See WORKPLAN FREQUENCY for extended information
RECURSIVE_MODE	Recursive mode	TEXT	This property only has effect if #TASK:FREQUENCY has a value that determines if the TASK will be repeated periodically. The value of this property determines when and how the recursively of the TASK will be applied See RECURSIVE MODES
EXPIRATION	Expiration	TEXT	String representing the validity period of a TASK (e.g. "1 day"). If the TASK is still open after the period defined in this property (counting from the DATE / HOUR of assigned to the TASK), then it must be considered expired, and the status set to "CANCELED' A null value means that a TASK never expires
EXPIRED	Expiration date	DATE	Date when the TASK expired. A TASK is considered expired if it was not closed in the validity period
EDUCATIONAL	Educational	INT	Indicates that the TASK is marked as an EDUCATIONAL TASK. The value of this property is set to 1 when creating an instance of a TASK TEMPLATE OBJECT that has type = "EDU". Possible values are: 0: Not an EDUCATIONAL TASK 1: EDUCATIONAL TASK available for the CASE 2: EDUCATIONAL TASK already reviewed by the CASE The value of the property changes from 1 to 2 when the EDUCATIONAL TASK is interactive and is completed by the patient.	Introduced in API Version 2.7.25

TASK REFERENCES:

PROPERTY	NAME	TYPE	DESCRIPTION	COMMENTS
#TASK:REFS:TASKCODE	Task code	TEXT	Task code reference
#TASK:REFS:ACTIVITY	Original Activity	TEXT	Activity_id of the original task template
#TASK:REFS:NEXT:REF	Next Task reference code	TEXT	Next Task reference code
#TASK:REFS:NEXT:STATUS	Next Task status	TEXT	Next task possible status	Possible values: DONE or PENDING
#TASK:REFS:PREV:REF	Previous Task reference code	TEXT	Previous Task reference code
#TASK:REFS:PREV:STATUS	Previous Task status	TEXT	Previous Task possible status	Possible values: DONE or PENDING

TASK MODIFIED:

PROPERTY	NAME	TYPE	DESCRIPTION	COMMENTS
#TASK:MODIFIED:DATE	Date	DATE	Date of last modification.	Format: YYYY-MM-DD
#TASK:MODIFIED:HOUR	Hour	TIME	Hour of last modification.	Format :HH:MM:SS
#TASK:MODIFIED:USER:ID	IdUser	TEXT	Id of the user who last modified
#TASK:MODIFIED:USER:NICK	User nick	TEXT	Nickname of the user who last modified
#TASK:MODIFIED:USER:NAME	User name	TEXT	Complete name of the user who last modified

TASK ASSIGNMENTS:

PROPERTY	NAME	TYPE	DESCRIPTION
#TASK:ASSIGNMENTS:ROLE:ID	Role id	TEXT	Role identification
#TASK:ASSIGNMENTS:ROLE:DESC	Role Description	TEXT	Role description in the session language
#TASK:ASSIGNMENTS:USER:ID	IdUser	TEXT	Id of the user who last modified
#TASK:ASSIGNMENTS:USER:NICK	User nick	TEXT	Nickname of the user who last modified
#TASK:ASSIGNMENTS:USER:NAME	User name	TEXT	Complete name of the user who last modified

WEB SERVICES:

WS	DESCRIPTION
task_category_list ()	Obtains a list of possible categories of a tasks.
task_open ()	Internal function that called from form_open marks as incomplete a stage task.
task_close ()	Closes a task and check all tasks in the same stage, if all tasks are completed this function completes stage as well.
task_list_overdue ()	Lists overdue tasks of admissions: associated to a team which the current user or team is a case manager are assigned to the current user or team have an associated role but not assigned to any user
† task_insert_with_professional ()	[Deprecated] Inserts a task in an admission in the given date.
task_calendar_month ()	Is a function that returns the days which have the task in status “Not assigned/Assigned not done/Sent/Not sent” and completed tasks and “open” and “closed” events in a given month and year.
task_calendar_year ()	Returns the days which have the task in status “Not assigned/Assigned not done/Sent/Not sent” and completed tasks and “open” and “closed” events in a given year.
task_delete ()	Delete or voids a task in the system. If type is “VOID” only void the task changing the status of the task to “99 – Cancelled” or if type is “DELETE” removes definitively the task
task_form_list ()	Retrieves a list of forms associated in a task
task_get ()	Retrieves all information about a task.
task_insert ()	Inserts a task in an admission in a given date. View more details
task_list_date ()	Lists all tasks and events in a given date. The tasks and the events returned depends of the type: "ADMI": to view all tasks and events of a patient in an admission "CASE": to view all tasks and events from all admissions of a patient ( in the active team of the session) “CALLS”: returns events with CALL type. "USR": returns the AGENDA for this user.
task_list_day_default ()	Is a function that returns the default day which have the older task in status “Not assigned/Assigned not done/Sent/Not sent” or “open” if is an event. If there is not pending task or open event still return the most recent closed event or task completed. If there no task or events at all returns today_date.
task_role_list ()	Obtains a list of possible roles of the task. The assigned_roles input parameter is used to give a list of roles to discard in the output of the function. The category_id defines the role list of the task.
task_set ()	Sets a task in the Linkcare system. The xml of the task can be retrieved by calling the function task_get()
task_user_list ()	Is a function to retrieve a list of users assigned to the role (of the param role_id) assigned in the program too combined with the users with the role assigned to the category. The assigned_users input parameter is used to give a list of users to discard in the output of the function
task_list ()	Lists all tasks and events in a given date (filtered by the filter param).
task_insert_by_task_code ()	Inserts a task with task_code in an admission in a given date. It returns the task_id.
task_team_list ()	Used to show: The list of TEAMS that are members of the subscription to the TASK'S ADMISSION or belongs to the selected role (in the case of the TASK'S is associated with a ADMISSION) or the list of TEAMS that are members of TEAM owner the TASK'S to the selected role if you do not have an associated TASK'S ADMISSION. To this must be added the TEAMS belonging to the professionals who are members of the Subscription of the TASK'S ADMISSION or belongs to the selected role (in case the TASK'S is associated to a ADMISSION) or TEAMS list of professionals who are members of TEAM TASK'S owner with the selected role if you do not have an associated ADMISSION. Team previously associated if there was an associated TEAM TASK'S or TASK (to avoid that if is written off as a member of TEAM SUBSCRIPTION owner or the owner TEAM TASK if that is not associated TASK'S one associated SUBSCRIPTION TEAM "disappear" by pressing the "edit" button
task_get_recursive_types ()	Return types of recursivity (automatic creation on task completion) that could be assigned to task.

Browser not supported