Examples
10 min
examples provided throughout this guide are not intended to be all inclusive this pertains to example workflows, element specific (field) examples, or message examples customers should not restrict coding to the examples used herein when developing, this guide should be used along with the accompanying schema file, additional documentation referenced, and applicable customary xml coding standards clinical message with pdf attachment the following is an example of a clinical message with a pdf attachment \<?xml version="1 0" encoding="utf 8"?> \<n2nmessage version="civ6" release="0" xmlns="http //www surescripts com/messaging"> \<header> \<recipients> \<to qualifier="direct" friendlyname="user two">usertwo\@exampledomain com\</to> \<to qualifier="direct" cc="true" friendlyname="user three">userthree\@exampledomain com\</to> \</recipients> \<from qualifier="direct" friendlyname="user one">userone\@exampledomain com\</from> \<messageid>f9733ed92efe46658389d1fab1fb3e50\</messageid> \<senttime>2018 11 13t15 27 41 184z\</senttime> \<sendersoftware> \<sendersoftwaredeveloper>test developer\</sendersoftwaredeveloper> \<sendersoftwareproduct>test product\</sendersoftwareproduct> \<sendersoftwareversionrelease>1 0\</sendersoftwareversionrelease> \</sendersoftware> \<patientinformation> \<given>firstname\</given> \<family>lastname\</family> \<dob>1960 06 29\</dob> \<gender>f\</gender> \<zip>55402\</zip> \<identification> \<id issuer="1 3 6 1 4 1 34488 150 21">1054345a\</id> \<id issuer="72bd5f4a 0f71 425e b898 b18ee433a2ff">mr 1332 0001\</id> \</identification> \</patientinformation> \</header> \<body> \<clinicalmessage> \<subject>example subject\</subject> \<document> \<plaintext>example plain text message\</plaintext> \</document> \<attachment> \<documentname>exampledocument pdf\</documentname> \<file> \<documenttype>application/pdf\</documenttype> \<documentdata>jvberi0xljenmsawig9iag08pa0gl1bhz2vzidmgmcbsdsavt3blbkfjdglvbia3idagug0+pg1lbmrvymonmyawig9iag08pa0gl1r5cgugl1bhz2vzdsavs2lkcybbncawifjddsavq291bnqgmq0+pg1lbmrvymonncawig9iag08pa0gl1r5cgugl1bhz2unic9qyxjlbnqgmyawifinic9nzwrpyujvecbbmcawidyxmia3otjddsavq29udgvudhmgnsawifinic9szxnvdxjjzxmgpdwnicagicagicagicagic9qcm9ju2v0ifsvuergic9uzxh0xq0gicagicagicagicagl0zvbnqgpdwgl0yxidygmcbsid4+dsagicagicagicagid4+dt4+dwvuzg9iag01idagb2jqdtw8ic9mzw5ndgggntygpj4nc3ryzwftdujuic9gmsaxmibuziaxmdagnzawifrkide1ifrmichlegftcgxlihbkzikgvgogrvqnzw5kc3ryzwftdwvuzg9iag10cmfpbgvydtw8dsavu2l6zsa4dsavum9vdcaxidagug0+pg1zdgfydhhyzwynnzczdsulru9g\</documentdata> \</file> \</attachment> \</clinicalmessage> \</body> \</n2nmessage> clinical message routed to receiving system the following is an example of a single recipient message routed to a receiving system \<?xml version="1 0" encoding="utf 8"?> \<n2nmessage version="civ6" release="0" xmlns="http //www surescripts com/messaging"> \<header> \<recipients> \<to qualifier="direct" friendlyname="user two" route="true">usertwo\@exampledomain com\</to> \</recipients> \<from qualifier="direct" friendlyname="user one">userone\@exampledomain com\</from> \<messageid>s6lmliooobgf1ous5fjybhc6emzlttei\</messageid> \<senttime>2018 11 13t15 27 41 184z\</senttime> \<sendersoftware> \<sendersoftwaredeveloper>test developer\</sendersoftwaredeveloper> \<sendersoftwareproduct>test product\</sendersoftwareproduct> \<sendersoftwareversionrelease>1 0\</sendersoftwareversionrelease> \</sendersoftware> \<testmessage /> \</header> \<body> \<clinicalmessage> \<subject>example subject\</subject> \<document> \<plaintext>example plain text message\</plaintext> \</document> \</clinicalmessage> \</body> \</n2nmessage> status response – message delivered the following is an example of an http response status message indicating the clinical message was successfully delivered to the recipient \<?xml version="1 0" encoding="utf 8"?> \<n2nmessage version="civ6" release="0" xmlns="http //www surescripts com/messaging"> \<header> \<recipients> \<to qualifier="direct" friendlyname="user one">userone\@exampledomain com\</to> \</recipients> \<from qualifier="direct" friendlyname="user two">usertwo\@exampledomain com\</from> \<messageid>9ebee63133dd41c183309d9af4a7d851\</messageid> \<relatestomessageid>91f6325d9d694222856806cc2d611166\</relatestomessageid> \<senttime>2018 11 13t15 27 41 184z\</senttime> \<sendersoftware> \<sendersoftwaredeveloper>test developer\</sendersoftwaredeveloper> \<sendersoftwareproduct>test product\</sendersoftwareproduct> \<sendersoftwareversionrelease>1 0\</sendersoftwareversionrelease> \</sendersoftware> \</header> \<body> \<status> \<code>010\</code> \</status> \</body> \</n2nmessage> status response – message delivered to multiple recipients the following is an example of an http response status message indicating the clinical message was successfully delivered to multiple recipients hosted by a single customer system \<?xml version="1 0" encoding="utf 8"?> \<n2nmessage version="civ6" release="0" xmlns="http //www surescripts com/messaging"> \<header> \<recipients> \<to qualifier="direct" friendlyname="user one">userone\@exampledomain com\</to> \</recipients> \<from qualifier="zzz">portalname\</from> \<messageid>9ebee63133dd41c183309d9af4a7d851\</messageid> \<relatestomessageid>91f6325d9d694222856806cc2d611166\</relatestomessageid> \<senttime>2018 11 13t15 27 41 184z\</senttime> \<sendersoftware> \<sendersoftwaredeveloper>test developer\</sendersoftwaredeveloper> \<sendersoftwareproduct>test product\</sendersoftwareproduct> \<sendersoftwareversionrelease>1 0\</sendersoftwareversionrelease> \</sendersoftware> \</header> \<body> \<status> \<code>010\</code> \</status> \</body> \</n2nmessage> verify message – message delivered electronically the following is an example of a verify message indicating the clinical message was successfully delivered electronically to the recipient \<?xml version="1 0" encoding="utf 8"?> \<n2nmessage version="civ6" release="0" xmlns="http //www surescripts com/messaging"> \<header> \<recipients> \<to qualifier="direct" friendlyname="user one">userone\@exampledomain com\</to> \</recipients> \<from qualifier="direct" friendlyname="user two">usertwo\@exampledomain com\</from> \<messageid>fbe03a95e68c53240419cbb58236511d\</messageid> \<relatestomessageid>91f6325d9d694222856806cc2d611166\</relatestomessageid> \<senttime>2018 11 13t15 27 41 184z\</senttime> \<sendersoftware> \<sendersoftwaredeveloper>test developer\</sendersoftwaredeveloper> \<sendersoftwareproduct>test product\</sendersoftwareproduct> \<sendersoftwareversionrelease>1 0\</sendersoftwareversionrelease> \</sendersoftware> \</header> \<body> \<verify> \<verifystatus > \<code>010\</code> \</verifystatus> \</verify> \</body> \</n2nmessage> error response – message not delivered the following is an example of an error response indicating the clinical message could not be delivered to the recipient \<?xml version="1 0" encoding="utf 8"?> \<n2nmessage version="civ6" release="0" xmlns="http //www surescripts com/messaging"> \<header> \<recipients> \<to qualifier="direct" friendlyname="user one">userone\@exampledomain com\</to> \</recipients> \<from qualifier="zzz">portalname\</from> \<messageid>fbe03a95e68c53240419cbb58236511d\</messageid> \<relatestomessageid>91f6325d9d694222856806cc2d611166\</relatestomessageid> \<senttime>2018 11 13t15 27 41 184z\</senttime> \<sendersoftware> \<sendersoftwaredeveloper>test developer\</sendersoftwaredeveloper> \<sendersoftwareproduct>test product\</sendersoftwareproduct> \<sendersoftwareversionrelease>1 0\</sendersoftwareversionrelease> \</sendersoftware> \</header> \<body> \<error> \<code>600\</code> \</error> \</body> \</n2nmessage> error response – message not delivered to multiple recipients the following is an example of an error response indicating the clinical message could not be delivered to the recipient \<?xml version="1 0" encoding="utf 8"?> \<n2nmessage version="civ6" release="0" xmlns="http //www surescripts com/messaging"> \<header> \<recipients> \<to qualifier="direct" friendlyname="user one">userone\@exampledomain com\</to> \</recipients> \<from qualifier="zzz">portalname\</from> \<messageid>fbe03a95e68c53240419cbb58236511d\</messageid> \<relatestomessageid>91f6325d9d694222856806cc2d611166\</relatestomessageid> \<senttime>2018 11 13t15 27 41 184z\</senttime> \<sendersoftware> \<sendersoftwaredeveloper>test developer\</sendersoftwaredeveloper> \<sendersoftwareproduct>test product\</sendersoftwareproduct> \<sendersoftwareversionrelease>1 0\</sendersoftwareversionrelease> \</sendersoftware> \</header> \<body> \<error> \<code>600\</code> \</error> \</body> \</n2nmessage> example of namespace in header the following is an implementation example defining the cda namespace within the header of the xml \<?xml version="1 0" encoding="utf 8"?> \<n2nmessage version="civ6" release="0" xmlns\ cda="urn\ hl7 org\ v3" xmlns="http //www surescripts com/messaging"> \<header> \<recipients> \<to qualifier="direct" friendlyname="user one">userone\@exampledomain com\</to> \</recipients> \<from qualifier="zzz">portalname\</from> \<messageid>fbe03a95e68c53240419cbb58236511d\</messageid> \<relatestomessageid>91f6325d9d694222856806cc2d611166\</relatestomessageid> \<senttime>2018 11 13t15 27 41 184z\</senttime> \<sendersoftware> \<sendersoftwaredeveloper>test developer\</sendersoftwaredeveloper> \<sendersoftwareproduct>test product\</sendersoftwareproduct> \<sendersoftwareversionrelease>1 0\</sendersoftwareversionrelease> \</sendersoftware> \</header> \<body> \<clinicalmessage> \<subject>test message for erx 24414\</subject> \<document> \<plaintext/> \</document> \<attachment> \<documentname>latifa cda xml\</documentname> \<cda\ clinicaldocument> \<cda\ realmcode code="us" /> \<cda\ typeid root="2 16 840 1 113883 1 3" extension="pocd hd000040" /> \<cda\ templateid root="2 16 840 1 113883 10 20 22 1 1" /> \<cda\ templateid root="2 16 840 1 113883 10 20 22 1 2" /> \<cda\ id root="2 16 840 1 113883 3 2054" extension="7f2f1a44ab934cddave108a43285e7b7" /> \<cda\ code code="34133 9" displayname="summarization of episode note" codesystem="2 16 840 1 113883 6 1" codesystemname="loinc" /> \<cda\ title>dev imm title\</cda\ title> \<cda\ effectivetime value="20130903082505" /> \<cda\ confidentialitycode code="n" displayname="normal" codesystem="2 16 840 1 113883 5 25" codesystemname="hl7 confidentiality code" /> \<cda\ languagecode code="us" /> \<cda\ documentationof> \<cda\ serviceevent classcode="pcpr"> \<cda\ effectivetime> \<cda\ low nullflavor="unk" /> \<cda\ high nullflavor="unk"/> \</cda\ effectivetime> \</cda\ serviceevent> \</cda\ documentationof> \</cda\ clinicaldocument> \</attachment> \</clinicalmessage> \</body> \</n2nmessage> example of namespace in element the following is an implementation example defining the cda namespace within the clinicaldocument element of the xml \<?xml version="1 0" encoding="utf 8"?> \<n2nmessage version="civ6" release="0" xmlns\ cda="urn\ hl7 org\ v3" xmlns="http //www surescripts com/messaging"> \<header> \<recipients> \<to qualifier="direct" friendlyname="user one">userone\@exampledomain com\</to> \</recipients> \<from qualifier="zzz">portalname\</from> \<messageid>fbe03a95e68c53240419cbb58236511d\</messageid> \<relatestomessageid>91f6325d9d694222856806cc2d611166\</relatestomessageid> \<senttime>2018 11 13t15 27 41 184z\</senttime> \<sendersoftware> \<sendersoftwaredeveloper>test developer\</sendersoftwaredeveloper> \<sendersoftwareproduct>test product\</sendersoftwareproduct> \<sendersoftwareversionrelease>1 0\</sendersoftwareversionrelease> \</sendersoftware> \</header> \<body> \<clinicalmessage> \<subject>test message for erx 24414\</subject> \<document> \<plaintext /> \</document> \<attachment> \<documentname>latifa cda xml\</documentname> \<cda\ clinicaldocument xmlns="urn\ hl7 org\ v3" xmlns\ xsltutil="urn\ xsltutil"> \<cda\ realmcode code="us" /> \<cda\ typeid root="2 16 840 1 113883 1 3" extension="pocd hd000040" /> \<cda\ templateid root="2 16 840 1 113883 10 20 22 1 1" /> \<cda\ templateid root="2 16 840 1 113883 10 20 22 1 2" /> \<cda\ id root="2 16 840 1 113883 3 2054" extension="7f2f1a44ab934cddave108a43285e7b7" /> \<cda\ code code="34133 9" displayname="summarization of episode note" codesystem="2 16 840 1 113883 6 1" codesystemname="loinc" /> \<cda\ title>dev imm title\</title> \<cda\ effectivetime value="20130903082505" /> \<cda\ confidentialitycode code="n" displayname="normal" codesystem="2 16 840 1 113883 5 25" codesystemname="hl7 confidentiality code" /> \<cda\ languagecode code="us" /> \<cda\ documentationof> \<cda\ serviceevent classcode="pcpr"> \<cda\ effectivetime> \<cda\ low nullflavor="unk" /> \<cda\ high nullflavor="unk" /> \</cda\ effectivetime> \</cda\ serviceevent> \</cda\ documentationof> \</cda\ clinicaldocument> \</attachment> \</clinicalmessage> \</body> \</n2nmessage>