iSalusExternal.GetPatientFilterData

Overview

The iSalusExternal.GetPatientFilterData webservice is used to obtain a list of demographics, problems, medications, labs, appointments, diagnoses, soap notes, and corresponding data from the given patient's chart. This can be found here:  EMR > Select Patient.  The webservice will accept a patient ID and a start date for the input. All listed items will be returned.

Sample Call

Request

<request>
    <security>
        <key>7D93BBAA-894D-461E-A803-2CE96714A894</key>
        <version>1.0</version>
        <userid />
        <account>REDACTED</account>
    </security>
    <patient_id>25007</patient_id>
    <start_date>01/01/1901 01:00am</start_date>
</request>

Response

<response xmlns="http://www.isalushealthcare.webservices/">
    <patient_data>
        <patient_id>25007</patient_id>
        <first_name>Chandler</first_name>
        <last_name>Head</last_name>
        <birth_date>11/02/1999</birth_date>
        <gender_code>M</gender_code>
        <doctor />
        <race_list>
            <list_item>
                <code>999</code>
                <description>Declined to specify</description>
            </list_item>
        </race_list>
        <ethnicity>
            <code>6</code>
            <description>Hispanic or Latino</description>
        </ethnicity>
        <phone>
            <home_primary>(317) 474-2516</home_primary>
            <business_primary>(317) 555-2222</business_primary>
            <other>(317) 474-2516</other>
        </phone>
        <address>
            <address1>69 N Whittier Place</address1>
            <city>Indianapolis</city>
            <state>IN</state>
            <zip>46219</zip>
        </address>
        <patient_email>chandlerhead@isalushealthcare.com</patient_email>
        <problem_list>
            <list_item>
                <problem_list_id>1119</problem_list_id>
                <priority>1</priority>
                <description>Acute infarction of small intestine, extent unspecified</description>
                <code>K55029</code>
                <code_type>ICD10</code_type>
                <onset_date>06/03/2022</onset_date>
                <short_description>Acute infarction of small intestine, extent unspecified</short_description>
                <problem_description />
                <problem_list_status_code>1</problem_list_status_code>
                <problem_list_status_desc>Active</problem_list_status_desc>
                <post_date>06/03/2022  2:43PM</post_date>
                <chronic_ind>Y</chronic_ind>
            </list_item>
        </problem_list>
        <document_list>
            <list_item>
                <image_menu_xref_id>3133</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>Karls test fax converted to PDF by MSWord 365 Save As.pdf</image_name>
                <creation_date>08/11/2021 11:02AM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3180</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>thumbnail_image.png</image_name>
                <creation_date>01/20/2022  9:29PM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3337</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>Special Character Testing{~2}.txt</image_name>
                <creation_date>10/13/2022  7:56PM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3338</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>Special Character Testing'.txt</image_name>
                <creation_date>10/13/2022  8:16PM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3339</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>Special Character Testing^.txt</image_name>
                <creation_date>10/13/2022  8:20PM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3340</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>Special Character Testing^^.txt</image_name>
                <creation_date>10/13/2022  8:21PM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3341</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>Special Character Testing^what.txt</image_name>
                <creation_date>10/13/2022  8:23PM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3342</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>Special Character Testin^.txt</image_name>
                <creation_date>10/13/2022  8:24PM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3343</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>Special Character Testin#.txt</image_name>
                <creation_date>10/13/2022  8:26PM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3344</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>Special Character Testin..ji.txt</image_name>
                <creation_date>10/13/2022  8:29PM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3345</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>Special^carret.txt</image_name>
                <creation_date>10/13/2022  8:32PM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3346</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>Special=this.txt</image_name>
                <creation_date>10/13/2022  8:35PM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3347</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>Special!.txt</image_name>
                <creation_date>10/13/2022  8:36PM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3348</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>{Special}.txt</image_name>
                <creation_date>10/13/2022  8:36PM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3349</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>[Special].txt</image_name>
                <creation_date>10/13/2022  8:37PM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3350</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>this.length().txt</image_name>
                <creation_date>10/13/2022  8:37PM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3352</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>~what.txt</image_name>
                <creation_date>10/13/2022  8:39PM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3353</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>T~what.txt</image_name>
                <creation_date>10/13/2022  8:40PM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3354</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>T~what.txt</image_name>
                <creation_date>10/13/2022  8:41PM</creation_date>
            </list_item>
            <list_item>
                <image_menu_xref_id>3355</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>T~what.txt</image_name>
                <creation_date>10/13/2022  8:43PM</creation_date>
            </list_item>
        </document_list>
        <medication_list>
            <list_item>
                <prescription_id>1554</prescription_id>
                <start_date>05/11/2021</start_date>
                <stop_date>04/21/2022</stop_date>
                <short_name>Cipro I.V.</short_name>
                <drug_short_name>Cipro I.V. 200 mg/20 mL intravenous solution</drug_short_name>
                <drug_name>Cipro I.V. 200 mg/20 mL intravenous solution </drug_name>
                <status_code>15</status_code>
                <status_desc>Completed</status_desc>
                <patient_reported>Y</patient_reported>
                <refilled>N</refilled>
                <refilled_from>N</refilled_from>
            </list_item>
        </medication_list>
        <appointment_list>
            <list_item>
                <appointment_id>81340</appointment_id>
                <appointment_status_id>5</appointment_status_id>
                <appointment_status_desc>Checked-Out</appointment_status_desc>
                <appointment_type_id>25</appointment_type_id>
                <appointment_type_desc>Hemodialysis</appointment_type_desc>
                <appointment_start>08/12/2019 10:15AM</appointment_start>
                <appointment_end>08/12/2019 11:15AM</appointment_end>
                <chief_complaint>Hemodialysis</chief_complaint>
                <scheduled_with>Lakeview - Chair1</scheduled_with>
                <service_location_name>Community South</service_location_name>
                <service_location_address>
                    <address1>1402 East County Line</address1>
                    <city>Indianapolis</city>
                    <state>IN</state>
                    <zip>46227</zip>
                    <country>USA</country>
                </service_location_address>
            </list_item>
        </appointment_list>
        <diagnosis_list>
            <list_item>
                <diagnosis_id>48176</diagnosis_id>
                <from_date>03/28/2022</from_date>
                <to_date>03/28/2022</to_date>
                <procedure_code>20600</procedure_code>
                <procedure_code_desc>ARTHROCENTESIS, ASPIRATION/INJECTION; SMALL JOINT/BURSA/GANGLIOION CYST</procedure_code_desc>
                <diagnosis_code_1>B379</diagnosis_code_1>
                <diagnosis_code_1_desc>Candidiasis, unspecified</diagnosis_code_1_desc>
                <diagnosis_code_1_type>ICD10</diagnosis_code_1_type>
                <pos>21</pos>
                <tos>02</tos>
                <units>1</units>
                <rendering_provider_id>283</rendering_provider_id>
                <rendering_provider_name>Blaire Adams, ARNP</rendering_provider_name>
                <referring_provider_id>283</referring_provider_id>
                <referring_provider_name>Blaire Adams, ARNP</referring_provider_name>
            </list_item>
        </diagnosis_list>
        <soap_list>
            <list_item>
                <soap_note_id>2695</soap_note_id>
                <encounter_date>06/17/2022</encounter_date>
                <owner_name>Brad Kirschling</owner_name>
                <signoff_level>1</signoff_level>
                <signoff_desc>Brad Kirschling (Signed-Off)</signoff_desc>
                <html><HTML><HEAD><style>body { background-color: #fff; font-family: arial,verdana,sans-serif;} table { font-family: arial,verdana,sans-serif;} TD.Header{FONT-SIZE: 10pt; BACKGROUND-COLOR: #c3daf9; TEXT-ALIGN: center}</style></HEAD><BODY><h2 id="MOST_SUBJECTIVE">Subjective</h2><b>Patient History</b><br><b><u>Amethyst House Intake Assessment</u></b>  <br><p><b>Presenting Problem/Referral Source</b>:  ff<br><b>Drug(s) of choice</b>:  f<br>f</p><p><b>Allergies</b><br></p><ul><li> Absorbase</li><li> Beeswax-Allergen-Ingredient:  bleeding</li><li> bs</li></ul><b>Current Medications</b><ul><li>Keflex 500 mg tablet; Refills: Zero; Start Date: 05/11/2021; Sig: TABLET ORAL </li></ul><h2 id="MOST_OBJECTIVE">Objective</h2><h2 id="MOST_ASSESSMENT">Assessment</h2><h2 id="MOST_PLAN">Plan</h2><p><b>Medications</b><br></p><ul><li>Tylenol 8 Hour; Start Date: 08/12/2019; Sig: 34 Twice a day </li></ul><h2 id="MOST_TRANSCRIBE"></h2></BODY></HTML></html>
            </list_item>
        </soap_list>
    </patient_data>
</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 > Patient_ID

Chart number for the patient data you would like to retrieve.

Request > Start_Date

The date you would like the data to start being retrieved from to the present. Not including this element will cause the method to return data starting from 01/01/1901 to today.

Response

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

Response > patient_data

This will serve as a wrapper for all items that are on the patient's data list.

Response > patient_data > List_item

This will serve as a wrapper for all details related to patient data.

Response > patient_data > List_item >  patient_id

Echoed patient_id from the original request.

Response > patient_data > List_item > first_name

Patient's first name.

Response > patient_data > List_item > last_name

Patient's last name.

Response > patient_data > List_item > birth_date

Patient's date of birth. (MM/DD/YYYY)

Response > patient_data > List_item > gender_code

The gender of the patient.

  • M = Male
  • F = Female
  • U = Unknown

Response > patient_data > List_item > race_list

The race of the patient.

Response > patient_data > List_item > race_list > code

Internal ID is used to identify this unique entry.

  • 1 = American Indian or Alaska Native
  • 2 = Asian
  • 3 = Black or African American
  • 4 = Native Hawaiian or Other Pacific Islander
  • 5 = White
  • 9 = Other
  • 999 = Declined to specify

Response > patient_data > List_item > race_list > description

Description of race correlating to the code. (See above)

Response > patient_data > List_item > ethnicity

The ethnicity of the patient.

Response > patient_data > List_item > ethnicity > code

Internal ID used to identify this unique entry.

  • 6 = Hispanic or Latino
  • 10 = Not Hispanic or Latino
  • 999 = Declined to Specify

Response > patient_data > List_item > ethnicity > description

The description of ethnicity correlates to the code. (See above)

Response > patient_data > List_item > phone

The phone numbers of the patient. 

Response > patient_data > List_item > phone > home_primary

Patient's home/primary phone number

Response > patient_data > List_item > phone > business_primary

Patient's work phone number

Response > patient_data > List_item > phone > other

Patient's other phone number

Response > patient_data > List_item > address

The address of where the patient lives. 

Response > patient_data > List_item > address > address_1

Patient's street address

Response > patient_data > List_item > address > city

Patient's city

Response > patient_data > List_item > address > state

Patient's state

Response > patient_data > List_item > address > zip

Patient's zip code. 

Response > patient_data > List_item > patient_email

Patient's email address.

Response > problem_list

This will serve as a wrapper for all items that are on the patient's active problem list.

Response > problem_list > List_item

This will serve as a wrapper for all details related to a problem.  This will repeat for each problem in the list.

Response > problem_list > List_item > Problem_list_id

Internal ID used to identify this unique entry.

Response > problem_list > List_item > Priority

The priority of this problem list item for this patient.

Response > problem_list > List_item > Description

Name of the problem as defined by the user who entered it.  This is subject to change from patient to patient even for the same problem.

Response > problem_list > List_item > Code

The ID used to identify this condition - this is usually an ICD-9 or ICD-10 code.

Response > problem_list > List_item > Onset_Date

The date of onset for the given condition.

Response > problem_list > List_item > Short_Description

Short description for the code used to identify this problem.  This description does not change from patient to patient for the given code.

Response > problem_list > List_item > Problem_List_Status_code

Encoded value for the status of the problem.

  • 1 = Active
  •  2 = Inactive
  • 3 = Resolved
  • 4 = Removed

Response > problem_list > List_item > Problem_List_Status_Desc

Description of the problem list status.

Response > problem_list > List_item > Post_date

Date/Time the problem was added to the application.

Response > problem_list > List_item > Chronic_ind

An indicator for the specified problem is considered to be a chronic ailment.

  • Y = Yes (chronic)
  • N = No (not chronic)

<document_list>
            <list_item>
                <image_menu_xref_id>3133</image_menu_xref_id>
                <menu_id>6</menu_id>
                <menu_path>Patient Import.Import Drawer.Import Folder</menu_path>
                <image_name>Karls test fax converted to PDF by MSWord 365 Save As.pdf</image_name>
                <creation_date>08/11/2021 11:02AM</creation_date>

Response > document_list

This element will serve as a wrapper for all eDocuments returned in the response.

Response > document_list > list_item

This element will serve as a wrapper for each eDocument returned in the response.

Response > document_list > list_item > image_menu_xref_id

This element is crucial for vendors intending to return the document contents. This ID represents an individual eDocument in the patient chart and is used within GetPatientFilterDataImage to return the image.

Response > document_list > list_item > menu_id

Serves as the identifier for the folder the eDocument is saved within.

Response > document_list > list_item > menu_path

A dot-notation representation of the location of the document within the eDocuments folder structure.

Response > document_list > list_item > image_name

Represents the filename of the eDocument. 

Response > document_list > list_item > creation_date

Represents the date the image has been added to the patient chart.

Response > medication_list

This will serve as a wrapper for all items that are on the patient's medication list.

Response > medication_list > List_item

This will serve as a wrapper for all details related to a medication.  This will repeat for each medication in the list.

Response > medication_list >  List_item > prescription_id

Internal ID used to identify this unique entry.

Response > medication_list >  List_item > start_date

Date medication was prescribed.

Response > medication_list >  List_item > stop_date

Date where medication was stopped.

Response > medication_list >  List_item > short_name

The drugs' short name.

Response > medication_list >  List_item > drug_short_name

The drugs' short description/name.

Response > medication_list >  List_item > drug _name

The drugs' full name.

Response > medication_list >  List_item > status_code

Internal ID used to identify this unique entry.

  • 0 = Ineffective
  • 1 = Allergic Reaction
  • 2 = Current
  • 3 = Expired
  • 4 = Stopped
  • 5 = New
  • 6 = Overdosed
  • 7 = Drug Interaction
  • 8 = Other
  • 9 = Need Dr. Approval
  • 10 = Change
  • 11 = Discontinue
  • 12 = Renew
  • 13 = Hold
  • 14 = Error
  • 15 = Completed
  • 16 = Side Effects
  • 17 = Discontinue Financial

Response > medication_list >  List_item > status_desc

The description of the medication status correlates to the code. (See above)

Response > medication_list >  List_item > patient_reported

Was the medication patient-reported, if No it indicates this was prescribed by a provider in the database

  • Y = Yes
  • N = No

Response > medication_list >  List_item > refilled

Was the medication refilled.

  • Y = Yes
  • N = No

Response > medication_list >  List_item > refilled_from

Response > lab_list

This will serve as a wrapper for all items that are on the patient's lab list.

Response > lab_list > List_item

This will serve as a wrapper for all details related to a medication.  This will repeat for each medication in the list.

Response > lab_list > List_item > lab_requisition_id

The requisition number for the order/result. 

Response > lab_list > List_item > order_item_code

The order's test code. 

Response > lab_list > List_item > order_item_desc

The name of the order. 

Response > lab_list > List_item > order_result_code

The order's result code. 

Response > lab_list > List_item > order_result_desc

The description of the result

Response > lab_list > List_item > result_date

The date and time the results were received. 

Response > lab_list > List_item > collection_date

The date and time the order was placed.

Response > lab_list > List_item > result_value

The value of the results. 

Response > lab_list > List_item > result_range

The range of the results. 

Response > lab_list > List_item > result_status

The status of the results. 

Response > lab_list > List_item > unit_of_measure

How many times this order was placed. 

Response > lab_list > List_item > abnormal_flag

Were the results abnormal. 

Response > lab_list > List_item > lab_id

The labs id number

Response > lab_list > List_item > note_list

This will serve as a wrapper for all items that are on the patient's note's list for the lab.

Response > lab_list > List_item > note_list > List_item

This will serve as a wrapper for all details related to a lab result.  This will repeat for most lab results in the list.

Response > lab_list > List_item > note_list > List_item > note_sequence_id

What order the notes go in. 

Response > lab_list > List_item > note_list > List_item > note_text

The note itself. 

Response > appointment_list

This will serve as a wrapper for all items that are on the patient's appointment list.

Response > appointment_list > List_items

This will serve as a wrapper for all details related to an appointment.  This will repeat for each appointment in the list.

Response > appointment_list > List_item > appointment_id

Internal ID used to identify this unique entry.

Response > appointment_list > List_item > appointment_status_id

Internal ID used to identify this unique entry. These IDs are specific to the client's database. A complete list can be requested.

Response > appointment_list > List_item > appointment_status_desc

The description of the appointment status correlated to the code. (See above)

Response > appointment_list > List_item > appointment_type_id

Internal ID used to identify this unique entry. These IDs are specific to the client's database. A complete list can be requested.

Response > appointment_list > List_item > appointment_type_desc

The description of the appointment type correlated to the code. (See above)

Response > appointment_list > List_item > appointment_start

When the appointment started (date and time) (MM/DD/YYYY  HH:MM AM/PM)

Response > appointment_list > List_item > appointment_end

When the appointment ended (date and time) (MM/DD/YYYY  HH:MM AM/PM)

Response > appointment_list > List_item > chief_complaint 

The reason for the appointment

Response > appointment_list > List_item > scheduled_with

Who appointment is scheduled with. 

Response > appointment_list > List_item > service_location_name

Name where appointment took place.

Response > appointment_list > List_item > service location address

The address of the service location.

Response > appointment_list > List_item > service location address > address_1

The street address of the service location.

Response > appointment_list > List_item > service location address > city

The city of the service location.

Response > appointment_list > List_item > service location address > state

The state of the service location. 

Response > appointment_list > List_item > service location address > zip

The zip code of the service location. 

Response > appointment_list > List_item > service location address > country

The country of the service location. 

Response > diagnosis_list

This will serve as a wrapper for all items that are on the patient's diagnosis list.

Response > diagnosis_list > List_item

This will serve as a wrapper for all details related to a diagnosis.  This will repeat for each diagnosis in the list.

Response > diagnosis_list > List_item > diagnosis_id

Internal ID used to identify this unique entry.

Response > diagnosis_list > List_item > from_date

Diagnosis start date.

Response > diagnosis_list > List_item > to_date

Diagnosis end date.

Response > diagnosis_list > List_item > procedure_code

The CPT code.

Response > diagnosis_list > List_item > procedure_code_desc

The description of the CPT code.

Response > diagnosis_list > List_item > diagnosis_code_1

ICD-9 or ICD -10 code.

Response > diagnosis_list > List_item > diagnosis_code_1_desc

The description of the ICD-9 or ICD -10 code. 

Response > diagnosis_list > List_item > diagnosis_code_1_type

Will let you know if the diagnosis type is ICD-9 or ICD-10 

Response > diagnosis_list > List_item > pos

Place of service

Response > diagnosis_list > List_item > tos

Type of service

Response > diagnosis_list > List_item > units

Number of times this diagnosis has been billed

Response > diagnosis_list > List_item > rendering_provider_id

Rendering provider's internal ID number.

Response > diagnosis_list > List_item > rendering_provider_name

Rendering provider's full name.

Response > diagnosis_list > List_item > referring_provider_id

Referring provider's internal ID number. 

Response > diagnosis_list > List_item > referring_provider_name

Referring provider's full name. 

Response > soap_list > List_item

This will serve as a wrapper for all items that are on the patient's SOAP note list.

Response > soap_list > List_item

This will serve as a wrapper for all details related to a SOAP note.  This will repeat for each SOAP note in the list.

Response > soap_list > List_item > soap_note_id

Internal ID used to identify this unique entry.

Response > soap_list > List_item > encounter_date

The date the SOAP note was created.

Response > soap_list > List_item > owner_name

The name of who created the SOAP note

Response > soap_list > List_item > signoff_level

The level of the person of signoff. 

Response > soap_list > List_item > signoff_desc

Name of who Signed Off on the SOAP note.

Response > soap_list > List_item > html

This will just contain style tags and headers for this SOAP notes