Secure Message

Data to represent Secure Message.
Secure Message data has following elements:
messageId(string)Unique message id.
referenceId(string)Reply-To or Forward original message id. Used to combine messages into conversations.
patientId(string)Patient ID (PM identifier).
providerId(string)Provider ID (PM identifier).
messageTypeid(string)See Message Types below.
subject(string)Message Subject (plain text).
messageBody(string)Message Body (plain text).
attachments(array)Array of Message Attachment items.
createdTime(string)Message creation timestamp.
readTime(string)Message read timestamp.
  • referenceId not always could be provided.
  • Set referenceId to NULL or empty to start a new conversation.
  • When Reply or Forward, set referenceId to an ID of ogiginal message.

Message Types:

  • 1 - General Questions
  • 2 - Billing Questions
  • 3 - Chart Correction
  • 4 - Lasik Inquiries
  • 5 - Optical Questions
  • 6 - Medical Questions
  • 7 - Rx Refills
  • 8 - Clinical Messages
This list is not completed. TBD what values to use - "global" (same for all practices) or practice specific values.
Provider account must be created on a Portal before posting any messages from/to that account.
Patient' account will be created automatically if patient does not have one.

Secure Message examples:

XML: JSON: 
{
  "patientId": "TS01831451",
  "providerId": "2",
  "messageTypeId": 1,
  "messageId": "529de16f-0ad4-434f-ba59-dd06b55e10db",
  "referenceId": "bbaa99fa-5b52-4469-b0bb-81e3c6844832",
  "subject": "Message from doctor",
  "messageBody": "John, \r\n Attached please find out some documents for you. \r\n. Thanks.",
  "createdTime": "4/1/2016 11:52:26 AM",
  "readTime": null,
  "attachments": [
    {
      "attachmentId": "529de16f-0ad4-434f-ba59-dd06b55e10db:329",
      "documentId": "66744316-FD01-4637-918C-0B0033A81A4C",
      "documentName": "Some PDF file for patient",
      "originalFileName": "SBInterface.pdf",
      "mimeType": "application/pdf",
      "formatTypeId": 1,
      "fileContent": "TwBuAGwAaQBuAGUAIABQAGEAdABpAGUAbgB0ACAAQwBvAG0AbQB1AG4AaQBjAGEAdABpAG8AbgAgAFUAbgBpAHEAdQBlAGwAeQAgAEQAZQBzAGkAZwBuAGUAZAAgAGYAbwByACAATwBwAGgAdABoAGEAbABtAG8AbABvAGcAeQANAAoAVABlAG4AIAB5AGUAYQByAHMAIABhAG4AZAAgAGcAcgBvAHcAaQBuAGcAIABzAHQAcgBvAG4AZwAsACAAUwBvAHAAaAByAG8AbgBhACAAcwBlAHQAcwAgAHQAaABlACAAcwB0AGEAbgBkAGEAcgBkACAAaQBuACAAbwBuAGwAaQBuAGUAIABwAGEAdABpAGUAbgB0AC0AcABoAHkAcwBpAGMAaQBhAG4AIABjAG8AbQBtAHUAbgBpAGMAYQB0AGkAbwBuACAAcwBlAHIAdgBpAGMAZQBzACAAYQBuAGQAIAB0AGUAYwBoAG4AbwBsAG8AZwB5ACAAZgBvAHIAIABvAHAAaAB0AGgAYQBsAG0AbwBsAG8AZwB5AC4ADQAKAFMAbwBwAGgAcgBvAG4AYQAgAGkAcwAgAHQAaABlACAAcABvAHcAZQByACAAYgBlAGgAaQBuAGQAIAB0AGgAZQAgACMAMQAgAGMAaABvAGkAYwBlACAAbwBmACAAbgBlAGEAcgBsAHkAIAAyACwAMAAwADAAIABlAHkAZQAgAGQAbwBjAHQAbwByAHMAIABhAG4AZAAgAGMAbABpAG4AaQBjAGEAbAAgAHMAdABhAGYAZgAgAG4AYQB0AGkAbwBuAHcAaQBkAGUALgANAAoAUABhAHIAdABuAGUAcgBpAG4AZwAgAHcAaQB0AGgAIABsAGUAYQBkAGkAbgBnACAAcAByAGEAYwB0AGkAYwBlACAAbQBhAG4AYQBnAGUAbQBlAG4AdAAgAGEAbgBkACAAZQBsAGUAYwB0AHIAbwBuAGkAYwAgAG0AZQBkAGkAYwBhAGwAIAByAGUAYwBvAHIAZABzACAAcAByAG8AdgBpAGQAZQByAHMALAAgAFMAbwBwAGgAcgBvAG4AYQAgAGQAZQBsAGkAdgBlAHIAcwAgAGkAbgBuAG8AdgBhAHQAaQB2AGUAIABzAG8AbAB1AHQAaQBvAG4AcwAgAHAAdQByAHAAbwBzAGUAIABiAHUAaQBsAHQAIAB0AG8AIABpAG4AYwByAGUAYQBzAGUAIABwAHIAbwBmAGkAdABzACAAYQBuAGQAIABwAGEAdABpAGUAbgB0ACAAZQBuAGcAYQBnAGUAbQBlAG4AdAAuAA==",
      "createdTs": "\/Date(1458057146001)\/"
    },
    {
      "attachmentId": "529de16f-0ad4-434f-ba59-dd06b55e10db:1",
      "documentId": "8e72a539-12bd-4b82-a1ce-aa25bb63abba",
      "documentName": "Sophrona info",
      "originalFileName": "ReadMe.txt",
      "mimeType": "text/plain",
      "formatTypeId": 2,
      "fileContent": "Online Patient Communication Uniquely Designed for Ophthalmology\r\nTen years and growing strong, Sophrona sets the standard in online patient-physician communication services and technology for ophthalmology.\r\nSophrona is the power behind the #1 choice of nearly 2,000 eye doctors and clinical staff nationwide.\r\nPartnering with leading practice management and electronic medical records providers, Sophrona delivers innovative solutions purpose built to increase profits and patient engagement.",
      "createdTs": "\/Date(1458057146001)\/"
    }
  ]
}

See also:

API Data, GetMessagesFromPatient function , PostMessagesToPatient function , Attachment data