User Message

The User Message feature allows the user to send emails internally to the a specific recipient or group of recipients.

Usermessages: Intra-office athenaNet email system
The Usermessages functionality serves as an intra-office email system for athenaNet users.

This functionality allows users to communicate with staff via intra-office messages that appear in the recipients' message inbox. This inbox mimics the layout of a traditional email inbox with various folders and can be accessed from within the main athenaNet "Calendar"-Communication-News&Messages. 

Within the athenaNet UI, usermessages can be sent regarding a particular patient via the Patients Action Bar through clicking "Send Message about this Patient." When creating a new message the patient's basic information displays at the top of the page for reference, including date of birth, department, and provider. Additionally, the patient-specific message contains a link to the patient Quickview. Users can also send a message that is not patient-specific. 

Intra-office email through usermessages helps practices communicate important information about specific patients internally across several users and allows for secure user messaging to occur within athenaNet. 

With the API your application can:
•  Retrieve a list of a particular users messages for a folder with GET/usermessages/{username}.
•  Send a message from one particular user to a user or a list of users with POST/usermessages/{username}.
•  Update a message's status to show if it is flagged for follow up, move the message to a new folder, or set if the message has been read with PUT/usermessages/{username}/{messageid} 
•  Move a message to the TRASH folder using DELETE/usermessages/{username}/{messageid}. If this message is already in the TRASH folder, this permanently deletes the message. 

Note: An SSO link can be included in the usermessage sent between users via the API. 
athenaNet users cannot send or receive messages outside their practice using this page and need to enter in a valid username in order for this functionality to work effectively.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Get list of user-messages (internal emails)

GET
/v1/{practiceid}/usermessages/{username}
Retrieves a list of messages for a specific username
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
username string username
showunreadonly boolean Only return unread messages. Defaults to false.
folder string Requested message folder. Can be INBOX, SENT, SAVED, TRASH. Defaults to INBOX.
limit integer Number of entries to return (default 1000, max 10000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
flag string Whether this message has been flagged for followup.
from string The sender of this message.
message string The body of the message.
messageid integer The ID of this message.
priority string The priority of this message. Can be NORMAL, HIGH, or LOW.
read string Whether this message has been read.
sentdate string The date and time this message was sent.
subject string The subject of this message.
to array The list of recipients of this message.
Example Code

Send a new user-message (internal email)

POST
/v1/{practiceid}/usermessages/{username}
Sends a message from the specific user to a list of recipients
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
username string username
Content-Type string Content type of the payload

Output Parameters

Expand all
errormessage string The error message on failure, if any.
success string Whether the message was sent successfully.
Example Code

Update specific user-message (internal email)

PUT
/v1/{practiceid}/usermessages/{username}/{messageid}
Modifies the specific message as either read by the user or is flagged
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
username string username
messageid integer messageid
Content-Type string Content type of the payload

Output Parameters

Expand all
errormessage string The error message on failure, if any.
success string Whether the message was updated successfully.
Example Code

Delete specific user-message (internal email)

DELETE
/v1/{practiceid}/usermessages/{username}/{messageid}
Deletes the specific user message permanetly
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
username string username
messageid integer messageid

Output Parameters

Expand all
errormessage string The error message on failure, if any.
success string Whether the message was deleted successfully.
Example Code