The Rendering Provider webservice is intended retrieve a list of rendering providers in the system based on various input criteria.. Developers will be expected to pass in the necessary search criteria to retrieve a list of providers that meet the specified criteria.
Sample Request
<request> <security> <key>ClientUserID~ClientPassword~ClientDatabase</key> <version>1.0</version> <userid /> <account>AccountGUID</account><search><ProviderID></ProviderID><CredentialsFlag>N</CredentialsFlag></search></request></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 > ProviderID
This can house the internal provider ID generated by the application. If searching for all rendering providers, leave this field blank.
Request > Search > CredentailFlag
This value can be Y for Yes or N for No. If Y, then the list will return credentials that have been configured for the provider. If N, no credentials will be returned.
Sample Response
No Results: When no results are available, the <Response> node will be empty.
<response xmlns="http://www.isalushealthcare.webservices/">
</response>
Results Available - with Credentials: When results are available, the <Response> node will contain 1 to many provider nodes with the corresponding details. The <PayerList> node will be returned as well when credentials are requested.
<response>
<Provider>
<ID>283</ID>
<LastName>Adams</LastName>
<FirstName>Blaire</FirstName>
<MiddleName>
</MiddleName>
<Suffix>ARNP</Suffix>
<TaxID>99-9999999</TaxID>
<StateLicense>
</StateLicense>
<UPIN>
</UPIN>
<NPI>4278456998</NPI>
<GroupNPI>1234567891</GroupNPI>
<BillingProvider>1</BillingProvider>
<PortalProvider>1</PortalProvider>
<PayerList>
<Payer>
<ID>36335</ID>
<Name>Empire Blue Cross Blue Shield</Name>
<PIN>4278456998</PIN>
<Participating>P</Participating>
</Payer>
<Payer>
<ID>36344</ID>
<Name>Cigna</Name>
<CredentialList>
<Credential>
<Qualifier>G2</Qualifier>
<Description>Provider Commercial Number</Description>
</Credential>
</CredentialList>
</Payer>
</PayerList>
</Provider>
</response>Results Available - without Credentials: When results are available, the <Response> node will contain 1 to many provider nodes with the corresponding details. The <PayerList> node will NOT be returned when credentials are not requested.
<response>
<Provider>
<ID>283</ID>
<LastName>Adams</LastName>
<FirstName>Blaire</FirstName>
<MiddleName>
</MiddleName>
<Suffix>ARNP</Suffix>
<TaxID>99-9999999</TaxID>
<StateLicense>
</StateLicense>
<UPIN>
</UPIN>
<NPI>4278456998</NPI>
<GroupNPI>1234567891</GroupNPI>
<BillingProvider>1</BillingProvider>
<PortalProvider>1</PortalProvider>
<PayerList>
<Payer>
<ID>36335</ID>
<Name>Empire Blue Cross Blue Shield</Name>
<PIN>4278456998</PIN>
<Participating>P</Participating>
</Payer>
<Payer>
<ID>36344</ID>
<Name>Cigna</Name>
<CredentialList>
<Credential>
<Qualifier>G2</Qualifier>
<Description>Provider Commercial Number</Description>
</Credential>
</CredentialList>
</Payer>
</PayerList>
</Provider>
</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>-1</code>
<description>XML Validation: Invalid simple type value: 'x'. Location: /*:request[1]/*:search[1]/*:ProviderID[1]</description>
</error>
</response>
Response
The Response element will serve as a wrapper for the entire body of the XML response.
Response > Provider
The Provider stub will be a grouping for each individual provider returned.
Response > Provider > ID
The provider ID is the unique ID assigned to each provider record in the application.
Response > Provider > LastName
The last name of the provider.
Response > Provider > FirstName
The first name of the provider
Response > Provider > MiddleName
The middle name of the provider.
Response > Provider > Suffix
The suffix of the provider (i.e. MD).
Response > Provider > TaxID
The Tax ID of the provider.
Response > Provider > StateLicense
The State License number of the provider.
Response > Provider > UPIN
The UPIN of the provider.
Response > Provider > NPI
The National Provider ID (NPI) of the provider.
Response > Provider > Group NPI
The Group National Provider ID (NPI) of the provider.
Response > Provider > BillingProvider
The Billing Provider flag is represented as a 1 or a 0. 1 indicates this is a billing provider and 0 means this is not a billing provider. This control if a claim can be sent out of the application for this provider.
Response > Provider > PortalProvider
The Portal Provider flag is represented as a 1 or a 0. 1 indicates this provider is a portal provider and 0 means this is not a portal provider. This controls if a provider is showing in the Patient Portal (aka MyMedicalLocker).
Response > Provider > PayerList
The <PayerList> node is a stub to house 1 to many payer credentials for the provider. This node will be suppressed if the <CreentialsFlag> in the request is set to 'N'. This node will be exposed if the <CredentialsFlag> in the request is set to 'Y'.
Response > Provider > PayerList > Payer
This is a stub to hold credentials and details related to the payer.
Response > Provider > PayerList > Payer > ID
This is the unique ID assigned to the payer specified.
Response > Provider > PayerList > Payer > Name
This is the name of the payer as it appears in the application list.
Response > Provider > PayerList > Payer > PIN
This is the PIN/Group Code used for this payer.
Response > Provider > PayerList > Payer > Participating
This indicates if the provider partiicpates with this payer. If, 'P', this means yes. Otherwise, this field will be blank.
Response > Provider > PayerList > Payer > CredentialList
This is a stub for the credentials setup for the payer. There may be one to many <credential> nodes nested.
Response > Provider > PayerList > Payer > CredentialList > Credential
This is a stub for the specific credential.
Response > Provider > PayerList > Payer > CredentialList > Credential > Qualifier
This is a short code that identifies the type of credential being configured. See below for complete list.
Response > Provider > PayerList > Payer > CredentialList > Credential > Description
This is a long description of the credential (i.e. Employeer's Identification Number0
Response > Provider > PayerList > Payer > CredentialList > Credential > PIN
This is the ID/PIN for the given credential.
