iSalusWindow.GetList

The iSalusWindow.GetList webservice is a generic method used to pull back internal and external descriptions of various lists.

Sample Request

<request>
    <security>
         <key>ClientUserID~ClientPassword~ClientDatabase</key>
         <version>1.0</version>
        <userid />
        <account>REDACTED</account>
    </security>
     <list>
         <list_item>
             <name>primary_id_type</name>
             <qualifier>
             </qualifier>
         </list_item>
    </list>
</request>

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 > List

The <List> element will serve as a wrapper for all <List_Items> requested.

Request > List > List_item

The <List_item> element will serve as a wrapper for all of the details of the list requested.

Request > List > List_Item > Name

The name of the list to retrieve.  See below for options.

Practice Information
  • Company Profile = Practice
  • Users = Users
  • User Groups = User_group
Claim Lists
  • Claim Levels = Claim_level
  • Claim Statuses = claim_status
  • Clam Sub-Statuses = claim_substatus
  • Payers = Insurance_payers
  • Type of Claim = claim_type
Patient Lists
  • Gender = gender
  • Ethnicity = ethnicity
  • Race = race
  • Language = language
  • Marital Status = maritalStatus
  • Student Status = student
  • Employment Status = employed
  • Primary ID Types = primaryType
  • Secondary ID Types = secondaryType
  • Reminder Preferences = reminder
Provider Lists
  • Rendering Providers = Rendering_provider
  • Referring Providers = Referring_provider
Insurance Lists
  • Primary ID Type = primary_id_type
  • Secondary ID Types = secondary_id_type
Appointment Lists
  • Resource Categories = appt_res_category
  • Resources = scheduled_resource
  • Appointment Types = appointment_type
  • Appointment Statuses = appointment_status
  • Service Locations = service_location
Problem List Lists
  • Status = problem_list_status

Request > List > List_Item > Qualifier

The qualifier for the list to retrieve.  Used only in special circumstances.

Sample Response

No Results:  When no results are available, the <list> node will be returned, but no data will be present.

<response xmlns="http://www.isalushealthcare.webservices/">
    <list>
    </list>
    <key_list />
</respons

Results Available:  When results are available, the <list> node will contain 1 to many list items.

<response xmlns="http://www.isalushealthcare.webservices/">
    <list>
        <Ethnicity_cached>
            <list_item>
                <h>0</h>
                <encode>999</encode>
                <decode>Declined to specify</decode>
            </list_item>
            <list_item>
                <h>0</h>
                <encode>6</encode>
                <decode>Hispanic or Latino</decode>
            </list_item>
            <list_item>
                <h>0</h>
                <encode>10</encode>
                <decode>Not Hispanic or Latino</decode>
            </list_item>
        </Ethnicity_cached>
    </list>
    <key_list />
</response>

Response

The Response element will serve as a wrapper for the entire body of the XML response.

Response > List

The <List> node will serve as a stub for all list_items

Response > List > <<ECHOED LIST NAME>>

The name of the list will be returned as a dynamic node. For example, if you request a list of 'Rendering' providers, 'Rendering' will be returned as a node before the items in that list.

Response >List > <<ECHOED LIST NAME>> > List_Item

The <list_item> node will serve as a stub for the details for this item.

Response >List > <<ECHOED LIST NAME>> > List_Item > H

This is an indicator if the value returned is a header of a list or if it is an item in the list.

  • 1 = Means this is a header
  • 0 = Means this is an item

Response >List > <<ECHOED LIST NAME>> > List_Item > Encode

This is the encoded value (internal_id) for the returned item.

Response >List > <<ECHOED LIST NAME>> > List_Item > Decode

This is the decoded value, usually a description, for the returned item.