Element Details
9 min
requirement designation element attributes code description mandatory the element must be used per the specification (e g , xml schema validation) conditional the element must be used per the conditions specified the element tables include only those elements specifically utilized or supplied by rle it is assumed customers will be familiar with the ihe standard all data available should be included in every transaction for use by rle, even when not specifically listed in these tables xcpd iti 55 request message element code comment header element header mandatory messageid conditional message id of the request highly recommended, preferably a globally unique id must be 255 characters or less example urn\ uuid 5466c2e4 h5er 85ed 448e 432ed6t315e attribute/@name= "urn\ oasis\ names\ tc xspa 1 0\ subject organization"/ attributevalue mandatory the text value for the name of the organization note this is located in the saml 2 0 header example originator health clinic attribute/@name= "urn\ oasis\ names\ tc xspa 1 0\ subject organization id"/ attributevalue mandatory the unique id used by the organization, the organization’s home community id (oid) note this is located in the saml 2 0 header example urn\ oid 3 2 132 132132 1 32 13 2 1 3 321321 123 purposeofuse mandatory specifies the purpose or reason this patient data is being requested values are defined by the nhin purposeofuse currently, rle supports treatment, coverage, operations, payment, request, and public health more values will be supported in future releases link to nhin specification https //sequoiaproject org/wp content/uploads/2014/11/nhin authorization framework production specification v3 0 pdf https //sequoiaproject org/wp content/uploads/2014/11/nhin authorization framework production specification v3 0 pdf example name="urn\ oasis\ names\ tc\ xspa 1 0\ subject purposeofuse" codesystem="2 16 840 1 113883 3 18 7 1" code="treatment" body element body mandatory livingsubject administrativegender/ value/@code conditional gender recommended to provide if available (m, f, un) warning values other than m, f, and un will cause the message to be rejected by rle example m livingsubject birthtime/ value/@value mandatory birth date use yyyymmdd format example 19560804 livingsubject name/ value/given mandatory given name (first name) example adam livingsubject name/ value/given conditional second given name (middle name) example john note populate, if possible highly recommended to send to aid in patient matching livingsubject name/ value/family mandatory family name (last name) example everyman patientaddress/ value/ streetaddressline conditional patient address line 1 example 123 any street note populate, if possible highly recommended to send to aid in patient matching patientaddress/ value/ streetaddressline conditional patient address line 2 example apt 123 patientaddress/ value/ city conditional patient city example springfield note populate, if possible highly recommended to send to aid in patient matching patientaddress/ value/ state conditional patient address state example il note populate, if possible highly recommended to send to aid in patient matching patientaddress/ value/ postalcode mandatory patient postal code example 12345 note rle only supports us postal codes xcpd iti 55 response message element code comment header element header mandatory messageid conditional message id of the response highly recommended, preferably a globally unique id must be 255 characters or less example urn\ uuid 89d2e1e0 42e3 42c8 a507 221196d7bef6 note populate, if possible highly recommended to send to aid in patient matching relatesto conditional message id of the original request example urn\ uuid 5466c2e4 h5er 85ed 448e 432ed6t315e body element acknowledgement/ typecode mandatory indicator of whether a patient match was found examples aa = application accept this is returned when the message was successfully processed ae = application error this is returned when the message was unable to be processed query/ queryresponsecode mandatory indicator of the success of the transaction examples ok = data found, no errors nf = no patient match found, no errors ae = application error subject/ registrationevent/ subject1/ patient conditional contains patient demographics including patient id, patient name, and patient address for the matching patient within rle included when a patient match is found querybyparameter/ parameterlist mandatory echo back of the incoming request parameters plq iti 56 request message element code comment header element header mandatory messageid conditional message id of the request highly recommended, preferably a globally unique id must be 255 characters or less example urn\ uuid 52e5fg51 7ed4 dg2e 7548 2e555e2s6fd note populate, if possible highly recommended to send to aid in patient matching attribute/@name= "urn\ oasis\ names\ tc xspa 1 0\ subject organization"/ attributevalue mandatory the text value for the name of the organization example originator health clinic attribute/@name= "urn\ oasis\ names\ tc xspa 1 0\ subject organization id"/ attributevalue mandatory the unique id used by the organization, the organization’s home community id (oid) note this is located in the saml 2 0 header example urn\ oid 3 2 132 132132 1 32 13 2 1 3 321321 123 purposeofuse mandatory specifies the purpose or reason this patient data is being requested values are defined by the nhin purposeofuse currently, rle supports treatment, coverage, operations, payment, request, and public health more values will be supported in future releases link to nhin specification https //sequoiaproject org/wp content/uploads/2014/11/nhin authorization framework production specification v3 0 pdf https //sequoiaproject org/wp content/uploads/2014/11/nhin authorization framework production specification v3 0 pdf example name="urn\ oasis\ names\ tc\ xspa 1 0\ subject\ purposeofuse" codesystem="2 16 840 1 113883 3 18 7 1" code="treatment" body element body mandatory patientlocation queryrequest/ requestedpatientid/ @root mandatory the assigning authority of the patient id being requested example 2 16 840 1 113883 3 2054 2 1 patientlocation queryrequest/ requestedpatientid/ @extension mandatory the patient id extension for the patient being requested example 6509781 plq iti 56 response message element code comment header element header mandatory messageid conditional message id of this response highly recommended, preferably a globally unique id must be 255 characters or less example urn\ uuid 8f780679 e5b8 4769 aa99 ca21582aa6a3 note populate, if possible highly recommended to send to aid in patient matching relatesto conditional message id of the original request example urn\ uuid 52e5fg51 7ed4 dg2e 7548 2e555e2s6fd body element body mandatory note when locations exist, there could be one or multiple patient location response entries contained in the response example of multiple patient location response entries \<patientlocationresponse> \<homecommunityid>urn\ oid 1 3 6 1 4 1 21367 13 70 82\</homecommunityid> \<correspondingpatientid extension="280024" root="1 2872 1 1" /> \<requestedpatientid extension="6509781" root="2 16 840 1 113883 3 2054 2 1" /> \</patientlocationresponse> \<patientlocationresponse> \<homecommunityid>urn\ oid 2 16 840 1 113883 3 2054 2 1\</homecommunityid> \<correspondingpatientid extension="b320025" root="2 16 840 1 113883 3 333" /> \<requestedpatientid extension="6509781" root="2 16 840 1 113883 3 2054 2 1" /> \</patientlocationresponse> \<patientlocationresponse> \<homecommunityid>urn\ oid 2 16 840 1 113883 3 2054 2 1\</homecommunityid> \<correspondingpatientid extension="6509781" root="2 16 840 1 113883 3 2054 2 1" /> \<requestedpatientid extension="6509781" root="2 16 840 1 113883 3 2054 2 1" /> \</patientlocationresponse> \</patientlocationqueryresponse> patientlocation queryresponse/ patientlocationresponse/ homecommunityid mandatory the home community id associated with the patient id root and extension example urn\ oid 1 3 6 1 4 1 21367 13 70 82 patientlocation queryresponse/ patientlocationresponse/ correspondingpatientid/ @extension mandatory the patient id extension for the patient at the related home community example 280024 patientlocation queryresponse/ patientlocationresponse/ correspondingpatientid/ @root mandatory the assigning authority of the patient id at the related home community example 2 16 840 1 113883 3 333 xca query iti 38 request message element code comment header element header mandatory messageid conditional message id of the request highly recommended, preferably a globally unique id must be 255 characters or less example urn\ uuid 8dgs25ed he8s rtg5 wed1 26we15fs7ts note populate, if possible highly recommended to send to aid in patient matching attribute/@name= "urn\ oasis\ names\ tc xsa 1 0\ subject organization" /attributevalue mandatory the text value for the name of the organization example originator health clinic attribute/@name= "urn\ oasis\ names\ tc xspa1 0\ subject organization id" /attributevalue mandatory the unique id used by the organization, the organization’s home community id (oid) note this is located in the saml 2 0 header example urn\ oid 3 2 132 132132 1 32 13 2 1 3 321321 123 purposeofuse mandatory specifies the purpose or reason this patient data is being requested values are defined by the nhin purposeofuse currently, rle supports treatment, coverage, operations, payment, request, and public health more values will be supported in future releases link to nhin specification https //sequoiaproject org/wp content/uploads/2014/11/nhin authorization framework production specification v3 0 pdf https //sequoiaproject org/wp content/uploads/2014/11/nhin authorization framework production specification v3 0 pdf example name="urn\ oasis\ names\ tc\ xspa 1 0\ subject\ purposeofuse" codesystem="2 16 840 1 113883 3 18 7 1" code="treatment" body element body mandatory adhocqueryrequest mandatory slot name= "$xdsdocumententry patientid"/ valuelist/value mandatory patient of interest patient id formatted per hl7 example 6509781^^^\&2 16 840 1 113883 3 2054 2 1 in the example, 6509781 is the patient id and 2 16 840 1 113883 3 2054 2 1 is the assigning authority slot name= "$xdsdocument entrystatus"/ valuelist/value mandatory example urn\ oasis\ names\ tc\ ebxml regrep\ statustype\ approved additional document metadata attributes conditional rle supports receipt of additional document metadata parameters per the ihe standard see ihe documentation for a complete list note rle respects metadata parameters when determining whether to include information on the surescripts location summary cda in the xca query response in addition, rle will pass all input on to additional responders and return all responses from those sources to the original requester each responding system will handle filtering of documents included in the request within the responding system xca query iti 38 response message the response will include metadata for the location summary, if applicable element code comment header element header mandatory messageid mandatory message id of the response highly recommended, preferably a globally unique id must be 255 characters or less example urn\ uuid 34268e47 fdf5 41a6 ba33 82133c465248 relatesto conditional message id of the original request example urn\ uuid 8dgs25ed he8s rtg5 wed1 26we15fs7ts body element body mandatory adhocqueryresponse mandatory totalresultcount mandatory count of the number of documents available for the requested patient example totalresultcount="1" example when no documents are found totalresultcount="0" status mandatory indicates success or failure of the processing of the request example urn\ oasis\ names\ tc\ ebxml regrep\ responsestatustype\ success example indicating an error occurred in processing urn\ oasis\ names\ tc\ ebxml regrep\ responsestatustype\ failure see the example error message below for more information registryobjectlist/ extrinsicobject conditional when available, document metadata for one or more documents from rle represented repositories will be returned metadata for each document is included as an extrinsicobject in the registryobjectlist mimetype mandatory mime type of the document example text/xml status mandatory status of the document example urn\ oasis\ names\ tc\ ebxml regrep\ statustype\ approved home mandatory globally unique identifier for the community where this document may be retrieved example urn\ oid 2 16 840 1 113883 3 2054 2 1 repositoryuniqueid mandatory globally unique identifier of the repository where this document may be found example 2 16 840 1 113883 3 2054 2 1 sourcepatientid conditional patient identifier for the subject of care formatted per hl7 field will be populated if the sourcepatientid was returned by the responder be sure to note, though, that not all responders (ex responders who use fhir messaging) return a value that is equivalent to the sourcepatientid example 6509781^^^\&2 16 840 1 113883 3 2054 2 1\&iso in the example, 6509781 is the patient id and 2 16 840 1 113883 3 2054 2 1 is the assigning authority uri mandatory file containing the document example locationsummary xml name mandatory the name of this document example surescripts location summary authorinstitution mandatory represents the entity that authored the document authorinstitution is critical to several receiving application systems it is displayed to users as the organization or provider with available documents to allow the user to determine whether or not to request these records for responders that represent multiple organizations within the same home community, this element is required example 1 surescripts^^^^^^^^^2 16 840 1 113883 3 2054 2 1 example 2 miller orthopedics classcode mandatory the code specifying the particular kind of document class code consists of a code, coding scheme, and name location summary uses loinc code 56816 2 loinc coding scheme is specified by the oid value 2 16 840 1 113883 6 1 code mandatory example 56816 2 codingscheme mandatory example 2 16 840 1 113883 6 1 name mandatory example location summary formatcode mandatory code globally uniquely specifying the format of the document combined with typecode, it allows consumers to know how to process the document format code consists of a code, coding scheme and name http //wiki ihe net/index php?title=ihe format codes http //wiki ihe net/index php?title=ihe format codes code mandatory example urn\ ihe\ pcc\ xphr 2007 codingscheme mandatory example 1 3 6 1 4 1 19376 1 2 3 name mandatory example exchange of personal health records typecode mandatory type code is set to the same values as class code code mandatory example 56816 2 codingscheme mandatory example 2 16 840 1 113883 6 1 name mandatory example location summary xdsdocumententry uniqueid mandatory globally unique identifier for this document example 2 16 840 1 113883 3 2054 2 1 1503551 xdsdocumententry patientid mandatory the person represented as the subject of care of the document root / assigning authority for surescripts rle is 2 16 840 1 113883 3 2054 2 1 example 6509781^^^\&2 16 840 1 113883 3 2054 2 1\&iso in the example, 6509781 is the patient id and 2 16 840 1 113883 3 2054 2 1 is the assigning authority xca retrieve iti 39 request message element code comment header element header mandatory messageid conditional message id of the request highly recommended, preferably a globally unique id must be 255 characters or less example urn\ uuid\ ew8d2w81 95we h2w8 71e5 25w5f1sd6f1 note populate, if possible highly recommended to send to aid in patient matching attribute/@name= "urn\ oasis\ names\ tc xspa 1 0\ subject organization" /attributevalue mandatory the text value for the name of the organization example originator health clinic attribute/@name= "urn\ oasis\ names\ tc xspa 1 0\ subject organization id" /attributevalue mandatory the unique id used by the organization, the organization’s home community id (oid) note this is located in the saml 2 0 header example urn\ oid 3 2 132 132132 1 32 13 2 1 3 321321 123 purposeofuse mandatory updated comment to the following specifies the purpose or reason this patient data is being requested values are defined by the nhin purposeofuse currently, rle supports treatment, coverage, operations, payment, request, and public health more values will be supported in future releases link to nhin specification https //sequoiaproject org/wp content/uploads/2014/11/nhin authorization framework production specification v3 0 pdf https //sequoiaproject org/wp content/uploads/2014/11/nhin authorization framework production specification v3 0 pdf example name="urn\ oasis\ names\ tc\ xspa 1 0\ subject\ purposeofuse" codesystem="2 16 840 1 113883 3 18 7 1" code="treatment" body element body mandatory documentrequest mandatory even though the ihe standard allows a single xca retrieve to include multiple documentrequest elements, surescripts highly recommends that each document is requested in a separate xca retrieve message this will prevent any one document retrieval that may be slow from delaying return of all requested documents homecommunityid mandatory value of the home community for the requested document comes from the xca query response metadata example urn\ oid 2 16 840 1 113883 3 2054 2 1 repositoryuniqueid mandatory value of the repository where the requested document is located comes from the xca query response metadata example 2 16 840 1 113883 3 2054 2 1 documentuniqueid mandatory value of the unique id for the requested document comes from the xca query response metadata example 2 16 840 1 113883 3 2054 2 1 1503551 xca retrieve iti 39 response message element code comment header element header mandatory messageid conditional message id of the request highly recommended, preferably a globally unique id must be 255 characters or less example urn\ uuid 3e9cabc7 e902 44b3 8c33 a3ccc88b108f note populate, if possible highly recommended to send to aid in patient matching relatesto conditional contains the message id from the original xca retrieve request example urn\ uuid\ ew8d2w81 95we h2w8 71e5 25w5f1sd6f1 body element body mandatory registryresponse status mandatory indicates success, partial success, or error example urn\ oasis\ names\ tc\ ebxml regrep\ responsestatustype\ success documentresponse mandatory homecommunityid mandatory value of the home community for the requested document example urn\ oid 2 16 840 1 113883 3 2054 2 1 repositoryuniqueid mandatory value of the repository where the requested document is located example 2 16 840 1 113883 3 2054 2 1 documentuniqueid mandatory value of the unique id for the requested document example 2 16 840 1 113883 3 2054 2 1 1503551 newdocumentuniqueid mandatory value of the unique id for the document returned may be different than the documentuniqueid requested for example, when returning an on demand document example 2 16 840 1 113883 3 2054 2 1 53008141 mimetype mandatory mime type of the attached document example text/xml document mandatory encoded document