Messages REST Endpoints

Sort by

Task Path Method

Description

Messages

This topic describes information for the Messages service.

The Messages resource supports secure messaging workflows between a patient and their care teams.

A list of a patient's inbox items can be retrieved for a specified date range. The status of the message, such as Unread or Opened, can be used to differentiate the patient's inbox items from trash items in a deleted status. By default, the list of messages is sorted by the date and time the message is created in descending order. The sort order can be adjusted to ascending order, and the option to sort the list of messages by priority is also available. The list of inbox items is currently limited to 1000. If more than 1000 items are in the list, an indicator is provided in the list response. Additionally, you can specify whether organization information that pertains to the encounter associated with the message is returned in the list response.

A list of the patient's sent items can be retrieved for a specified date range. By default, the list of messages is sorted by the date and time the message is created in descending order. The sort order can be adjusted to ascending order, and the option to sort the list of messages by priority is also available. The list of sent items is not restricted to 1000 and all sent items that match the supplied criteria are returned.

The status of a message in the patient's inbox can be updated, and the following status transitions are supported:

• Unread to Opened
• Opened to Unread
• Opened to Deleted
• Unread to Deleted
• Deleted to Unread
• Deleted to Opened

An individual message in the patient's inbox or sent items can be retrieved by the Messages resource.

A new message, reply, or forward can be sent from a patient to a provider or group inbox in Millennium Platform. Oracle recommends that before a message is sent, recipients of the message are validated to ensure that they have a Millennium Platform Message Center configuration.

Messages

The operations from the Messages category.

Determine if given recipients are valid

Method: post

Path: /20241001/actions/validateRecipients

Get a list of messages received by a patient

Method: get

Path: /20241001/patientMessages/inboxItems

Get a list of messages sent by a patient

Method: get

Path: /20241001/patientMessages/sentItems

Get detailed information about a message

Method: get

Path: /20241001/patientMessages/{patientMessageId}

Send a message to a set of recipients

Method: post

Path: /20241001/patientMessages/sentItems

Update the status of the messages

Method: post

Path: /20241001/actions/updatePatientMessageStatus