Message

Messages can be sent in message threads. There are three types of messages that can be sent from the EMR:

  • External Messages: External message are messages that can be viewed from both the EMR and patient portal (everyone on the message thread can see the message).
  • Internal Notes: Internal notes can only be viewed on the EMR (patients can not see internal notes). Internal notes are useful when you want to discuss information about patients without the patient seeing it.
  • Pages: Pages are a way to notify organization members that they should check out a message thread ASAP.

Each message can be one of four formats:

  • Regular text
  • Image
  • File
  • Video

The message model


Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the message.

  • Name
    object
    Type
    string
    Description

    Always 'message'.

  • Name
    type
    Type
    string
    Description

    Type of message.

    Possible values:
    external_message
    internal_note
    page
  • Name
    thread
    Type
    string
    Description

    Message thread that this message belongs to.

  • Name
    mode
    Type
    string
    Description

    Only applies if message type is "externalMessage" or "internalNote." Mode/format of the message.

    Possible values:
    text
    image
    file
    video
  • Name
    text
    Type
    string
    Description

    Only applies if message mode is "text." Contents of the text message.

  • Name
    filename
    Type
    string
    Description

    Only applies if message mode is "file." Name of the file.

  • Name
    pagee
    Type
    string
    Description

    Only applies if message type is "page." Which organization member you are trying to page.

  • Name
    memo
    Type
    string
    Description

    Only applies if message type is "page." What message you want to send the pagee.

  • Name
    resolved
    Type
    boolean
    Description

    Only applies if message type is "page." Whether the page is resolved.

  • Name
    resolved_at
    Type
    number
    Description

    Only applies if message type is "page." What time the page was resolved.

  • Name
    created_by
    Type
    string
    Description

    Creator of the message.

  • Name
    created_at
    Type
    number
    Description

    Timestamp (in Unix epoch time in milliseconds) of when the message was created.

Response

{
    "id": "msg_GHY5mso3NpQP90bNHhpp",
    "object": "message",
    "type": "external_message",
    "thread": "thrd_kkF8SgJmcgaTmmziHoCv",
    "mode": "text",
    "text": "Can you take a look at this rash? Sending you a video now",
    "created_by": "user_Z1zXZKvqrpwxbznuW6lJ",
    "created_at": 1653798303000,
}