iSalusPayers.GetPayer

The GetPayer webservice is intended retrieve a list of payers (insurance carriers) in the system based on various input criteria.  Developers will be expected to pass in the necessary search criteria to retrieve a list of payers that meet the specified criteria.

Sample Request

<request>
    <security>
        <key>ClientUserID~ClientPassword~ClientDatabase</key>
        <version>1.0</version>
        <userid />
        <account>8F0A3084-782F-4251-A813-320B228D112D</account>
    </security>
    <search>
        <Payer>
            <ID></ID>
            <PrimaryPayerId></PrimaryPayerId>
            <Name>Medicaid</Name>
        </Payer>
        <Address>
            <State>AL</State>
            <Zipcode></Zipcode>
        </Address>
    </search>
</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 > Search

This is a stub for the main body of the search.

Request > Search > Payer

This is a stub for the payer details that can be supplied for the search.

Request > Search > Payer > ID

The unique system ID generated by the application for this payer (primary key).

Request > Search > Payer > PrimaryPayerID

The clearinghouse payer ID used to identify this payer.  This value is not necessarily unique.

Request > Search > Payer > Name

The name of the payer (i.e. Anthem)

Request > Search > Address

This is a stub for the payers address details that can be supplied for the search.

Request > Search > Address > State

The payer's state.  2 Digit state code expected.

Request > Search > Address > ZipCode

The payer's zip code.  5 or 9 digit zip code expected.

Sample Response

No Results:  When no results are available, the <payer_list> node will be empty.

<response xmlns="http://www.isalushealthcare.webservices/">
    </payer_list>
</response>

Results Available:  When results are available, the <payer_list> node will contain 1 to many <payer> nodes with the corresponding details.  

<response xmlns="http://www.isalushealthcare.webservices/">
    <PayerList>
        <Payer>
            <ID>36351</ID>
            <Name>Alabama Medicaid</Name>
            <PrimaryPayerId>Paper</PrimaryPayerId>
            <Active>Y</Active>
            <ClaimFiling>
                <Code>D</Code>
                <Description>Medicaid</Description>
            </ClaimFiling>
            <Address>
                <Address1>1234 Test Street</Address1>
                <Address2 />
                <City>Montgomery</City>
                <State>AL</State>
                <ZipCode>36124</ZipCode>
            </Address>
        </Payer>
    </PayerList>
</response>

Error:  When there is an error retrieving the results, and <Error> node will be returned with the appropriate code and description of the error.

<response xmlns="http://www.isalushealthcare.webservices/">
    <error>
        <code>1078</code>
        <description>There was a problem retrieving payer information.</description>
        <log_id>12478</log_id>
    </error>
</respons

Response

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

Response > PayerList

The Payer List stub will be used to group all payers together in the response.

Response > PayerList > Payer

The Payer stub will be used to group the details related to an individual payer.  

Response >  PayerList > Payer > ID

This is the unique ID assigned to the payer specified.

Response > PayerList > Payer > Name

This is the name of the payer as it appears in the application list.

Response > PayerList > Payer > PrimaryPayerID

The clearinghouse payer ID used to identify this payer.  This value is not necessarily unique.

Response > PayerList > Payer > Active

This indicates if the payer is active in the application.  Y = Yes (active); N = No (inactive).

Response > PayerList > Payer > ClaimFiling

This is a stub for the possible claim filing information for this payer.

Response > PayerList > Payer > ClaimFiling > Code

The 1 digit numerical claim filing code.

Response > PayerList > Payer > ClaimFiling > Description

The long claim filing description for this payer.

Response >  PayerList > Payer > Address

This is a stub for all of the address details for this payer.

Response >  PayerList > Payer > Address > Address 1

The street address of the payer.

Response >  PayerList > Payer > Address > Address 2

The secondary street address of the payer.

Response >  PayerList > Payer > Address > City

The city of the payer.

Response >  PayerList > Payer > Address > State

The payer's state.

Response >  PayerList > Payer > Address > ZipCode

The payer's zip code.