---
title: Consolidated Message Examples
slug: xdr/guide/consolidated-message-examples
docTags:
createdAt: 2026-07-30T21:09:39.181Z
---
This section collects the message examples used throughout the guide into one place and arranges them in the order they occur in a live exchange. It also adds complete examples for scenarios the body describes but does not show in full: a complete failure Delivery Status Notification (DSN) and a complete received message. Each entry notes the section where the example is introduced or discussed.
All examples use the synthetic, illustrative data described in the guide (Example Clinic sending to Example Hospital, patient Jane Doe). The same original message identifier (urn\:uuid:7f4d7c90-d803-4c33-b053-92f77a59c10f) and DSN identifier appear across the examples, so a single message can be traced from submission through delivery notification and acknowledgement.
## Index of Examples
| **Description** | **Direction** | **Format** |
| -------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | --------------- |
| [Message Identification Headers (MessageID / RelatesTo)](docId\:xZ0MTs_W6FVT5WxkvD-Q0) | Send | XML fragment |
| [Patient Identifier in HL7 CX Format](docId\:xZ0MTs_W6FVT5WxkvD-Q0) | Send | Text |
| [Submitting a Message With Curl (Mutual TLS)](docId\:xZ0MTs_W6FVT5WxkvD-Q0) | Send (transport) | Shell |
| [Synchronous Failure Response (RegistryResponse with a RegistryErrorList)](docId\:xZ0MTs_W6FVT5WxkvD-Q0) | Response (sync) | XML |
| [Synchronous Success Response (No Delivery Notification Tracking)](docId\:xZ0MTs_W6FVT5WxkvD-Q0) | Response (sync) | XML |
| [Illustrative Incoming Address Block: Two Recipients Hosted by the Same Receiving System](docId\:XyQrOSGPZ8458uzH0p8sU) | Receive | XML fragment |
| [Direct\:Notification in the Address Block, Linking the DSN to the Original Message](docId\:XyQrOSGPZ8458uzH0p8sU) | Return (DSN) | XML fragment |
| [DSN Success Disposition (Before Base64 Encoding)](docId\:XyQrOSGPZ8458uzH0p8sU) | Return (DSN) | XML |
| [DSN Failure Disposition With a Reason (Before Base64 Encoding)](docId\:XyQrOSGPZ8458uzH0p8sU) | Return (DSN) | XML |
| [Acknowledgment of the DSN (Synchronous Response)](docId\:XyQrOSGPZ8458uzH0p8sU) | Return (sync) | XML |
| [Complete Submission: Minimal Metadata With Document Classifications, MTOM (Attachment Payload Omitted)](docId:4pSAzF9OZZ3BbPh9NMOB7) | Send | Multipart / XML |
| [Complete DSN message (Success)](docId:4pSAzF9OZZ3BbPh9NMOB7) | Return (DSN) | Multipart / XML |
| [Complete DSN Message (Failure)](docId:4pSAzF9OZZ3BbPh9NMOB7) | Return (DSN) | Multipart / XML |
| [Complete Received Message (As Delivered to the Receiving System)](docId:4pSAzF9OZZ3BbPh9NMOB7) | Receive | Multipart / XML |
## End-to-End Exchange (Happy Path, with Delivery Notification)
The happy-path exchange proceeds in four steps, and the same original message identifier links every step. The full submission and DSN messages are shown after the steps below; the shorter responses are shown inline here.
### Step 1 - The sender submits the message.
The customer POSTs the complete Provide and Register Document Set-b request (MTOM / multipart/related) to Surescripts. The full message is in [Complete Submission Message](docId:4pSAzF9OZZ3BbPh9NMOB7), and the curl transport is in the [Submitting a Message With Curl (Mutual TLS)](docId\:xZ0MTs_W6FVT5WxkvD-Q0) example. Its MessageID is urn\:uuid:7f4d7c90-d803-4c33-b053-92f77a59c10f.
### Step 2 - Surescripts returns the synchronous response.
Surescripts accepts the message and returns a synchronous Success response whose RelatesTo carries the original MessageID. If the message could not be accepted, Surescripts would instead return a Failure response ([Synchronous Failure Response (RegistryResponse with a RegistryErrorList)](docId\:xZ0MTs_W6FVT5WxkvD-Q0) Example).
:::CodeblockTabs
Synchronous Success response
```xml
urn:ihe:iti:2007:ProvideAndRegisterDocumentSet-bResponse
urn:uuid:7f4d7c90-d803-4c33-b053-92f77a59c10f
```
:::
### Step 3 - Surescripts returns the DSN.
Once delivery is determined, Surescripts sends the asynchronous DSN back toward the sender as its own Provide and Register Document Set-b transaction. The DSN's RelatesTo and direct\:notification both carry the original MessageID, and the DSN has its own MessageID. See the complete success DSN and failure variant examples in this section
### Step 4 - The sender acknowledges the DSN.
The sender returns a synchronous acknowledgement whose RelatesTo carries the DSN's MessageID, closing the workflow.
:::CodeblockTabs
DSN acknowledgement
```xml
urn:ihe:iti:2007:ProvideAndRegisterDocumentSet-bResponse
urn:uuid:2c8b0e13-9f1a-4b6e-8b5a-6d7e8f901234
```
:::
**Failure path.** If the submission is rejected at Step 2, Surescripts returns [Synchronous Failure Response (RegistryResponse with a RegistryErrorList)](docId\:xZ0MTs_W6FVT5WxkvD-Q0) instead of the Success response, and no DSN follows ([Synchronous Failure Response](docId\:daGa7Uw8ataRiYlZ3RtU9)). If the message is accepted but delivery later fails, Step 3 returns a failure DSN ([Complete DSN Message (Failure)](docId:4pSAzF9OZZ3BbPh9NMOB7)) rather than a success DSN.
## Complete Submission Message
This is the complete submission referenced by [Complete Referral Example](docId\:xZ0MTs_W6FVT5WxkvD-Q0) a referral carrying a C-CDA clinical summary, modeled on a validated production-style message. It uses minimal metadata (note the limitedMetadata classification nodes) while still including the document classifications that full-featured senders commonly send. The C-CDA payload is omitted, with a comment marking where it belongs.
### Complete Submission: Minimal Metadata With Document Classifications, MTOM (Attachment Payload Omitted) Example
:::CodeblockTabs
Example
```xml
Content-Type: multipart/related; type="application/xop+xml"; start=""; start-info="application/soap+xml"; boundary="MIMEBoundary_xdr_example"
--MIMEBoundary_xdr_example
Content-ID:
Content-Transfer-Encoding: 8bit
Content-Type: application/xop+xml; charset=utf-8; type="application/soap+xml"
MIME-Version: 1.0
urn:ihe:iti:2007:ProvideAndRegisterDocumentSet-b
urn:uuid:7f4d7c90-d803-4c33-b053-92f77a59c10f
http://www.w3.org/2005/08/addressing/anonymous
https://[xdr-endpoint-provided-at-onboarding]/DocumentRepository_Service.svc
dr.smith@direct.example-clinic.com
intake@direct.example-hospital.com
minimal
20260722200019
en-US
PATID1234^^^&1.3.6.1.4.1.99999.1&ISO
PID-3|PATID1234^^^&1.3.6.1.4.1.99999.1&ISO
PID-5|Doe^Jane^^^^^L
PID-7|19600615
PID-8|F
PID-11|123 Main St^^Portland^OR^97201^US
28f1b1d1d49a85bdd7a7cb4d7d87eb5d93b8ef45
36100
E12345^Smith^John^^^^MD^^&2.16.840.1.113883.3.9999.2&ISO
Example Clinic^^^^^&2.16.840.1.113883.3.9999&ISO^^^^0001
2.16.840.1.113883.6.1
2.16.840.1.113883.5.25
1.3.6.1.4.1.19376.1.2.3
2.16.840.1.113883.6.96
2.16.840.1.113883.6.96
2.16.840.1.113883.6.1
20260722200019
Example Hospital^^^^^&2.16.840.1.113883.3.9999.3&ISO^^^^0002||^^Internet^intake@direct.example-hospital.com
E12345^Smith^John^^^^MD^^&2.16.840.1.113883.3.9999.2&ISO
Example Clinic^^^^^&2.16.840.1.113883.3.9999&ISO^^^^0001
Referring Physician
Cardiology
^^Internet^dr.smith@direct.example-clinic.com
2.16.840.1.113883.6.1
Original
--MIMEBoundary_xdr_example
Content-ID:
Content-Transfer-Encoding: binary
Content-Type: text/xml
***** The referral C-CDA document bytes belong here. *****
The binary content of the referral attachment is omitted from this example.
This MIME part is referenced by the element in the Document above.
--MIMEBoundary_xdr_example--
```
:::
:::hint{type="info"}
**Note:** This example is for illustrative purposes only, and represents one valid way to construct a message; other structures and metadata combinations are equally valid. Addresses, OIDs, identifiers, demographics, and code values are samples, and the referral document content is omitted where indicated.
:::
## Complete DSN Message - Success
This is the complete success DSN referenced by [Full DSN Message](docId\:XyQrOSGPZ8458uzH0p8sU), delivered as its own ProvideAndRegisterDocumentSet-b transaction back toward the original sender. The a\:RelatesTo header and the direct\:notification element both carry the original message's MessageID, and the Base64-encoded Document decodes to the success disposition.
### Complete DSN Message Example
:::CodeblockTabs
Example
```xml
Content-Type: multipart/related; type="application/xop+xml"; start=""; start-info="application/soap+xml"; boundary="MIMEBoundary_dsn_example"
--MIMEBoundary_dsn_example
Content-ID:
Content-Transfer-Encoding: 8bit
Content-Type: application/xop+xml; charset=utf-8; type="application/soap+xml"
urn:ihe:iti:2007:ProvideAndRegisterDocumentSet-b
urn:uuid:2c8b0e13-9f1a-4b6e-8b5a-6d7e8f901234
urn:uuid:7f4d7c90-d803-4c33-b053-92f77a59c10f
urn:oid:2.16.840.1.113883.3.9999.3
http://www.w3.org/2005/08/addressing/anonymous
intake@direct.example-hospital.com
dr.smith@direct.example-clinic.com
minimal
https://xdr.example-clinic.com/DocumentRepository_Service.svc
20260722200021
^^Internet^intake@direct.example-hospital.com
20260722200021
221
149B15E48A99C96FDFFEF1473D1F71E5EF3FC5A0
Original
PGRpcmVjdDptZXNzYWdlRGlzcG9zaXRpb24geG1sbnM6ZGlyZWN0PSJ1cm46ZGlyZWN0OmFkZHJlc3NpbmciPg0KICA8ZGlyZWN0OnJlY2lwaWVudD5pbnRha2VAZGlyZWN0LmV4YW1wbGUtaG9zcGl0YWwuY29tPC9kaXJlY3Q6cmVjaXBpZW50Pg0KICA8ZGlyZWN0OmRpc3Bvc2l0aW9uPnN1Y2Nlc3M8L2RpcmVjdDpkaXNwb3NpdGlvbj4NCjwvZGlyZWN0Om1lc3NhZ2VEaXNwb3NpdGlvbj4=
--MIMEBoundary_dsn_example--
```
:::
:::hint{type="info"}
**Note:** This example is for illustrative purposes only. The Document value Base64-decodes to the success disposition; the size and hash correspond to that decoded disposition.
:::
## Complete DSN Message - Failure
The body shows the failure disposition body and a complete success DSN (Example C.4-1), but not a complete failure DSN. The example below combines them: a complete DSN transaction whose Base64-encoded Document decodes to the failure disposition (mailbox not found). It is structurally identical to Example C.4-1 except for the disposition payload, its size and hash, and the DSN's own MessageID.
### Complete DSN Message (Failure) Example
:::CodeblockTabs
Example
```xml
Content-Type: multipart/related; type="application/xop+xml"; start=""; start-info="application/soap+xml"; boundary="MIMEBoundary_dsn_failure_example"
--MIMEBoundary_dsn_failure_example
Content-ID:
Content-Transfer-Encoding: 8bit
Content-Type: application/xop+xml; charset=utf-8; type="application/soap+xml"
urn:ihe:iti:2007:ProvideAndRegisterDocumentSet-b
urn:uuid:3d9c1f24-a0b2-4c5d-9e6f-7a8b9c0d1e2f
urn:uuid:7f4d7c90-d803-4c33-b053-92f77a59c10f
urn:oid:2.16.840.1.113883.3.9999.3
http://www.w3.org/2005/08/addressing/anonymous
intake@direct.example-hospital.com
dr.smith@direct.example-clinic.com
minimal
https://xdr.example-clinic.com/DocumentRepository_Service.svc
20260722200521
^^Internet^intake@direct.example-hospital.com
20260722200521
294
0E2C7D036FDB41DEE1538F4ECD47553C384001A0
Original
PGRpcmVjdDptZXNzYWdlRGlzcG9zaXRpb24geG1sbnM6ZGlyZWN0PSJ1cm46ZGlyZWN0OmFkZHJlc3NpbmciPg0KICA8ZGlyZWN0OnJlY2lwaWVudD5pbnRha2VAZGlyZWN0LmV4YW1wbGUtaG9zcGl0YWwuY29tPC9kaXJlY3Q6cmVjaXBpZW50Pg0KICA8ZGlyZWN0OmRpc3Bvc2l0aW9uPmZhaWx1cmU8L2RpcmVjdDpkaXNwb3NpdGlvbj4NCiAgPGRpcmVjdDpyZWFzb25Gb3JGYWlsdXJlPk1haWxib3ggbm90IGZvdW5kLjwvZGlyZWN0OnJlYXNvbkZvckZhaWx1cmU+DQo8L2RpcmVjdDptZXNzYWdlRGlzcG9zaXRpb24+
--MIMEBoundary_dsn_failure_example--
```
:::
:::hint{type="info"}
**Note:** This example is for illustrative purposes only. The Document value Base64-decodes to the failure disposition (a reasonForFailure of "Mailbox not found."). The size and hash correspond to that decoded disposition.
:::
## Complete Received Message
[Message Structure](docId\:XyQrOSGPZ8458uzH0p8sU) notes that a received message carries the same XDS metadata structure as the [Complete Referral Example](docId\:xZ0MTs_W6FVT5WxkvD-Q0) and shows only the incoming address block ([Illustrative Incoming Address Block: Two Recipients Hosted by the Same Receiving System](docId\:XyQrOSGPZ8458uzH0p8sU)). The example below shows a complete message as delivered to a receiving customer's endpoint: the receive-direction address block, the a\:To addressed to the receiving customer's repository, and a submission set with one document entry. The metadata is abbreviated relative to [Complete Submission: Minimal Metadata With Document Classifications, MTOM (Attachment Payload Omitted) Example](docId:4pSAzF9OZZ3BbPh9NMOB7); a received message may carry the full classification set shown there.
### Complete Received Message (As Delivered to the Receiving System) Example
:::CodeblockTabs
Example
```xml
Content-Type: multipart/related; type="application/xop+xml"; start=""; start-info="application/soap+xml"; boundary="MIMEBoundary_xdr_delivery_example"
--MIMEBoundary_xdr_delivery_example
Content-ID:
Content-Transfer-Encoding: 8bit
Content-Type: application/xop+xml; charset=utf-8; type="application/soap+xml"
MIME-Version: 1.0
urn:ihe:iti:2007:ProvideAndRegisterDocumentSet-b
urn:uuid:7f4d7c90-d803-4c33-b053-92f77a59c10f
http://www.w3.org/2005/08/addressing/anonymous
https://xdr.example-hospital.com/DocumentRepository_Service.svc
dr.smith@direct.example-clinic.com
intake@direct.example-hospital.com
minimal
20260722200019
PATID1234^^^&1.3.6.1.4.1.99999.1&ISO
2.16.840.1.113883.6.1
20260722200019
Example Hospital^^^^^&2.16.840.1.113883.3.9999.3&ISO^^^^0002||^^Internet^intake@direct.example-hospital.com
Original
--MIMEBoundary_xdr_delivery_example
Content-ID:
Content-Transfer-Encoding: binary
Content-Type: text/xml
***** The referral C-CDA document bytes belong here. *****
The binary content of the referral attachment is omitted from this example.
--MIMEBoundary_xdr_delivery_example--
```
:::
:::hint{type="info"}
**Note:** This example is for illustrative purposes only. For traceability it reuses the original MessageID; because Surescripts forms the outbound message from the inbound one ([Patient Identification](docId\:XyQrOSGPZ8458uzH0p8sU)), the delivered message may carry a different identifier. The receiving system must return a synchronous Provide and Register Document Set-b Response ([Sending the Message Response](docId\:XyQrOSGPZ8458uzH0p8sU)) with the same structure as [Synchronous Success Response (No Delivery Notification Tracking)](docId\:xZ0MTs_W6FVT5WxkvD-Q0) or [Synchronous Failure Response (RegistryResponse with a RegistryErrorList)](docId\:xZ0MTs_W6FVT5WxkvD-Q0).
:::
****