Message Definitions

message header surescripts uses a message header for all messages the message header contains information required for routing of the message and is separate from the clinical content of the message body the xml schemas are available as a supplemental file message header – xml in xml diagrams, blocks that are solid are mandatory, whereas blocks that have dotted lines are conditional note recipientinformation is used only for guaranteed delivery patient information clinical messages often relate to the care of a particular patient customers should include patient identification data with the message to assist the recipient's software in matching the patient to a local patient record when sending a new message, a customer should include \<patientinformation> in the message, which should include, at minimum, the \<given>, \<family> elements and should include the \<dob>, \<gender>, and \<zip> elements, as well as a valid occurrence of the \<identification> element note surescripts does not guarantee the patient identifier provided in the message is unique or specific to the recipient's organization when receiving messages, the patient identifier should not be used exclusively to match the clinical information provided in the message with a patient within the recipient's organization a message should contain data for a single patient if a message is not related to a single patient the sender should not specify any \<patientinformation> in the message patient information message header elements m/c mandatory or conditional element code comments n2nmessage/@version mandatory message version number value = civ6 n2nmessage/@release mandatory message release number value = 0 recipients mandatory list of all receivers of the message to mandatory the identification of the intended receiver of the message to/@qualifier mandatory value = direct to/@cc conditional indicates that the recipient is a secondary (informational) recipient of the message cc = true if not true, do not include this attribute to/@friendlyname conditional value identifies a user friendly name of the recipient used for display to/@route conditional only added by surescripts to indicate that the receiving system is responsible for responding for the identified recipient route = true if not true, receiving system is not responsible for responding to the message from mandatory the identification of the sender of the message see multiple recipient messages docid 9od7xmmyjp74rwisgyguf for more information from/@qualifier mandatory valid values direct zzz only used when synchronously responding to a multiple recipient message from/@friendlyname conditional value identifies a user friendly name of the sender used for display messageid mandatory the sender should ensure the combination of the from and messageid elements is unique for at least 18 months surescripts recommends an unformatted globally unique identifier (guid) relatestomessageid conditional on a responding message, this field is mandatory for the error, status, and verify messages, and is used to link the original message to the response senttime mandatory date of the transmission please see utc time format docid\ uhijxbzqnog 8wugh kb3 section sendersoftware mandatory identifies the entity responsible that generated the message contains the software vendor name, product, and version/release sendersoftwaredeveloper mandatory identifies the entity responsible for the software that generated the message the developer may be a software vendor or, if the software was developed "in house", the developer is the entity actually sending the message (e g , a chain) the value transmitted is determined by the sender software developer sendersoftwareproduct mandatory the text field that identifies the software developer’s product, as determined by the software developer sendersoftwareversionrelease mandatory the text field that identifies the version and release of the software product, as determined by the software developer testmessage conditional do not include this element in production messages recipientinformation mandatory used for guaranteed delivery only patientinformation conditional contains demographic information on the patient that is associated with the clinical message given conditional patient’s given (first name) middle conditional patient’s middle names(s) family conditional patient’s family (last name) suffix conditional patient’s name suffix dob conditional patient's date of birth in format yyyy mm dd where yyyy indicates the year mm indicates the month and dd indicates the day gender conditional patient’s administrative gender code valid values f = femalem = maleo = otheru = unknown zip conditional patient’s zip code in format of ##### or ######### (5 or 9 digit) please be aware that no hyphen is to be included identification conditional a collection of one or more patient identifiers for each occurrence, both \<id> and @issuer are required id mandatory a patient identification string id/@issuer mandatory a globally unique identifier representing the issuing authority for the patient id usecase conditional do not send for clinical direct messaging supplemental guides may contain additional instructions for this field customers may receive messages with this field populated