Provider Search by Group

Provider search by group accepts a group number and returns an array of eligibility records from that group.

Request URL

https://secure.healthx.com/api/eligibilityv1/provider/search/group

Parameters
  • groupnum: A comma-delimited list of member IDs to search for.
  • start: The index of the first record to return (starting with 1).
  • count: The number of records to return (maximum: 100).
  • searchmodifiers: A set of name:value pairs, delimited by the pipe character. The allowable names and values are as follows:
    • orgproviderid: an organization's internal identifier for a provider (default:none).
    • mode: Allowed values are "memberid", "ssn", or "both" (default:both).
    • scope: subscriber, dependent, both (default:both).
    • memberid: a comma delimited list of member IDs.
    • firstname: the first name of the member for whom to search.
    • firstnamepartial: Whether or not to use a partial match on the member's first name. Allowed values are "true" or "false" (default: false).
    • fullrecord: true, false (default: false)
    • lastname: the last name of the member for whom to search.
    • lastnamepartial: Whether or not to use a partial match on the member's last name. Allowed values are "true" or "false" (default: false).
    • includeinactve: "true" returns inactive eligibility records as well as active ones (default:false)
    • dob: member's date of birth in YYYY-MM-DD format.
    • sortdir: ascending or descending (default: ascending).
    • sortfield: any eligibility data field. Specify multiple fields by separating them with a comma.


Sample request body


<ProviderGroupSearch>
    <groupnum>300</groupnum>
    <start>1</start>
    <count>5</count>
    <searchmodifiers>sortdir:descending|sortfield:lastname</searchmodifiers>
</ProviderGroupSearch>


Return Sample


<TotalRecordCount>3</TotalRecordCount>
<Records>
    <EligibilityRecord>
        <Accumulators i:nil="true"/>
        <AddDateTime>2009-01-19T11:18:17.18</AddDateTime>
        <Addr2 i:nil="true"/>
        <.../>
        <Zip>55333     </Zip>
    </EligibilityRecord>
    <EligibilityRecord>
        <Accumulators i:nil="true"/>
        <AddDateTime>2008-05-22T12:48:31.16</AddDateTime>
        <Addr2 i:nil="true"/>
        <.../>
        <Zip>55444     </Zip>
    </EligibilityRecord>
</Records>