---
title: Net2Net Clinical Message
slug: net2net-rest/guide/net2net-clinical-message
docTags: 
createdAt: 2026-06-12T09:48:23.871Z
---

A *Clinical* message is used to communicate patient related clinical information between health care providers. It may contain textual data, as well as structured content and file attachments.

**Net2Net Message XML Diagram**

::Image[]{src="https://api.archbee.com/api/optimize/fNEeV2bO-J-V0NK1eH_VR/EXaEWmzZ63tTTOhIciJdV_net2net-clinical-message.png" position="flex-start" size="80" initialPath="../../Resources/Images/Net2Net REST v1.5/Net2Net Clinical Message.png" githubPath="Content/Resources/Images/Net2Net REST v1.5/Net2Net Clinical Message.png" width="500" height="320" darkWidth="500" darkHeight="320" showCaption="false"}

### Sending a Net2Net Clinical Message

To send a Net2Net *Clinical* message, the customer must

1. Collect message content, attachments, and the recipient information;
2. Validate that the message conforms to the schema; and
3. Call the Surescripts API to submit the *Clinical* message(s).

Once a *Clinical* message is sent, the Surescripts API provides a synchronous response to the submission of a message. This response is a Status message "010" if the message was received and delivered; a Status message "000" if the message was accepted for processing, or an Error message if the message could not be accepted for processing.

### Receiving a Clinical Message

To receive a message, customers must set up a server to which Surescripts can send messages. Surescripts will send all messages to the customer as an HTTP POST. The customer system must provide a synchronous response to messages and freestanding Error/Verify messages. See [Detailed Clinical Messaging Workflows](docId\:DQ5r0k-g9dFT4Kt_WANyK) for more information.

### Clinical Document Message XML Diagram

::Image[]{src="https://api.archbee.com/api/optimize/fNEeV2bO-J-V0NK1eH_VR/Q6TxKiB1md6LZJR3kwMOd_net2net-clinical-message1.png" position="flex-start" size="90" initialPath="../../Resources/Images/Net2Net REST v1.5/Net2Net Clinical Message_1.png" githubPath="Content/Resources/Images/Net2Net REST v1.5/Net2Net Clinical Message_1.png" width="684" height="476" darkWidth="684" darkHeight="476" showCaption="false"}

### Net2Net Clinical Message Body Elements

**M/C Mandatory or Conditional**

| **Element**           | **Code**     | **Comments**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| --------------------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ClinicalMessage       | mandatory    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Subject               | mandatory    | The subject of the *Clinical* message.<br />Protected Health Information (PHI) under HIPAA must not be included in the subject.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Document              | mandatory    | Required if sending a *Clinical* message in the message body.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| PlainText             | mandatory    | Example: "ABC Clinic has provided services to the patient named in the attached document. The patient has identified you as their primary care physician."                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| HtmlText              | conditional  | This is optional and allows for content formatting.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| DocumentData          | conditional  | Specifies the additional data in the message. This consists of a collection of items, with a key attribute and the value.<br />Ignore values not supported by your system. For example:<br /><br />\<DocumentData><br />  \<Item key="x-kryptiq-notification">onetime\</Item><br />  \<Item key="x-kryptiq-message-class-type">Standard\</Item><br />  \<Item key="x-kryptiq-trackingid">6dabf2a36fa4406eacd09ce23190ceb1\</Item><br />  \<Item key="x-kryptiq-remotemessagekey">jzcs3dnchvrbhbdvso2eatloj4molg\</Item><br />\</DocumentData><br /><br />**Note**: Empty tags are permitted for use in the DocumentData element. |
| Item                  | mandatory    | Specified data value.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Item/@key             | mandatory    | Identifier of the specified data value.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Attachment            | mandatory    | A collection of one or more attachments. Each occurrence consists of a DocumentName and one (only one) of the document elements.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| DocumentName          | mandatory    | Filename of the document.<br />The file extension should be included.<br />Example: visitsummary.pdf                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| cda\:ClinicalDocument | conditional  | The sender can use this type of attachment to include a CDA attachment.<br />Note: Inline XML is the preferred method for passing the CDA.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| File                  | conditional  | The sender can use this type of attachment to include a file attachment.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| DocumentType          | mandatory    | If a file attachment is included, then a \<DocumentType> must be specified and should be a valid MIME type.<br />For example: application/pdf                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| DocumentVersion       | conditional  | Optional version number for the document.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| DocumentData          | mandatory    | The Base64 Encoded string of the file attachment.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |

