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.
Endpoints
- Primary
Get list of user-messages (internal emails)
Input Parameters
Expand all❙ required
Output Parameters
Expand allSend a new user-message (internal email)
Input Parameters
Expand all❙ required
❙ Request Body
Expand allOutput Parameters
Expand allUpdate specific user-message (internal email)
Input Parameters
Expand all❙ required
Output Parameters
Expand allDelete specific user-message (internal email)
Input Parameters
Expand all❙ required