iSalusExternal.SaveTemplateInput

The SaveTemplateInput method is designed for the external storage of template data within a patient's record. This method facilitates the integration of template data into the SOAP Note or Progress Note associated with a patient encounter, contingent upon the submission of a request that includes an encounter date coinciding with the patient's appointment date.

Implementation of this method requires a mapping session with project contacts, potentially involving the practice. Please note that the identifiers used in requests are dynamic and must be verified before being applied to additional practice databases.

Sample Request Body

<request>
    <security>
        <key>REDACTED</key>
        <version>1.0</version>
        <userid />
        <account>REDACTED</account>
    </security>
    <template_id>120955</template_id>
</request>

Element Description

Request

The Request element will serve as a wrapper for the entire body of the XML request.

Request > Security

See documentation for the Security node here: Access to Webservices

Request > Template_ID*

The template_id will determine which encounter template will be retrieved when submitting an entry. As shown in the screenshot above, the template_id corresponds to the Template dropdown field in the UI. This will accept an integer.

During the mapping exercise with your project contact, you will want to determine the template_ID to use. Additionally, not all clients use the same templates so you will likely need to complete a mapping exercise for all clients data are being written to.

Sample Response Body

<response xmlns="http://www.isalushealthcare.webservices/">
    <template_id>120955</template_id>
    <template_name>Sample Template</template_name>
    <template_type_id>e</template_type_id>
    <template_type_desc>Exams</template_type_desc>
    <template_list>
        <template_item>
            <global_entity_id>1192923</global_entity_id>
            <global_entity_description>Exams - Sample Template - 1st Category aka Bluebar - Checkbox - Alias for Checkbox 1</global_entity_description>
            <alias>Alias for Checkbox 1</alias>
            <control_type_id>1</control_type_id>
            <control_type_description>Checkbox</control_type_description>
        </template_item>
        <template_item>
            <global_entity_id>1192924</global_entity_id>
            <global_entity_description>Exams - Sample Template - 1st Category aka Bluebar - Checkbox - Alias for Checkbox 2</global_entity_description>
            <alias>Alias for Checkbox 2</alias>
            <control_type_id>1</control_type_id>
            <control_type_description>Checkbox</control_type_description>
        </template_item>
        <template_item>
            <global_entity_id>1192925</global_entity_id>
            <global_entity_description>Exams - Sample Template - 1st Category aka Bluebar - Date - A Date Input</global_entity_description>
            <alias>A Date Input</alias>
            <control_type_id>5</control_type_id>
            <control_type_description>Date</control_type_description>
        </template_item>
        <template_item>
            <global_entity_id>1192926</global_entity_id>
            <global_entity_description>Exams - Sample Template - 1st Category aka Bluebar - TextArea - 52554407</global_entity_description>
            <alias />
            <control_type_id>7</control_type_id>
            <control_type_description>TextArea</control_type_description>
        </template_item>
        <template_item>
            <global_entity_id>1192927</global_entity_id>
            <global_entity_description>Exams - Sample Template - 2nd Category - Combobox - Dropdown1</global_entity_description>
            <alias>Dropdown1</alias>
            <control_type_id>8</control_type_id>
            <control_type_description>Combobox</control_type_description>
            <decode_template_id>74851</decode_template_id>
            <decode_list>
                <decode_item>
                    <encode>902294</encode>
                    <decode>Yes</decode>
                </decode_item>
                <decode_item>
                    <encode>902295</encode>
                    <decode>No</decode>
                </decode_item>
                <decode_item>
                    <encode>902296</encode>
                    <decode>Maybe</decode>
                </decode_item>
            </decode_list>
        </template_item>
        <template_item>
            <global_entity_id>1192928</global_entity_id>
            <global_entity_description>Exams - Sample Template - 2nd Category - Text - Text1</global_entity_description>
            <alias>Text1</alias>
            <control_type_id>2</control_type_id>
            <control_type_description>Text</control_type_description>
        </template_item>
    </template_list>
</response>

Response > Template_ID

Echoed <template_id> from the initial request. Validates the requested template was returned.

Response > Template_Name

Template name of the requested template, as seen in the UI of OfficeEMR and shown above in the screenshot.

Response > Template_Type_ID

Denotes the Chart Tab the template is used in. The following are the most likely to see:

a = Assessment *unlikely to be used, largely deprecated
e = Exams
r = Review of Systems (ROS)
i = History of Present Illness (HPI)
t = Treatment Plan

Response > Template_Type_Desc

Full description of the Chart Tab the template is used in.

Response > Template_List

The template_list element will serve as a wrapper for all template_item elements. This should be considered the contents of the template.

Response > Template_List > Template_Item

The template_item element will serve as a wrapper for the individual elements that make up an input and its expected values.

Response > Template_List > Template_Item > Global_Entity_ID

The global_entity_id element is the identifier of an HTML <input> on a specific template. Every template input will have a unique Global Entity (GE).

During the mapping exercise, it will be important to determine the global_entity_id(s) for the inputs you are working to submit data for.

Response > Template_List > Template_Item > Global_Entity_Description

The GE Description is used internally for assigning descriptions to inputs. This is not likely to be used in an interface, is largely for internal use.

Response > Template_List > Template_Item > Alias

The alias contains the Label for a given input, it is common for this to be blank due to the layout of a template. This is represented in the screenshot at the top of the page. The label for the textarea is a separate element of the template that is purely visual. These labels do not have GEs and do not get returned in the API Response.

Response > Template_List > Template_Item >Control Type ID

Denotes the type of control on the template. There may be additional fields returned in the response but the controls expected to be used by third-party vendors are shown in the table below.

Response > Template_List > Template_Item >Control Type Description

Corresponds to the Control Type ID. The control list is shown below;

Control Type ID	Control Type Description	Data Type	Notes
1	Checkbox	varchar(1)	Y or N
2	Text	varchar(1500)
3	Numeric	int	-
5	Date	date	MM/DD/YYYY
7	Text Area	varchar(500000)	-
8	Combobox (Select/Dropdown)	int	Expects an encoded value for dropdown values. Work with project contacts to obtain these values.

During the mapping exercise, it will be important to determine what control types/input types are being used on the template. Consult the table to determine the different accepted encounter_values to be used in the subsequent call to save the data entry.