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 applying them to additional practice databases.

Sample Request Body

<request>
    <security>
        <key>REDACTED</key>
        <version>1.0</version>
        <account>REDACTED</account>
    </security>
    <patient_id>24798</patient_id>
    <template_id>116318</template_id>
    <encounter_date>04/04/2024</encounter_date>
    <template_list>
        <template_item>            
            <global_entity_id>1158063</global_entity_id>
            <encounter_value>Blah blah blah</encounter_value>
        </template_item>
    </template_list>
</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 > Patient_ID*

The Patient_ID element is required and will accept an integer for the patient identifier.

Request > Template_ID*

The template_id will determine which encounter template will be used 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.

Request > Encounter_Date*

The encouner_date, submitted as MM/DD/YYYY, will determine what SOAP/Progress note the entered data will display for. When the submitted encounter_date matches the appointment date for the patient & the SOAP/Progress note template is set up to pull in the template data, the content will be included in the note for that encounter date.

Request > Template_List

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

Request > Template_List > Template_Item

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

Request > Template_List > Template_Item > Global_Entity_ID

The global_entity_id element is the identifier of an HTML <input> on a specific template. See the screenshot above that indicates the checkbox itself has a global entity.

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.

Request > Template_List > Template_Item > Encounter Value

The encounter_value element, a sibling to global_entity_id, will accept a value for the input. Depending on the type of input there are different accepted 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 below to determine the different accepted encounter_values are depending on the control type.

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

Sample Response Body

<SaveTemplateInputResponse xmlns="http://www.isalushealthcare.webservices/">
    <SaveTemplateInputResult>
        <response xmlns="http://www.isalushealthcare.webservices/">
            <encounter_id>17112</encounter_id>
        </response>
    </SaveTemplateInputResult>
</SaveTemplateInputResponse>

Above is an example of a successful response body, the encounter_id being returned indicates the template was created successfully.