Consolidated Message Examples
14 min
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) synchronous success response \<s\ envelope xmlns\ s="http //www w3 org/2003/05/soap envelope" xmlns\ a="http //www w3 org/2005/08/addressing"> \<s\ header> \<a\ action s\ mustunderstand="1">urn\ ihe\ iti 2007\ provideandregisterdocumentset bresponse\</a\ action> \<a\ relatesto>urn\ uuid 7f4d7c90 d803 4c33 b053 92f77a59c10f\</a\ relatesto> \</s\ header> \<s\ body xmlns\ xsi="http //www w3 org/2001/xmlschema instance" xmlns\ xsd="http //www w3 org/2001/xmlschema"> \<registryresponse status="urn\ oasis\ names\ tc\ ebxml regrep\ responsestatustype\ success" xmlns="urn\ oasis\ names\ tc\ ebxml regrep\ xsd\ rs 3 0"/> \</s\ body> \</s\ envelope> 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 dsn acknowledgement \<s\ envelope xmlns\ s="http //www w3 org/2003/05/soap envelope" xmlns\ a="http //www w3 org/2005/08/addressing"> \<s\ header> \<a\ action s\ mustunderstand="1">urn\ ihe\ iti 2007\ provideandregisterdocumentset bresponse\</a\ action> \<a\ relatesto>urn\ uuid 2c8b0e13 9f1a 4b6e 8b5a 6d7e8f901234\</a\ relatesto> \</s\ header> \<s\ body> \<registryresponse status="urn\ oasis\ names\ tc\ ebxml regrep\ responsestatustype\ success" xmlns="urn\ oasis\ names\ tc\ ebxml regrep\ xsd\ rs 3 0"/> \</s\ body> \</s\ envelope> 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 example content type multipart/related; type="application/xop+xml"; start="\<http //tempuri org/0>"; start info="application/soap+xml"; boundary="mimeboundary xdr example" \ mimeboundary xdr example content id \<http //tempuri org/0> content transfer encoding 8bit content type application/xop+xml; charset=utf 8; type="application/soap+xml" mime version 1 0 \<s\ envelope xmlns\ s="http //www w3 org/2003/05/soap envelope" xmlns\ a="http //www w3 org/2005/08/addressing"> \<s\ header> \<a\ action s\ mustunderstand="1">urn\ ihe\ iti 2007\ provideandregisterdocumentset b\</a\ action> \<a\ messageid>urn\ uuid 7f4d7c90 d803 4c33 b053 92f77a59c10f\</a\ messageid> \<a\ replyto>\<a\ address>http //www w3 org/2005/08/addressing/anonymous\</a\ address>\</a\ replyto> \<a\ to s\ mustunderstand="1">https //\[xdr endpoint provided at onboarding]/documentrepository service svc\</a\ to> \<direct\ addressblock s\ role="urn\ direct\ addressing\ destination" s\ relay="1" xmlns\ direct="urn\ direct\ addressing"> \<direct\ from>dr smith\@direct example clinic com\</direct\ from> \<direct\ to>intake\@direct example hospital com\</direct\ to> \<direct\ metadata level>minimal\</direct\ metadata level> \</direct\ addressblock> \</s\ header> \<s\ body> \<provideandregisterdocumentsetrequest xmlns="urn\ ihe\ iti\ xds b 2007"> \<submitobjectsrequest xmlns="urn\ oasis\ names\ tc\ ebxml regrep\ xsd\ lcm 3 0"> \<registryobjectlist xmlns="urn\ oasis\ names\ tc\ ebxml regrep\ xsd\ rim 3 0"> \<! ===== document entry the referral c cda ===== > \<extrinsicobject id="doc 1" mimetype="text/xml" objecttype="urn\ uuid 7edca82f 054d 47f2 a032 9b2a5b5186c1" status="urn\ oasis\ names\ tc\ ebxml regrep\ statustype\ approved"> \<slot name="creationtime">\<valuelist>\<value>20260722200019\</value>\</valuelist>\</slot> \<slot name="languagecode">\<valuelist>\<value>en us\</value>\</valuelist>\</slot> \<slot name="sourcepatientid"> \<valuelist>\<value>patid1234^^^\&1 3 6 1 4 1 99999 1\&iso\</value>\</valuelist> \</slot> \<slot name="sourcepatientinfo"> \<valuelist> \<value>pid 3|patid1234^^^\&1 3 6 1 4 1 99999 1\&iso\</value> \<value>pid 5|doe^jane^^^^^l\</value> \<value>pid 7|19600615\</value> \<value>pid 8|f\</value> \<value>pid 11|123 main st^^portland^or^97201^us\</value> \</valuelist> \</slot> \<slot name="hash">\<valuelist>\<value>28f1b1d1d49a85bdd7a7cb4d7d87eb5d93b8ef45\</value>\</valuelist>\</slot> \<slot name="size">\<valuelist>\<value>36100\</value>\</valuelist>\</slot> \<name>\<localizedstring value="cardiology referral"/>\</name> \<! limitedmetadata marker (minimal metadata) > \<classification classifiedobject="doc 1" id="cl doc limited" classificationnode="urn\ uuid\ ab9b591b 83ab 4d03 8f5d f93b1fb92e85"/> \<! author > \<classification classificationscheme="urn\ uuid 93606bcf 9494 43ec 9b4e a7748d1a838d" classifiedobject="doc 1" id="cl doc author" noderepresentation=""> \<slot name="authorperson">\<valuelist>\<value>e12345^smith^john^^^^md^^\&2 16 840 1 113883 3 9999 2\&iso\</value>\</valuelist>\</slot> \<slot name="authorinstitution">\<valuelist>\<value>example clinic^^^^^\&2 16 840 1 113883 3 9999\&iso^^^^0001\</value>\</valuelist>\</slot> \</classification> \<! classcode > \<classification classificationscheme="urn\ uuid 41a5887f 8865 4c09 adf7 e362475b143a" classifiedobject="doc 1" id="cl doc class" noderepresentation="57133 1"> \<slot name="codingscheme">\<valuelist>\<value>2 16 840 1 113883 6 1\</value>\</valuelist>\</slot> \<name>\<localizedstring value="referral note"/>\</name> \</classification> \<! confidentialitycode > \<classification classificationscheme="urn\ uuid\ f4f85eac e6cb 4883 b524 f2705394840f" classifiedobject="doc 1" id="cl doc conf" noderepresentation="n"> \<slot name="codingscheme">\<valuelist>\<value>2 16 840 1 113883 5 25\</value>\</valuelist>\</slot> \<name>\<localizedstring value="normal"/>\</name> \</classification> \<! formatcode > \<classification classificationscheme="urn\ uuid\ a09d5840 386c 46f2 b5ad 9c3699a4309d" classifiedobject="doc 1" id="cl doc format" noderepresentation="urn\ hl7 org\ sdwg\ ccda structuredbody 2 1"> \<slot name="codingscheme">\<valuelist>\<value>1 3 6 1 4 1 19376 1 2 3\</value>\</valuelist>\</slot> \<name>\<localizedstring value="hl7 c cda structured body"/>\</name> \</classification> \<! healthcarefacilitytypecode > \<classification classificationscheme="urn\ uuid\ f33fb8ac 18af 42cc ae0e ed0b0bdb91e1" classifiedobject="doc 1" id="cl doc hft" noderepresentation="394747008"> \<slot name="codingscheme">\<valuelist>\<value>2 16 840 1 113883 6 96\</value>\</valuelist>\</slot> \<name>\<localizedstring value="ambulatory care site"/>\</name> \</classification> \<! practicesettingcode > \<classification classificationscheme="urn\ uuid\ cccf5598 8b07 4b77 a05e ae952c785ead" classifiedobject="doc 1" id="cl doc ps" noderepresentation="394579002"> \<slot name="codingscheme">\<valuelist>\<value>2 16 840 1 113883 6 96\</value>\</valuelist>\</slot> \<name>\<localizedstring value="cardiology"/>\</name> \</classification> \<! typecode > \<classification classificationscheme="urn\ uuid\ f0306f51 975f 434e a61c c59651d33983" classifiedobject="doc 1" id="cl doc type" noderepresentation="57133 1"> \<slot name="codingscheme">\<valuelist>\<value>2 16 840 1 113883 6 1\</value>\</valuelist>\</slot> \<name>\<localizedstring value="referral note"/>\</name> \</classification> \<! documententry patientid > \<externalidentifier identificationscheme="urn\ uuid 58a6f841 87b3 4a3e 92fd a8ffeff98427" registryobject="doc 1" id="ei doc pid" value="patid1234^^^\&1 3 6 1 4 1 99999 1\&iso"> \<name>\<localizedstring value="xdsdocumententry patientid"/>\</name> \</externalidentifier> \<! documententry uniqueid > \<externalidentifier identificationscheme="urn\ uuid 2e82c1f6 a085 4c72 9da3 8640a32e42ab" registryobject="doc 1" id="ei doc uid" value="2 16 840 1 113883 3 9999 1 100001"> \<name>\<localizedstring value="xdsdocumententry uniqueid"/>\</name> \</externalidentifier> \</extrinsicobject> \<! ===== submission set ===== > \<registrypackage id="submissionset01" status="urn\ oasis\ names\ tc\ ebxml regrep\ statustype\ approved"> \<slot name="submissiontime">\<valuelist>\<value>20260722200019\</value>\</valuelist>\</slot> \<slot name="intendedrecipient"> \<valuelist>\<value>example hospital^^^^^\&2 16 840 1 113883 3 9999 3\&iso^^^^0002||^^internet^intake\@direct example hospital com\</value>\</valuelist> \</slot> \<name>\<localizedstring value="cardiology referral"/>\</name> \<! author (with role and specialty) > \<classification classificationscheme="urn\ uuid\ a7058bb9 b4e4 4307 ba5b e3f0ab85e12d" classifiedobject="submissionset01" id="cl ss author" noderepresentation=""> \<slot name="authorperson">\<valuelist>\<value>e12345^smith^john^^^^md^^\&2 16 840 1 113883 3 9999 2\&iso\</value>\</valuelist>\</slot> \<slot name="authorinstitution">\<valuelist>\<value>example clinic^^^^^\&2 16 840 1 113883 3 9999\&iso^^^^0001\</value>\</valuelist>\</slot> \<slot name="authorrole">\<valuelist>\<value>referring physician\</value>\</valuelist>\</slot> \<slot name="authorspecialty">\<valuelist>\<value>cardiology\</value>\</valuelist>\</slot> \<slot name="authortelecommunication">\<valuelist>\<value>^^internet^dr smith\@direct example clinic com\</value>\</valuelist>\</slot> \</classification> \<! contenttypecode > \<classification classificationscheme="urn\ uuid\ aa543740 bdda 424e 8c96 df4873be8500" classifiedobject="submissionset01" id="cl ss content" noderepresentation="57133 1"> \<slot name="codingscheme">\<valuelist>\<value>2 16 840 1 113883 6 1\</value>\</valuelist>\</slot> \<name>\<localizedstring value="referral note"/>\</name> \</classification> \<! limitedmetadata marker (minimal metadata) > \<classification classifiedobject="submissionset01" id="cl ss limited" classificationnode="urn\ uuid 5003a9db 8d8d 49e6 bf0c 990e34ac7707"/> \<! submissionset sourceid > \<externalidentifier identificationscheme="urn\ uuid 554ac39e e3fe 47fe b233 965d2a147832" registryobject="submissionset01" id="ei ss src" value="2 16 840 1 113883 3 9999 1"> \<name>\<localizedstring value="xdssubmissionset sourceid"/>\</name> \</externalidentifier> \<! submissionset uniqueid > \<externalidentifier identificationscheme="urn\ uuid 96fdda7c d067 4183 912e bf5ee74998a8" registryobject="submissionset01" id="ei ss uid" value="2 16 840 1 113883 3 9999 1 1"> \<name>\<localizedstring value="xdssubmissionset uniqueid"/>\</name> \</externalidentifier> \<! submissionset patientid > \<externalidentifier identificationscheme="urn\ uuid 6b5aea1a 874d 4603 a4bc 96a0a7b38446" registryobject="submissionset01" id="ei ss pid" value="patid1234^^^\&1 3 6 1 4 1 99999 1\&iso"> \<name>\<localizedstring value="xdssubmissionset patientid"/>\</name> \</externalidentifier> \</registrypackage> \<! classifies the registrypackage as a submission set > \<classification classifiedobject="submissionset01" id="cl ss node" classificationnode="urn\ uuid\ a54d6aa5 d40d 43f9 88c5 b4633d873bdd"/> \<! the document is a member of the submission set > \<association associationtype="urn\ oasis\ names\ tc\ ebxml regrep\ associationtype\ hasmember" sourceobject="submissionset01" targetobject="doc 1" id="as 01"> \<slot name="submissionsetstatus">\<valuelist>\<value>original\</value>\</valuelist>\</slot> \</association> \</registryobjectlist> \</submitobjectsrequest> \<! referral c cda, carried as a separate mime part via mtom/xop the binary payload is omitted here; see the second mime part below > \<document id="doc 1"> \<xop\ include href="cid\ http //tempuri org/1" xmlns\ xop="http //www w3 org/2004/08/xop/include"/> \</document> \</provideandregisterdocumentsetrequest> \</s\ body> \</s\ envelope> \ mimeboundary xdr example content id \<http //tempuri org/1> 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 \<xop\ include> element in the document above \ mimeboundary xdr example 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 example content type multipart/related; type="application/xop+xml"; start="\<http //tempuri org/0>"; start info="application/soap+xml"; boundary="mimeboundary dsn example" \ mimeboundary dsn example content id \<http //tempuri org/0> content transfer encoding 8bit content type application/xop+xml; charset=utf 8; type="application/soap+xml" \<s\ envelope xmlns\ s="http //www w3 org/2003/05/soap envelope" xmlns\ a="http //www w3 org/2005/08/addressing"> \<s\ header> \<a\ action s\ mustunderstand="1">urn\ ihe\ iti 2007\ provideandregisterdocumentset b\</a\ action> \<a\ messageid>urn\ uuid 2c8b0e13 9f1a 4b6e 8b5a 6d7e8f901234\</a\ messageid> \<a\ relatesto>urn\ uuid 7f4d7c90 d803 4c33 b053 92f77a59c10f\</a\ relatesto> \<a\ from>\<a\ address>urn\ oid 2 16 840 1 113883 3 9999 3\</a\ address>\</a\ from> \<a\ replyto>\<a\ address>http //www w3 org/2005/08/addressing/anonymous\</a\ address>\</a\ replyto> \<direct\ addressblock s\ role="urn\ direct\ addressing\ destination" s\ relay="1" xmlns\ direct="urn\ direct\ addressing"> \<direct\ from>intake\@direct example hospital com\</direct\ from> \<direct\ to>dr smith\@direct example clinic com\</direct\ to> \<direct\ metadata level>minimal\</direct\ metadata level> \<direct\ notification relatesto="urn\ uuid 7f4d7c90 d803 4c33 b053 92f77a59c10f"/> \</direct\ addressblock> \<a\ to s\ mustunderstand="1">https //xdr example clinic com/documentrepository service svc\</a\ to> \</s\ header> \<s\ body> \<provideandregisterdocumentsetrequest xmlns="urn\ ihe\ iti\ xds b 2007"> \<submitobjectsrequest xmlns="urn\ oasis\ names\ tc\ ebxml regrep\ xsd\ lcm 3 0"> \<registryobjectlist xmlns="urn\ oasis\ names\ tc\ ebxml regrep\ xsd\ rim 3 0"> \<registrypackage id="submissionset01" status="urn\ oasis\ names\ tc\ ebxml regrep\ statustype\ approved"> \<slot name="submissiontime">\<valuelist>\<value>20260722200021\</value>\</valuelist>\</slot> \<classification classificationscheme="urn\ uuid\ a7058bb9 b4e4 4307 ba5b e3f0ab85e12d" classifiedobject="submissionset01" id="ss c 1" noderepresentation=""> \<slot name="authortelecommunication">\<valuelist>\<value>^^internet^intake\@direct example hospital com\</value>\</valuelist>\</slot> \</classification> \<! limitedmetadata marker > \<classification classifiedobject="submissionset01" id="ss c 2" classificationnode="urn\ uuid 5003a9db 8d8d 49e6 bf0c 990e34ac7707"/> \<externalidentifier id="ss ei 1" registryobject="submissionset01" identificationscheme="urn\ uuid 554ac39e e3fe 47fe b233 965d2a147832" value="2 16 840 1 113883 3 9999 3"> \<name>\<localizedstring value="xdssubmissionset sourceid"/>\</name> \</externalidentifier> \<externalidentifier id="ss ei 2" registryobject="submissionset01" identificationscheme="urn\ uuid 96fdda7c d067 4183 912e bf5ee74998a8" value="2 16 840 1 113883 3 9999 3 1"> \<name>\<localizedstring value="xdssubmissionset uniqueid"/>\</name> \</externalidentifier> \</registrypackage> \<classification classifiedobject="submissionset01" id="ss classifier" classificationnode="urn\ uuid\ a54d6aa5 d40d 43f9 88c5 b4633d873bdd"/> \<extrinsicobject id="doc 1" mimetype="text/xml" objecttype="urn\ uuid 7edca82f 054d 47f2 a032 9b2a5b5186c1"> \<slot name="creationtime">\<valuelist>\<value>20260722200021\</value>\</valuelist>\</slot> \<slot name="size">\<valuelist>\<value>221\</value>\</valuelist>\</slot> \<slot name="hash">\<valuelist>\<value>149b15e48a99c96fdffef1473d1f71e5ef3fc5a0\</value>\</valuelist>\</slot> \<! limitedmetadata marker > \<classification classifiedobject="doc 1" id="doc c 1" classificationnode="urn\ uuid\ ab9b591b 83ab 4d03 8f5d f93b1fb92e85"/> \<externalidentifier id="doc ei 1" registryobject="doc 1" identificationscheme="urn\ uuid 2e82c1f6 a085 4c72 9da3 8640a32e42ab" value="2 16 840 1 113883 3 9999 3 2"> \<name>\<localizedstring value="xdsdocumententry uniqueid"/>\</name> \</externalidentifier> \</extrinsicobject> \<association associationtype="urn\ oasis\ names\ tc\ ebxml regrep\ associationtype\ hasmember" sourceobject="submissionset01" targetobject="doc 1" id="as 1"> \<slot name="submissionsetstatus">\<valuelist>\<value>original\</value>\</valuelist>\</slot> \</association> \</registryobjectlist> \</submitobjectsrequest> \<! base64 encoded direct\ messagedisposition from example 5 6 2 > \<document id="doc 1">pgrpcmvjddptzxnzywdlrglzcg9zaxrpb24geg1sbnm6zglyzwn0psj1cm46zglyzwn0omfkzhjlc3npbmcipg0kica8zglyzwn0onjly2lwawvudd5pbnrha2vazglyzwn0lmv4yw1wbgutag9zcgl0ywwuy29tpc9kaxjly3q6cmvjaxbpzw50pg0kica8zglyzwn0omrpc3bvc2l0aw9upnn1y2nlc3m8l2rpcmvjddpkaxnwb3npdglvbj4ncjwvzglyzwn0om1lc3nhz2veaxnwb3npdglvbj4=\</document> \</provideandregisterdocumentsetrequest> \</s\ body> \</s\ envelope> \ mimeboundary dsn example 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 example content type multipart/related; type="application/xop+xml"; start="\<http //tempuri org/0>"; start info="application/soap+xml"; boundary="mimeboundary dsn failure example" \ mimeboundary dsn failure example content id \<http //tempuri org/0> content transfer encoding 8bit content type application/xop+xml; charset=utf 8; type="application/soap+xml" \<s\ envelope xmlns\ s="http //www w3 org/2003/05/soap envelope" xmlns\ a="http //www w3 org/2005/08/addressing"> \<s\ header> \<a\ action s\ mustunderstand="1">urn\ ihe\ iti 2007\ provideandregisterdocumentset b\</a\ action> \<a\ messageid>urn\ uuid 3d9c1f24 a0b2 4c5d 9e6f 7a8b9c0d1e2f\</a\ messageid> \<a\ relatesto>urn\ uuid 7f4d7c90 d803 4c33 b053 92f77a59c10f\</a\ relatesto> \<a\ from>\<a\ address>urn\ oid 2 16 840 1 113883 3 9999 3\</a\ address>\</a\ from> \<a\ replyto>\<a\ address>http //www w3 org/2005/08/addressing/anonymous\</a\ address>\</a\ replyto> \<direct\ addressblock s\ role="urn\ direct\ addressing\ destination" s\ relay="1" xmlns\ direct="urn\ direct\ addressing"> \<direct\ from>intake\@direct example hospital com\</direct\ from> \<direct\ to>dr smith\@direct example clinic com\</direct\ to> \<direct\ metadata level>minimal\</direct\ metadata level> \<direct\ notification relatesto="urn\ uuid 7f4d7c90 d803 4c33 b053 92f77a59c10f"/> \</direct\ addressblock> \<a\ to s\ mustunderstand="1">https //xdr example clinic com/documentrepository service svc\</a\ to> \</s\ header> \<s\ body> \<provideandregisterdocumentsetrequest xmlns="urn\ ihe\ iti\ xds b 2007"> \<submitobjectsrequest xmlns="urn\ oasis\ names\ tc\ ebxml regrep\ xsd\ lcm 3 0"> \<registryobjectlist xmlns="urn\ oasis\ names\ tc\ ebxml regrep\ xsd\ rim 3 0"> \<registrypackage id="submissionset01" status="urn\ oasis\ names\ tc\ ebxml regrep\ statustype\ approved"> \<slot name="submissiontime">\<valuelist>\<value>20260722200521\</value>\</valuelist>\</slot> \<classification classificationscheme="urn\ uuid\ a7058bb9 b4e4 4307 ba5b e3f0ab85e12d" classifiedobject="submissionset01" id="ss c 1" noderepresentation=""> \<slot name="authortelecommunication">\<valuelist>\<value>^^internet^intake\@direct example hospital com\</value>\</valuelist>\</slot> \</classification> \<! limitedmetadata marker > \<classification classifiedobject="submissionset01" id="ss c 2" classificationnode="urn\ uuid 5003a9db 8d8d 49e6 bf0c 990e34ac7707"/> \<externalidentifier id="ss ei 1" registryobject="submissionset01" identificationscheme="urn\ uuid 554ac39e e3fe 47fe b233 965d2a147832" value="2 16 840 1 113883 3 9999 3"> \<name>\<localizedstring value="xdssubmissionset sourceid"/>\</name> \</externalidentifier> \<externalidentifier id="ss ei 2" registryobject="submissionset01" identificationscheme="urn\ uuid 96fdda7c d067 4183 912e bf5ee74998a8" value="2 16 840 1 113883 3 9999 3 11"> \<name>\<localizedstring value="xdssubmissionset uniqueid"/>\</name> \</externalidentifier> \</registrypackage> \<classification classifiedobject="submissionset01" id="ss classifier" classificationnode="urn\ uuid\ a54d6aa5 d40d 43f9 88c5 b4633d873bdd"/> \<extrinsicobject id="doc 1" mimetype="text/xml" objecttype="urn\ uuid 7edca82f 054d 47f2 a032 9b2a5b5186c1"> \<slot name="creationtime">\<valuelist>\<value>20260722200521\</value>\</valuelist>\</slot> \<slot name="size">\<valuelist>\<value>294\</value>\</valuelist>\</slot> \<slot name="hash">\<valuelist>\<value>0e2c7d036fdb41dee1538f4ecd47553c384001a0\</value>\</valuelist>\</slot> \<! limitedmetadata marker > \<classification classifiedobject="doc 1" id="doc c 1" classificationnode="urn\ uuid\ ab9b591b 83ab 4d03 8f5d f93b1fb92e85"/> \<externalidentifier id="doc ei 1" registryobject="doc 1" identificationscheme="urn\ uuid 2e82c1f6 a085 4c72 9da3 8640a32e42ab" value="2 16 840 1 113883 3 9999 3 12"> \<name>\<localizedstring value="xdsdocumententry uniqueid"/>\</name> \</externalidentifier> \</extrinsicobject> \<association associationtype="urn\ oasis\ names\ tc\ ebxml regrep\ associationtype\ hasmember" sourceobject="submissionset01" targetobject="doc 1" id="as 1"> \<slot name="submissionsetstatus">\<valuelist>\<value>original\</value>\</valuelist>\</slot> \</association> \</registryobjectlist> \</submitobjectsrequest> \<! base64 encoded direct\ messagedisposition (failure) decodes to example 5 6 3 > \<document id="doc 1">pgrpcmvjddptzxnzywdlrglzcg9zaxrpb24geg1sbnm6zglyzwn0psj1cm46zglyzwn0omfkzhjlc3npbmcipg0kica8zglyzwn0onjly2lwawvudd5pbnrha2vazglyzwn0lmv4yw1wbgutag9zcgl0ywwuy29tpc9kaxjly3q6cmvjaxbpzw50pg0kica8zglyzwn0omrpc3bvc2l0aw9upmzhawx1cmu8l2rpcmvjddpkaxnwb3npdglvbj4nciagpgrpcmvjddpyzwfzb25gb3jgywlsdxjlpk1hawxib3ggbm90igzvdw5kljwvzglyzwn0onjlyxnvbkzvckzhawx1cmu+dqo8l2rpcmvjddptzxnzywdlrglzcg9zaxrpb24+\</document> \</provideandregisterdocumentsetrequest> \</s\ body> \</s\ envelope> \ mimeboundary dsn failure example 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 example content type multipart/related; type="application/xop+xml"; start="\<http //tempuri org/0>"; start info="application/soap+xml"; boundary="mimeboundary xdr delivery example" \ mimeboundary xdr delivery example content id \<http //tempuri org/0> content transfer encoding 8bit content type application/xop+xml; charset=utf 8; type="application/soap+xml" mime version 1 0 \<s\ envelope xmlns\ s="http //www w3 org/2003/05/soap envelope" xmlns\ a="http //www w3 org/2005/08/addressing"> \<s\ header> \<a\ action s\ mustunderstand="1">urn\ ihe\ iti 2007\ provideandregisterdocumentset b\</a\ action> \<a\ messageid>urn\ uuid 7f4d7c90 d803 4c33 b053 92f77a59c10f\</a\ messageid> \<a\ replyto>\<a\ address>http //www w3 org/2005/08/addressing/anonymous\</a\ address>\</a\ replyto> \<a\ to s\ mustunderstand="1">https //xdr example hospital com/documentrepository service svc\</a\ to> \<direct\ addressblock s\ role="urn\ direct\ addressing\ destination" s\ relay="1" xmlns\ direct="urn\ direct\ addressing"> \<direct\ from>dr smith\@direct example clinic com\</direct\ from> \<direct\ to>intake\@direct example hospital com\</direct\ to> \<direct\ metadata level>minimal\</direct\ metadata level> \</direct\ addressblock> \</s\ header> \<s\ body> \<provideandregisterdocumentsetrequest xmlns="urn\ ihe\ iti\ xds b 2007"> \<submitobjectsrequest xmlns="urn\ oasis\ names\ tc\ ebxml regrep\ xsd\ lcm 3 0"> \<registryobjectlist xmlns="urn\ oasis\ names\ tc\ ebxml regrep\ xsd\ rim 3 0"> \<extrinsicobject id="doc 1" mimetype="text/xml" objecttype="urn\ uuid 7edca82f 054d 47f2 a032 9b2a5b5186c1" status="urn\ oasis\ names\ tc\ ebxml regrep\ statustype\ approved"> \<slot name="creationtime">\<valuelist>\<value>20260722200019\</value>\</valuelist>\</slot> \<slot name="sourcepatientid"> \<valuelist>\<value>patid1234^^^\&1 3 6 1 4 1 99999 1\&iso\</value>\</valuelist> \</slot> \<name>\<localizedstring value="cardiology referral"/>\</name> \<! limitedmetadata marker (minimal metadata) > \<classification classifiedobject="doc 1" id="cl doc limited" classificationnode="urn\ uuid\ ab9b591b 83ab 4d03 8f5d f93b1fb92e85"/> \<! classcode > \<classification classificationscheme="urn\ uuid 41a5887f 8865 4c09 adf7 e362475b143a" classifiedobject="doc 1" id="cl doc class" noderepresentation="57133 1"> \<slot name="codingscheme">\<valuelist>\<value>2 16 840 1 113883 6 1\</value>\</valuelist>\</slot> \<name>\<localizedstring value="referral note"/>\</name> \</classification> \<! documententry patientid > \<externalidentifier identificationscheme="urn\ uuid 58a6f841 87b3 4a3e 92fd a8ffeff98427" registryobject="doc 1" id="ei doc pid" value="patid1234^^^\&1 3 6 1 4 1 99999 1\&iso"> \<name>\<localizedstring value="xdsdocumententry patientid"/>\</name> \</externalidentifier> \<! documententry uniqueid > \<externalidentifier identificationscheme="urn\ uuid 2e82c1f6 a085 4c72 9da3 8640a32e42ab" registryobject="doc 1" id="ei doc uid" value="2 16 840 1 113883 3 9999 1 100001"> \<name>\<localizedstring value="xdsdocumententry uniqueid"/>\</name> \</externalidentifier> \</extrinsicobject> \<registrypackage id="submissionset01" status="urn\ oasis\ names\ tc\ ebxml regrep\ statustype\ approved"> \<slot name="submissiontime">\<valuelist>\<value>20260722200019\</value>\</valuelist>\</slot> \<slot name="intendedrecipient"> \<valuelist>\<value>example hospital^^^^^\&2 16 840 1 113883 3 9999 3\&iso^^^^0002||^^internet^intake\@direct example hospital com\</value>\</valuelist> \</slot> \<name>\<localizedstring value="cardiology referral"/>\</name> \<! limitedmetadata marker (minimal metadata) > \<classification classifiedobject="submissionset01" id="cl ss limited" classificationnode="urn\ uuid 5003a9db 8d8d 49e6 bf0c 990e34ac7707"/> \<! submissionset uniqueid > \<externalidentifier identificationscheme="urn\ uuid 96fdda7c d067 4183 912e bf5ee74998a8" registryobject="submissionset01" id="ei ss uid" value="2 16 840 1 113883 3 9999 1 1"> \<name>\<localizedstring value="xdssubmissionset uniqueid"/>\</name> \</externalidentifier> \<! submissionset patientid > \<externalidentifier identificationscheme="urn\ uuid 6b5aea1a 874d 4603 a4bc 96a0a7b38446" registryobject="submissionset01" id="ei ss pid" value="patid1234^^^\&1 3 6 1 4 1 99999 1\&iso"> \<name>\<localizedstring value="xdssubmissionset patientid"/>\</name> \</externalidentifier> \</registrypackage> \<! classifies the registrypackage as a submission set > \<classification classifiedobject="submissionset01" id="cl ss node" classificationnode="urn\ uuid\ a54d6aa5 d40d 43f9 88c5 b4633d873bdd"/> \<! the document is a member of the submission set > \<association associationtype="urn\ oasis\ names\ tc\ ebxml regrep\ associationtype\ hasmember" sourceobject="submissionset01" targetobject="doc 1" id="as 01"> \<slot name="submissionsetstatus">\<valuelist>\<value>original\</value>\</valuelist>\</slot> \</association> \</registryobjectlist> \</submitobjectsrequest> \<document id="doc 1"> \<xop\ include href="cid\ http //tempuri org/1" xmlns\ xop="http //www w3 org/2004/08/xop/include"/> \</document> \</provideandregisterdocumentsetrequest> \</s\ body> \</s\ envelope> \ mimeboundary xdr delivery example content id \<http //tempuri org/1> 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 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