Query+Refactoring

=Query for Documents - Refactoring Efforts=

Purpose:
To improve the ease of understanding and usability of Nationwide Health Information Network specifications for implementers. See the Refactoring Effort page for an overview.

Identified Needs for Specification Work

 * Submitter || Topic || Owner ||
 * Rich Kernan || Message Semantics section which runs through Query Request Parameters and Query Parameters. Clear list of parameters, definitions, and formats with pointers to specific sections in referenced documentation and implementation guidance topics. || Rich Kernan ||
 * Rich Kernan || Definition of conformance criteria --> source for test team || Joe Lamy ||
 * Rich Kernan || List of top level implementation guidance topics to which specification readers can be pointed from within the spec document. || Rich Kernan ||

Identified Needs for Implementation Guidance

 * Submitter || Topic || Owner ||
 * Group || Explanation of Stored Query, available classes of stored query, and use of Object Ref vs. Leaf Class || Rich Kernan ||
 * Tony Mallia / VA || Explicit definition and rules for the Find Docs query || Tony Mallia ||

Refactoring Discussion and Work in Progress


 * Query for Documents- Current Production Specification Draft**

Nationwide Health Information Network Query for Documents adopts Cross Gateway Query (ITI-38), which inherits message semantics from Registry Stored Query (ITI-18), which inherits message semantics from AdhocQuery Request. AdhocQuery message semantics are defined in Section 6.3.2 and 6.3.3, respectively of ebXML Registry Services and Protocols (ebRS) version 3.0, published by OASIS. [|IHE's SOA Whitepaper]

Nationwide Health Information Network Query for Documents adopts IHE Transaction 38, Cross Gateway Query, which is specified in ITI-TF6_XCA Supplement (8/10/2009). Message semantics are defined across several underlying specifications. The information contained in this section is NOT intended to serve as a substitute for careful review of those referenced documents and sections. Instead, it is intended to enable implementers to more efficiently locate information.  · Section 3.38.4.1.2 of the XCA Supplement explains that Cross Gateway Query message semantics are based on those specified for IHE Transaction 18, Registry Stored Query, which are defined in ITI-TF6-2a: 3.18.4.1.2.3. Of special note in 3.38.4.1.2 are:  - Use of Home Community ID  - Specifying patient identifier  - Special handling of stored query  · ITI-TF6-2a Section 3.18.4.1.2 explains that Registry Stored Query message semantics are defined in Section 6.3.2 and 6.3.3 of ebXML Registry Services and Protocols (ebRS) version 3.0, published by OASIS. Of special note in ITI-TF6-2a Section 3.18.4.1.2 are:  - Guidance provided regarding the version 3.0 ebXML Registry Standard  - A Sample Query Request  - Coding style requirements for Query Request Parameters

- ObjectRef - LeafClass || Specifies the requested return type based on desired return type – see guidance || 3.18.4.1.2.3.4 || ** Required ** ** Value (table link) ** || Holds the UUID assigned to the Stored Query to be invoked || - ** Optional ** for all other queries - ** Max of 1 ** || Specified as the home attribute on the AdhocQuery element of the query request, as in:  || - FindDocuments - FindSubmissionSets - FindFolders - GetAll - ** Disallowed ** for others || If unknown to the responding gateway, shall return successful reply with no elements || Submitted Approved Deprecated || Denotes the ebRIM 3.0 Registry Object status values used by XDS and extended by Nationwide Health Information Network. || Example Link || Where is format specified? Vol3? UTC? || - Success - PartialSuccess - Failure || See references ITI-TF6 section for URN and format requirements. ||
 * ** Query Request Parameters ** |||||| The ebXML Registry Stored Query (Invoke Store Query transaction) accepts the following parameters ||
 * ** returnType ** || IHE ITI-TF6: 3.18.4.1.2.3.1 || ** Required, values: **
 * ** QueryID ** || IHE ITI-TF6: 3.18.4.1.2.3.2 &
 * ** homeCommunityID ** (of the responding gateway) || XCA Supplement: 3.38.4.1.2.1 ||  - ** Required ** for queries which do NOT include a Patient Identifier parameter
 * ** homeCommunityID ** (of the responding gateway) || XCA Supplement: 3.38.4.1.2.1 ||  - ** Required ** for queries which do NOT include a Patient Identifier parameter
 * ** homeCommunityID ** (of the responding gateway) || XCA Supplement: 3.38.4.1.2.1 ||  - ** Required ** for queries which do NOT include a Patient Identifier parameter
 * ** homeCommunityID ** (of the responding gateway) || XCA Supplement: 3.38.4.1.2.1 ||  - ** Required ** for queries which do NOT include a Patient Identifier parameter
 * ** Patient Identifier ** || XCA Supplement: 3.38.4.1.2.2 || - ** Required ** for:
 * ** Patient Identifier ** || XCA Supplement: 3.38.4.1.2.2 || - ** Required ** for:
 * ** StatusType ** || IHE ITI-TF6: 3.18.4.1.2.3.6 || ** Required **
 * ** Coding Requirements ** ||||||  ||
 * ** Date/Time ** || IHE ITI-TF6: 3.18.4.1.2.3.3 || All Date/Time values are to be inclusive
 * ** Code and Code Scheme ** || IHE ITI-TF6: 3.18.4.1.2.3.4 || ** Must conform to ** an abbreviated version of HL7 2.5 CE. See referenced ITI section for details. ||   ||
 * ** Single and Multiple Values ** || IHE ITI-TF6: 3.18.4.1.2.3.5 || ** Must conform ** to referenced ITI section. ||   ||
 * ** Query Response ** ||  || - ||   ||
 * ** AdHocQueryResponse Status Value ** || IHE ITI-TF6: 3.18.4.1.2.3.5 || ** Required, ** shall contain **ONE** of the following:

