form_get_summary ()
- Former user (Deleted)
- Pedro Jose Sanchez Luling
- Alexey Kapitula (Unlicensed)
Function prototype | form_get_summary ( session, form {,with_questions}{, as_closed} ) |
|---|---|
API Version | All |
Generates a summary of a FORM with the list of questions and the answered values, plus the form name and the form data give it in the XML returned. The language of the descriptions is in the active language of the session passed in the input parameter The questions included in the FORM depend on the state of the FORM:
| |
Input parameters: |
|
Output parameters: |
|
Request sample: | form_get_summary( “LCAAAAAAAAAAA”, “1234”); |
Response sample: |
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<result>
<form>
<ref>1234</ref>
<data>
<status>CLOSED</status>
<template>187</template>
<progress>
</progress>
<name>PATIENT START</name>
<description>PATIENT START</description>
<content_type>FORM</content_type>
<admission>1231212</admission>
<parent_type>TASK</parent_type>
<parent_id>466364</parent_id>
<parent_status>DONE</parent_status>
<parent_name>Patient start</parent_name>
<parent_locked>false</parent_locked>
<editable>true</editable>
<questions>
<question>
<question_id>1</question_id>
<item_code></item_code>
<order>1</order>
<row></row>
<column></column>
<mandatory>N</mandatory>
<exclusive>N</exclusive>
<tabulation>0</tabulation>
<description>PAIN DESCRIPTION</description>
<description_onedit>PAIN DESCRIPTION</description_onedit>
<literal_format>{"text_format":"plain", "text-align":"left"}</literal_format>
<value_format>{"text_format":"plain","text-align":"centre"}</value_format>
<arrangement></arrangement>
<constraint></constraint>
<barcode_scan>0</barcode_scan>
<data_code></data_code>
<type>STATIC_TEXT</type>
<is_section_title>false</is_section_title>
<value></value>
<nav_mode>0</nav_mode>
<display_time>5</display_time>
</question>
<question>
<question_id>2</question_id>
<order>2</order>
<row></row>
<column></column>
<num_dec></num_dec>
<min_length>1</min_length>
<max_length>32</max_length>
<unity>(MM/DD/YYYY)</unity>
<value_description>11/22/2015</value_description>
<mandatory>N</mandatory>
<exclusive>N</exclusive>
<tabulation>0</tabulation>
<description>Please indicate the day when patient will start sending information.</description>
<description_onedit>Expected start date:</description_onedit>
<literal_format>{"text_format":"plain", "text-align":"left"}</literal_format>
<value_format>{"text_format":"plain","text-align":"centre"}</value_format>
<arrangement>{"answer_position":"below"}</arrangement>
<constraint></constraint>
<barcode_scan>0</barcode_scan>
<data_code>START</data_code>
<type>DATE</type>
<section_title>false</section_title>
<value>11/22/2015</value>
<nav_mode>0</nav_mode>
</question>
<question>
<question_id>3</question_id>
<order>3</order>
<row></row>
<column></column>
<num_dec></num_dec>
<unity></unity>
<mandatory>N</mandatory>
<exclusive>N</exclusive>
<tabulation>0</tabulation>
<description>Please indicate the day when patient will start sending information.</description>
<description_onedit>Expected start date:</description_onedit>
<literal_format>{"text_format":"plain", "text-align":"left"}</literal_format>
<value_format>{"text_format":"plain","text-align":"centre"}</value_format>
<arrangement>{"answer_position":"below"}</arrangement>
<constraint></constraint>
<barcode_scan>0</barcode_scan>
<data_code>PAIN_ZONE</data_code>
<type>VERTICAL_RADIO</type>
<multimedia_info>{"resource_ref":12312,"description":"Relaxing instructions","mimeType":"audio/mp3","code":"RELAXING","scope":"PROGRAM"}</multimedia_info>
<image_list>
<image>
<image_info>{"resource_ref":12312,"description":"Human body","mimeType":"jpg","code":"HUMAN_BODY","scope":"PROGRAM"}</image_info>
</image>
</image_list>
<options>
<option>
<description>Shoulder</description>
<option_id>1</option_id>
<value>sh</value>
<image_info></image_info>
<region_map>{"resource_ref":12312, "region":"12,43,124,542,425,232"}</region_map>
</option>
<option>
<description>Shoulder</description>
<option_id>2</option_id>
<value>elb</value>
<image_info>{"resource_ref":12312,"description":"Elbow","mimeType":"jpg","code":"HUMAN_BODY_ELBOW","scope":"PROGRAM"}</image_info>
<region_map>{"resource_ref":12312, "region":"54,23,56,45,123,542"}</region_map>
</option>
</options>
<value>2</value>
<value_description>Elbow</value_description>
<image_info>{"resource_ref":12312,"description":"Elbow","mimeType":"jpg","code":"HUMAN_BODY_ELBOW","scope":"PROGRAM"}</image_info>
<nav_mode>0</nav_mode>
</question>
<question>
<question_id>4</question_id>
<min_value></min_value>
<max_value></max_value>
<num_dec></num_dec>
<order>4</order>
<row></row>
<column></column>
<mandatory>N</mandatory>
<exclusive>N</exclusive>
<tabulation>0</tabulation>
<description>Please verify the date, and if is not correct correct the date selecting the first question.</description>
<data_code>CONFIRMATION</data_code>
<type>VERTICAL_RADIO</type>
<value_description>Yes</value_description>
<value>Yes</value>
<device_type>pedometer</device_type>
<nav_mode>0</nav_mode>
</question>
</questions>
</data>
<attachments>
<attachment>
<filename>image1.jpg</filename>
<mime_type>image/jpeg</mime_type>
<url>Render.php?shared_key=9asdjha98daasdasa</url>
</attachment>
<attachment>
<filename>image2.jpg</filename>
<mime_type>image/jpeg</mime_type>
<url>Render.php?shared_key=9khtfba4yda</url>
</attachment>
</attachments>
</form>
</result>
<ErrorMsg></ErrorMsg>
<ErrorCode></ErrorCode>
|
Notes: |
|
Embedded FORMS
An ITEM of type "FORM" (ITEM TYPE: "FORM") can be used to insert a list of questions defined in a separate FORM. This strategy allows to create complex FORMs in a modular way avoiding the need of creating a single FORM with a large list of questions.
In API Version 2.7.19 it was introduced the property 'navigation mode' to for each question of a FORM, which is a recommendation to the client about how to display a question in the user interface.
Since API Version 2.7.20, in ITEMs of type "FORM" the navigation mode also affects the way in which form_get_summary() returns the list of questions. Consider the following example:
In this example, the parent FORM F1 contains 5 questions, though 2 of them belong to an embedded FORM F2.
When the ITEM of type FORM has navigation mode = 0 (show embedded), the item of type "FORM" is not included in the response of form_get_summary(), and the questions in the embedded FORM referenced by ITEM Q2 are inserted in the response as if they belonged directly to the parent FORM. In this situation the response of form_get_summary() would be:
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<result>
<form>
<ref>F1</ref>
<data>
<status>CLOSED</status>
...
<questions>
<question>
<question_id>Q1</question_id>
<type>TEXT</type>
...
</question>
<question>
<question_id>Q2.1</question_id>
<type>TEXT</type>
...
</question>
<question>
<question_id>Q2.2</question_id>
<type>CHECKBOX</type>
...
</question>
<question>
<question_id>Q3</question_id>
<type>NUMBER</type>
...
</question>
</questions>
</data>
</form>
</result>
|
On the other side, when the ITEM of type FORM has navigation mode = 1 (show in popup dialog), the ITEM of type "FORM" is included in the response, but the questions in the corresponding embedded FORM are not inserted as regular questions of F1. Instead they are informed as inner questions of the ITEM Q2:
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<result>
<form>
<ref>F1</ref>
<data>
<status>CLOSED</status>
...
<questions>
<question>
<question_id>Q1</question_id>
<type>TEXT</type>
...
</question>
<question>
<question_id>Q2</question_id>
<type>FORM</type>
<nav_mode>1</nav_mode>
<inner_questions>
<question>
<question_id>Q2.1</question_id>
</question>
<question>
<question_id>Q2.2</question_id>
...
</question>
<inner_questions>
</question>
<question>
<question_id>Q3</question_id>
<type>NUMBER</type>
...
</question>
</questions>
</data>
</form>
</result>
|
Return Error codes
ERROR CODE |
|
|---|---|
INVALID_TOKEN | The session token provided is not valid |
INSUFFICIENT_PRIVILEGES | The session user does not have the necessary privileges to create request the 'form_id' indicated |
FORM.NOT_FOUND | The FORM reference provided in parameter form_id does not correspond to an existing FORM |