iSalusCommunication.MailSend

Overview

The iSalusCommunication.MailSend webservice is used to send a communication to a specific user or user group.  This can be found here:  My Task > Communications > Inbox. The webservice will accept a subject, message, priority, user(s), or a user group to send to and attachments (in most cases a patient chart). 

Sample Call

Request

<request xmlns="http://www.isalushealthcare.webservices/">
    <security>
        <key>REDACTED</key>
        <version>1.0</version>
        <userid />
        <account>REDACTED</account>
    </security>
    <subject>This is the subject of the message</subject>
    <message>Here is the communication body.</message>
    <priority>1</priority>
    <communication_list>
        <communication_user>U?332</communication_user>
        <communication_user>U?89</communication_user>
        <communication_user>G?2</communication_user>
    </communication_list>
    <attach_list>
        <attach_item>
            <type>P</type>
            <value>25007</value>
        </attach_item>
    </attach_list>
</request>

Response

<response xmlns="http://www.isalushealthcare.webservices/">
    <mail_id>2036</mail_id>
</response>


Element Description

Request

The Request element will serve as a wrapper for the entire body of the XML request. Required items are marked with "*".

Request > Security*

See documentation for the Security node here:  Access to Webservices

Request > Subject*

The subject of the mail message to be received. This will accept alphanumeric entries. 

Request > Message*

Content of the message body to be received. Accepts alphanumeric entries.

Request > Priority

Defines the level of priority for the mail message. This is shown to the user as an icon, if the priority is set to high, then the user(s) may receive a notification on their mobile device. This will accept the following encoded values:

  • 1 = Low Priority
  • 2 = Normal Importance
  • 3 = High Importance

Request > Communication_List

Will serve as a wrapper for the recipient (To...) list. This will accept encoded user ids and user group ids.

Request > Communication_List > Communication_User

Each use of this element will serve as the encoded value for either a user or user group a message is being sent to.
User: U?{UserID#}
User Groups: G?{UserGroupID#}

Use the iSalusWindow.GetList webservice to obtain the user and user group encoded values.

Request > Attach_List

Serves as a wrapper for all attachments on a message. This includes the patient chart.

Request > Attach_List > Attach_Item

Serves as a wrapper for each attachment. 

Request > Attach_List > Attach_Item > Type

The type defines the attachment type and will accept these encoded values:

  • P = Patient Chart
  • C = Claim
  • I = Individual eDocument
  • G = Grouped Document

Request > Attach_List > Attach_Item > Value

The value will accept an integer and is determined by type element:

  • P (Patient Chart) = Chart Number / Patient ID
  • C (Claim) = Claim ID
  • I (Individual Document) = Doc ID 
  • G (Grouped Document) = Group ID

Response

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

Response > Mail_ID

Once the request is submitted the response element will contain the mail ID created for the communication. This indicates success.