iSalusPatient.PatientList

Overview

The iSalusPatient.PatientList webservice is used to retrieve a list of patients that match specified search criteria. The webservice will accept search values as input and limited patient details are returned for each patient matching the search.  The search string will look across the following fields:

• Chart Number
• First Name
• Last Name
• Nick Name
• Phone Number (Home, Work, Other)
• Date of Birth
• Social Security Number

Sample Call

Request

<request>
    <security>
        <key>REDACTED</key>
        <version>1.0</version>
        <userid />
        <account>REDACTED</account>
    </security>
    <search>
        <criteria>blake</criteria>
    </search>
    <max_rows>25</max_rows>
</request>

Response

<response xmlns="http://www.isalushealthcare.webservices/">
    <patient_list>
        <patient>
            <id>9516</id>
            <entity_id>37970</entity_id>
            <name>Baby, Blake</name>
            <dob>12/07/2011</dob>
            <age>8.7y</age>
            <gender>Male</gender>
            <phone>
                <home_primary>(317) 956-7909</home_primary>
            </phone>
            <primary_id />
            <primary_type>SSN</primary_type>
            <bridge_key />
            <bridge_provider />
            <Vitals>
                <BMI>0.00</BMI>
                <BSA>0.00</BSA>
            </Vitals>
            <employer />
        </patient>
        <patient>
            <id>9367</id>
            <entity_id>37107</entity_id>
            <name>Head, Blake A.</name>
            <dob>03/20/1989</dob>
            <age>31y</age>
            <gender>Male</gender>
            <phone>
                <home_primary>(317) 956-7909</home_primary>
                <business_primary>(317) 888-7729</business_primary>
                <other>(317) 833-8967</other>
            </phone>
            <primary_id>311-11-3095</primary_id>
            <primary_type>SSN</primary_type>
            <bridge_key />
            <bridge_provider />
            <Vitals>
                <BMI>22.34</BMI>
                <BSA>1.99</BSA>
            </Vitals>
            <employer />
        </patient>
        <patient>
            <id>9388</id>
            <entity_id>37264</entity_id>
            <name>Head, Blake A. JR (BH)</name>
            <dob>03/20/1989</dob>
            <age>31y</age>
            <gender>Male</gender>
            <phone>
                <home_primary>(317) 956-7909</home_primary>
                <business_primary>(317) 687-8119</business_primary>
                <other>(317) 956-7909</other>
            </phone>
            <primary_id>123-45-6789</primary_id>
            <primary_type>SSN</primary_type>
            <bridge_key />
            <bridge_provider />
            <Vitals>
                <BMI>20.34</BMI>
                <BSA>1.86</BSA>
            </Vitals>
            <employer />
        </patient>
</response>

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

This is a stub for the search parameters.

Request > Search > Criteria

This is a string input for what you want to search for.  This can be any combination of the following fields 

• Chart Number
• First Name
• Last Name
• Nick Name
• Phone Number (Home, Work, Other)
• Date of Birth
• Social Security Number

This search is very flexible and can handle inputs as you see below:

• Partial Name Search:   
  • Input:  <criteria>ba ma</criteria> 
  • Patient Returned:  Bat Man
• Name and DOB Search
  •  Input:  <criteria>Man 03/20/1989</criteria>
  • Patient Returned:  Joe Manard where the birth date is 03/20/1989

Request > Max_Rows

This accepts a maximum number of patient rows that you would like to return based on the input.  

Response

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

Response > Patient_List

The <Patient_List> element will serve as a wrapper for all possible patient objects that will be returned.

Response > Patient_List > Patient

The <Patient> element will serve as a wrapper for all data for the returned patient.  This element may repeat.

Response > Patient_List > Patient > ID

The unique, public-facing ID for this patient (aka Chart Number).

Response > Patient_List > Patient > entity_id

Unique, internal facing ID for this patient.

Response > Patient_List > Patient > name

Patient name formatted as Last, First, Middle

Response > Patient_List > Patient > dob

Patient date of birth.  Formatted as MM/DD/YYYY.

Response > Patient_List > Patient >age

Patient calculated age based on the date of birth and today's date.  Formatted as "3.7 yo".

Response > Patient_List > Patient > gender

Patient gender. Represented as Male, Female, Unknown.

Response > Patient_List > Patient > Phone

Wrapper for all phone information returned.

Response > Patient_List > Patient > Phone > Home_primary

Patient's home phone number.

Response > Patient_List > Patient > Phone > Business_primary

The patient's work phone number.

Response > Patient_List > Patient > Phone > Other

Patient's "other" phone number, often a cell phone.

Response > Patient_List > Patient > Primary_ID

Value of the primary ID.

Response > Patient_List > Patient > Primary_ID_Type

Decoded representation of the primary ID used (i.e. SSN).

Response > Patient_List > Patient > Bridge_Key

Depreciated

Response > Patient_List > Patient > Bridge_provider

Depreciated

Response > Patient_List > Patient > Vitals

Wrapper for all vital records returned.

Response > Patient_List > Patient > Vitals > BMI

Body Mass Index - calculated from most recent height and weight entered in the Vitals chart tab.

Response > Patient_List > Patient > Vitals > BSA

Body Surface Area - calculated from the most recent height and weight entered in the Vitals chart tab.

Response > Patient_List > Patient > Employer

Name of the patient's employer.