/
library_program_task_get ()

library_program_task_get ()

Owned by David Gaya (Unlicensed)
Function prototype

library_program_task_get (session, task)

API VersionAll

Returns details of one task of workplan with stage, program and protocol information.



Input

  • session: Session
  • task: id of the library task (composed with program, protocol and LC1 task_id)

Output

result: XML

  • permissions: Introduced in API Version 2.7.23
    • edit: (true/false) Indicates if this Task Template is editable
    • clone: (true/false) Indicates if this Task Template is clonable to generate a new version (only true when the Task Template comes from another Program version or from the Carepedia Library)
    • delete: (true/false) Indicates if this Task Template can be deleted
  • workplan: properties of the TASK's WORKPLAN
    • frequency: to define if the workplan is a RECURSIVE TASK. Posible values:
      • NULL (not recursive)
      • 'EVERYHOUR'
      • '4ADAY'
      • '3ADAY'
      • '2ADAY'
      • 'DAY'
      • 'WEEK', 'WEEK{week_days}: The TASK will be repeated on a weekly basis. Since API Version 2.7.21 it is possible to append a modifier indicating only certain days of the week. For example, WEEK{MF} means that the TASK will be repeated weekly on Mondays and Fridays
      • 'BEWEEK'
      • 'MONTH'
      • 'YEAR';
    • recursive_mode: To define how RECURSIVE TASKS are generated. This property is only used when frequency is not NULL. Valid values are:
      • 0: The new iteration of a RECURSIVE TASK is generated when the TASK si closed
      • 1: The new iteration of a RECURSIVE TASK is generated automatically by the system even when the previous TASK is not closed. The TASK is generated when the date/time of the theoretic next TASK arrives. For example, i a TASK has a frequency of type 'DAY' and is programmed for '2018-11-01 09:00:00', the next programmed TASK should occur on '2018-11-02 09:00:00', so if that time arrives and the previous TASK is not closed yet, then the new iteration is calculated automatically.
    • visibility_mode:
      • 0- wont appear in list of optional tasks of mobile device, only in list of patient optional tasks in web application. (professional)
      • 1 - in case of optional task this task will appear in list of optional tasks in mobile device (patient)
      • 2- will appear in list of optional tasks of both professional and patient.
    • allow_add_activity: (true/false) Indicates whether TASKS based on this TASK TEMPLATE should allow to add activities dynamically. If false, then once the TASK instance has been created, the system will not allow to add more ACTIVITIES
    • admission_required: (true/false) This property is only used for EVENT TEMPLATES (i.e. the STAGE of the WORKPLAN is "EVENT"). If true, when creating an EVENT based on this TEMPLATE, it is mandatory that it is associate to an ADMISSION. Otherwise functions like event_insert ( session, date, case, event_type {, event_code} {, team} {, admission} ) or event_set () will return an error. Introduced in API Version 2.7.8
    • direction:(0: undefined, 1: incoming, 2: outgoing) This property is only used for EVENT TEMPLATES (i.e. the STAGE of the WORKPLAN is "EVENT"). Introduced in API Version 2.7.12
    • expiration: Indicates the expiration period of the TASKs created using this WORKPLAN OBJECT. Possible values are described in WORKPLAN OBJECT.Introduced in API Version 2.7.21
      • unit: MINUTES/HOURS/DAYS/WEEKS/MONTHS/YEARS
      • number
  • device_type: type of device in case if the task is DIS (device) task
  • 0 - PULSI CONTINUA 
    1 - PULSI
    12 - SPIRO
    13 - ACTIVITY (STEPS)
  • closed: task will be inserted already closed (state 13 = Done)

ErrorMsg:  Error message if the operation fails

Request Sample

library_program_task_get (“LC53060c6f729de8.42629546”, 2156)

ResponseSample

<library_program_task_getResponse env:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
  <result>
    <?xml version="1.0" encoding="utf-8"?>
    <task>
      <program>
        <ref>375</ref>
        <version>1</version>
      </program>
      <ref>14414</ref>
      <task_ref>15713</task_ref>
      <code>EASYCARE.SCORING</code>
      <name>NEEDS AND PRIORITIES SCORING</name>
      <version>2017-08-23 11:23:38</version>
      <description/>
      <taxonomy/>
      <type>REP</type>
      <device_type/>
      <image_info>{"resource_ref":14324,"description":"","mimeType":"jpg","code":"","scope":"PROGRAM"}<image_info>
      <category>
        <ref/>
        <description/>
      </category>
      <owner>
        <ref/>
        <name>PROGRAM</name>
      </owner>
      <editable>
        <owner>true</owner>
      </editable>
      <class>TASK</class>
      <activities>
        <activity>
          <ref>WORKPLAN/14414/TEMPLATE/12387/375|14414</ref>
          <description>Independence Score (=
            {{FORM.DATA.EASYCARE.SCORE.INDEPENDENCE}}
            / 100)</description>
          <hidden>0</hidden>
          <type>CUE</type>
          <editable>true</editable>
          <action_list>
            <action>
              <ref>ACTION=ITEM_DELETE&WORKPLAN=14414&TEMPLATE=12387</ref>
              <name/>
              <description/>
              <class>DELETE</class>
            </action>
          </action_list>
        </activity>
        <activity>
          <ref>WORKPLAN/14414/TEMPLATE/12388/375|14414</ref>
          <description>Risk of breakdown in care (=
            {{FORM.DATA.EASYCARE.SCORE.BREAKDOWN}}
            / 12)</description>
          <hidden>0</hidden>
          <type>CUE</type>
          <editable>true</editable>
          <action_list>
            <action>
              <ref>ACTION=ITEM_DELETE&WORKPLAN=14414&TEMPLATE=12388</ref>
              <name/>
              <description/>
              <class>DELETE</class>
            </action>
          </action_list>
        </activity>
        <activity>
          <ref>WORKPLAN/14414/TEMPLATE/12389/375|14414</ref>
          <description>Risk of falls (=
            {{FORM.DATA.EASYCARE.SCORE.FALLS}}
            / 8)</description>
          <hidden>0</hidden>
          <type>CUE</type>
          <editable>true</editable>
          <action_list>
            <action>
              <ref>ACTION=ITEM_DELETE&WORKPLAN=14414&TEMPLATE=12389</ref>
              <name/>
              <description/>
              <class>DELETE</class>
            </action>
          </action_list>
        </activity>
      </activities>
      <program>
        <ref>375</ref>
      </program>
      <protocol>
        <ref>2312</ref>
      </protocol>
      <workplan>
        <frequency/>
        <day>0</day>
        <end_day/>
        <week_days/>
        <order>0</order>
        <visibility_mode>3</visibility_mode>
        <allow_add_activity>
        <admission_required>false</admission_required>
        <direction>0</direction>
        <closed>false</closed>
        <background>false</background>
        <locked>false</locked>
        <default_time/>
        <roles/>
        <expiration>
           <unit>days</unit>
           <number>2</number>
        </expiration>
      </workplan>
      <trial_group/>
      <stage>
        <ref>OPT</ref>
        <description>OPTIONAL</description>
      </stage>
    </task>
  </result>
  <ErrorMsg></ErrorMsg>
</library_program_task_getResponse>

Related content