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 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 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 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
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 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.