A collection of administrative messages going from the same sender to
the same destination. The messages are only related to each other in that they are
being sent by the same sender (e.g. a specific practice) to the same destination
(e.g. Intuit). They are just being transmitted at the same time.
The device that is sending the
messages.
The partner (e.g. AllScripts), if any, that is managing
the sender.
The device that is to receive the
messages.
Any combination of administrative
messages.
A secure message not associated with a pre-defined
purpose
Ask the practice or a staff member a question,
including any back and forth messages in either direction clarifying
the question and requesting or providing additional
information.
Answer a patient's question (earlier in the message
thread).
An administrative message sent between two known actors. It is much
like an email, and can contain free text and a number of "file"
attachments.
The identity of the actor that sent the message. This is an
external (non-Intuit) identity.
The identity of the actor that is to receive the message. This
is an external (non-Intuit) identity.
A short string describing the intent and/or contents of the
message
The date and time that the message was sent. This should be an
absolute date time (UTC or including time zone offset). If omitted, the
receiver should assume the current time.
A universally unique identifier that identifies the message
thread (a multi-message conversation) that this message belongs to. When
replying to an existing message the sender should copy this value, otherwise
use a new unique value. If omitted, the receiver should generate a new
unique value.
Indicates whether the sender wants to allow a patient reply to
this message. If omitted in a message to a patient, the value 'false' is
assumed.
Indicates whether the sender wants to allow patient
attachments in the reply to this message. If omitted in a message to a
patient, the value 'false' is assumed.
The free-text message content.
An arbitrary number of file attachments, such as images, pdf
files, etc.
Type of the message to be more specific.
A sender-generated universally unique identifier that uniquely
identifies this message.
Message Type.
Represents a file attachment such as an image, pdf file,
etc.
The name of the attachment, generally a file name and type -
e.g. testResult.pdf
The MIME type of the body - e.g. image/jpeg
The data of the attachment, Base64 encoded.
A secure message is much like an email, and can contain free text and
a number of "file" attachments.
An administrative message with a specific pre-defined purpose. For
example, a patient requesting an appointment or a staff member noting the renewal of
a prescription. Note that the practice is available from the URL of the REST
request, and the patient is available as either the sender or recipient of the
administrative message depending upon its direction.
The status of the request.
The identity of the staff member (if any) associated
with the request. This is an external (non-Intuit)
identity.
The identity of the location (if any) associated with
the request. This is an external (non-Intuit)
identity.
Status of the Secure Message
A new request from the patient.
Follow up conversation (from either the practice or patient) about an existing "open" request.
The final response to the patient's request from the practice.
Ask the practice a question, including any back and forth messages in
either direction clarifying the question and requesting or providing additional
information. The question has a practice-specific pre-defined type, typically
indicating which group of staff members it is intended for. For example, the
question might involve doctors, nurses, billing questions, etc. Optionally, the
question may be directed to a specific staff member within the group or to a
specific location.
The practice-specific pre-defined question type. For
example "Ask a Nurse".
Answer the previously asked question in this message
thread.