The Attachment Object

id	The unique ID of the attachment.
content	The content (String or byte array) to store for the attachment.
charset	If the content passed in is a string, this is the charset encoding to convert the string to bytes with. If the content is a String and a charset is not used, UTF-8 will be used as the charset.
type	The MIME type of the attachment.

Mirth® Connect by NextGen Healthcare User Guide

The AttachmentUtil Class

All of the Built-In Attachment Functions are also available from the AttachmentUtil utility class available from the User API. In addition to this, AttachmentUtil has some extra methods available that you can use to re-attach attachment data into a message string. For more information, check out the AttachmentUtil class in your locally hosted User API: The User API (Javadoc) You can also view the documentation for this class here: http://javadocs.mirthcorp.com/connect/3.6.0/user-api/com/mirth/connect/server/userutil/AttachmentUtil.html Parent topic: Attachment JavaScript Functions

Mirth® Connect by NextGen Healthcare User Guide

Attachment JavaScript Functions

Attachment Handlers are used to extract a portion of a message (or the entire message) and store it separately as an attachment. The portion of the message that was extracted is replaced with an attachment replacement token. When you use a destination connector to send a message downstream, Mirth® Connect will automatically take the message and replace any attachment tokens with the actual attachment data (unless you have Reattach Attachments turned off in the Destination Settings) . Throughout the message lifecycle you can retrieve, modify, and add new attachments with built-in helper functions. Built-In Attachment Functions The AttachmentUtil Class The Attachment Object Examples Built-In Attachment Functions The AttachmentUtil Class The Attachment Object Examples Parent topic: Mirth Connect and JavaScript

Mirth® Connect by NextGen Healthcare User Guide

Extract Attachments

Use the following method to extract and store attachments from the attachment script: The resulting Attachment object contains the ID you need to inject back into the message. For more information, look at the User API. The return value for the JavaScript attachment script should be the final message string, with any attachments extracted out and replaced with attachment replacement tokens. addAttachment(data, type) Creates and stores an attachment for the current message. Table 1. Parameters Name Type Description data String or Byte array The actual attachment data to insert. Man be either a String or a byte array. If a string is used, it is assumed to be a Base64 encoded representation of the actual attachment data. type String The MIME type of the attachment. For additional information see Attachment Handlers. <Return Value> Attachment The inserted Attachment object. The resulting Attachment object contains the ID you need to inject back into the message. For more information, look

Mirth® Connect by NextGen Healthcare User Guide

Built-In Attachment Functions

getAttachmentIds() Get a List containing the IDs of all Attachments associated with this message. Uses the current connectorMessage variable. getAttachmentIds(channelId, messageId) Get a List containing the IDs of all Attachments associated with any channel / message. channelId The ID of the channel associated with the attachments. messageId The ID of the message associated with the attachments. getAttachments(base64Decode) Get List of Attachments associated with this message. This will get all attachments that have been added in the source and destination(s). base64Decode If true, the content of each attachment will first be Base64 decoded for convenience. getAttachment(attachmentId, base64Decode) Get a specific Attachment associated with this message. Uses the current connectorMessage variable. attachmentId The ID of the attachment to retrieve. base64Decode If true, the content of the attachment will first be Base64 decoded for convenience. getAttachment(channelId, messageId, attachm

Mirth® Connect by NextGen Healthcare User Guide

JavaScript Reader Return Values

If you are using the JavaScript Reader to produce messages for the channel, all you need to do is return those messages from the script. The following return values are accepted: String: Any non-empty string returned will be sent to the channel as a message. RawMessage: This is a special object that contains not only the string message data, but also information about which destinations to dispatch to, and any source map variables you wish to inject. For additional information, see The User API (Javadoc). List: If a Java List is returned, all values in the list will be sent to the channel as discrete messages. The list may contain a mix of Strings, RawMessage objects, or other objects. Empty String / null / undefined: Returning any of these (including just a "return;" statement or no return statement at all) will cause no messages to dispatch to the channel. Any Object: Any other object returned will be converted to a String via the toString() method, and that String representation wil

Mirth® Connect by NextGen Healthcare User Guide

Examples

Modify a previously attached CCD attachment: var ccd = new XML(getAttachment(attachmentId, true).getContentString());ccd.id.@root = 'testing';updateAttachment(attachmentId, ccd.toString(), 'text/xml', true); Read in a PDF from the filesystem and add it as an attachment: var fileBytes = FileUtil.readBytes('/path/to/file.pdf');// Pass in true for Base64Encode, since the content isn't already Base64 encodedaddAttachment(fileBytes, 'application/pdf', true); Parent topic: Attachment JavaScript Functions

The Attachment Object

Recommendations

The AttachmentUtil Class

Attachment JavaScript Functions

Extract Attachments

Built-In Attachment Functions

JavaScript Reader Return Values

Examples