iSalusPatient.UpdateSetup

Overview

The iSalusPatient.UpdateSetup webservice is used to modify information on the Patient Demographics setup screen found here:  Setup > Patients > Demographics. The webservice will accept a patient ID and the fields that need to be updated as an input.

Sample Call

Request

<request>
    <security>
        <key>REDACTED</key>
        <version>1.0</version>
        <userid />
        <account>REDACTED</account>
    </security>
    <patient_id>9388</patient_id>
    <first_name>Blake</first_name>
    <marital_status>S</marital_status>
</request>

Response

Patient Updated Successfully

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

Error Occurred

<response xmlns="http://www.isalushealthcare.webservices/">
    <error>
        <code>1</code>
        <description>Invalid patient</description>
    </error>
</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

Chat number for the patient data you would like to update.

Request > external_identifer_1

Sets the Old Patient ID 1 field.

Request > external_identifer_2

Sets the Old Patient ID 2 field.

Request > external_identifer_3

Sets the Old Patient ID 3 field.

Request > first_name

Patient first name

Request > last_name

Patient last name

Request  > middle_name

Patient middle name

Request  > nick_name

Patient nick name

Request  > name_siffux

Patient fuffix

Request  > gender_code

Patient gender. Represented as M = Male, F = Female, U = Unknown.

Request  > birth_date

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

Request  > date_of_death

Patient date of death (RHC Date).  Formatted as MM/DD/YYYY.

Request  > email

Patient e-mail address

Request  > ethnicity_id

ID representing patient ethnicity.

  • 6 = Hispanic or Latino
  • 10 = Not Hispanic or Latino

Request  > Primary_ID

ID Type used for patient primary ID.  

  • 34 = SSN
  • EI = Employee ID
  • MI = Member ID
  • ZZ = Mutually Defined

Request  > Primary_ID_Value

The value for the patient that corresponds to the primary ID type.  For example, the actual SSN for the patient.

Request  > Secondary_ID

ID Type used for patient secondary ID.  

  • 1W = Member ID
  • A6 = Employee ID
  • AZ = Health Ins. Policy #
  • NQ = Medicaid Rec. ID
  • OT = Other
  • SY = SSN

Request > Secondary_ID_Value

The value for the patient that corresponds to the secondary ID type.  For example, the actual SSN for the patient.

Request> Primary_care_eid

The internal entity ID for the primary care provider assigned to the patient.

Encode value can be obtained from webservice iSalusWindow.GetList where <name> = referring_provider

Request > Practice_physician_eid

The internal entity ID for the  primary doctor assigned to the patient from the practice.

Encode value can be obtained from webservice iSalusWindow.GetList where <name> = rendering_provider

Request > Marital_status

The marital status for the patient.

  • D = Divorced
  • M = Married
  • S = Single
  • U = Unknown
  • W = Widowed
  • X = Legally Separated

Request > Employer

The name of the employer.

Request > student_type

The student status of the patient.

  • No = Not a student
  • Full = Full time student
  • Part = Part time student

Request > Employed

The employment status of the patient.

  • 1 = Employed full time
  • 2 = Employed part time
  • 3 = Not employed
  • 4 = Self employed
  • 5 = Retired
  • 6 = On active military duty
  • 9 = Unknown

Request > Signature_on_File

The flag to indicate of signature is on file for the patient.  

  • 1 = Yes
  • 0 = No

Request > Signature_on_File_Date

The date the signature is on file.

Request > Active_ind

The flag to indicate if the patient is either active or inactive. 

  • Y = Yes
  • N = No

Request > Report_Ind

The flag to indicate if the patient is either reportable or not reportable. 

  • Y = Yes
  • N = No

Request > Referring_eid

The internal entity ID for the referring provider assigned to the patient.

Encode value can be obtained from webservice iSalusWindow.GetList where <name> = referring_provider

Request > Rx_History_Consent

The flag to indicate if the patient has given consent to obtaining medication history through Surescripts. 

  • N = No Consent
  • P = Prescriber Only
  • X = Parental/Guardian Consent
  • Y = Consent Given
  • Z = Parental/Guardian Prescriber Only

Request > Language_ID

The ID representing the patient's primary language.

  • 1 = Arabic
  • 2 = Bengali
  • 3 = English
  • 4 = French
  • 5 = Gernal
  • 6 = Hindu/Urdu
  • 7 = Japanese
  • 8 = Mandarin Chinese
  • 9 = Portuguese
  • 10 = Russian
  • 11 = Spanish
  • 12 = Tagalog
  • 13 = Italian
  • 14 = Other

Request > Reminder_id

The ID representing the patient's preferred reminder method.

  • 9 = NO Reminder
  • 1 = Letter
  • 2 = Patient Portal
  • 3 = Phone Home
  • 4 = Phone Other
  • 5 = Phone Work
  • 6 = Phone Home (No VM)
  • 7 = Phone Other (No VM)
  • 8 = Phone Work (No VM)

Request > Phone_home

A wrapper to contain elements related to the patient's home phone number.

Request > Address1

Address line 1 for the patient. Typically street address.

Request > Address2

Address line 2 for the patient. Typically suite/apartment number.

Request > City

City for the patient address.

Request > State

State for the patient address.

Request > Zip_Code

Zip code for the patient address.

Request > Phone_home > Ph_number

The element containing the patient phone number.

Request > Phone_home > Extension

The element containing the extension for the phone number.

Request > Phone_work

A wrapper to contain elements related to the patient's work phone number.

Request > Phone_work > Ph_number

The element containing the patient phone number.

Request > Phone_work > Extension

The element containing the extension for the phone number.

Request > Phone_other

A wrapper to contain elements related to the patient's other phone number.

Request > Phone_other > Ph_number

The element containing the patient phone number.

Request > Phone_other > Extension

The element containing the extension for the phone number.

Request > Race

A wrapper to contain elements related to the patient's race.

Request > Race > race_id

An ID representing the patient race. 

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