Secure Messages

Secure Messages are web-based. The Patient Portal gives patients secure and convenient access to their health information. Patients can use the Patient Portal to view, download, and transmit their health information, and send secure messages to their provider. This feature allows the user to view and modify patient secure messages.

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

Endpoints

Get all messages from patient's specific message-thread

GET
/v1/{practiceid}/patients/{patientid}/securemessage/{messagethreadid}
Retrieves messages associated to a specific message-thread for a specific patient
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
patientid integer patientid
messagethreadid integer messagethreadid

Output Parameters

Expand all
documentid integer ID of the document
enterpriseid integer ID of the patient
messagelist array Internal value of the messages
subject string Subject of the message
Example Code

Get patient's reply-access rights for specific message thread

GET
/v1/{practiceid}/patients/{patientid}/securemessage/{messagethreadid}/CanPatientReplyToMessage
Retrieves information on the access right for a patient to respond to the specific message
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
patientid integer patientid
messagethreadid integer messagethreadid

Output Parameters

Expand all
Example Code

Submit new reply to a specific message-thread

POST
/v1/{practiceid}/patients/{patientid}/securemessage/{messagethreadid}/reply
Sends a reply to a specific message-thread
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
patientid integer patientid
messagethreadid integer messagethreadid
Content-Type string Content type of the payload

❙ Request Body

Expand all
text string The body of the reply to send

Output Parameters

Expand all
error string Can be 0 for no error or a string containing an error message.
message object Get messages for a patientid
Example Code

Get list of archived messages

GET
/v1/{practiceid}/patients/{patientid}/securemessage/archivedmessages
Retrieves a list of messages archieved by specific patient
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
patientid integer patientid
showplaintext string If Y, returns the TEXT attribute in plaintext.
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
documentid integer ID of the document
enterpriseid integer ID of the patient
messagelist array Internal value of the messages
subject string Subject of the message
Example Code

Get list of inbox messages

GET
/v1/{practiceid}/patients/{patientid}/securemessage/inboxmessages
Retrieves a list of messages in the patient's inbox
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
patientid integer patientid
showplaintext string If Y, returns the TEXT attribute in plaintext.
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
documentid integer ID of the document
enterpriseid integer ID of the patient
messagelist array Internal value of the messages
subject string Subject of the message
Example Code

Get list of sent-messages

GET
/v1/{practiceid}/patients/{patientid}/securemessage/sentmessages
Retrieves a list of messages responded or sent by the patient to the practice
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
patientid integer patientid
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
documentid integer ID of the document
enterpriseid integer ID of the patient
messagelist array Internal value of the messages
subject string Subject of the message
Example Code

Get department mapping information for patient-messaging

GET
/v1/{practiceid}/patientsecuremessage/providers/departmentsmapping
Retrieves the department mapping information for patient messaging
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
providerids array One or more ID's of the Provider
departmentids array One or more ID's of the Department
communicatorbrandid integer ID of the Brand
providergroupids array One or more ID's of the ProviderGroup

Output Parameters

Expand all
Example Code

mark labresult as Read

POST
/v1/{practiceid}/patients/{patientid}/patientsecuremessage/marklabresultread/{messagethreadid}
updates the specified LabResult has been read by the patient or a family member on the patient portal
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
patientid integer patientid
messagethreadid integer messagethreadid
Content-Type string Content type of the payload

Output Parameters

Expand all
success string Returns true if operation was a success.
Example Code