ebXML+Registry+Services+and+Protocols+Version+3.0

ebXML Registry Services and Protocols Version 3.0 OASIS Standard, 2 May, 2005 [|Full Document]

This document defines the services provided by an ebXML Registry and the protocols used by clients of the registry to interact with these services.

Relevent Sections for NHIN Specifications  section 6.1.1 **The AdhocQueryRequest**

Required Paramaters include:
 * The AdhocQueryRequest** is used to submit a query to the registry. This request returns an AdhocQueryResponse.
 * ** AdhocQueryRequest ** ||  ||
 * ** Parameter Names ** || ** Required values ** || Description || Required ||
 * AdhocQuery || ** queryExpression ** || specifies the actual query || R?? ||
 * federated ||  || specifies that the registry must process this query as a federated query || O ||
 * totalResultCount ||  || specifies the size of the complete result set matching the query within the registry || O ||
 * federation ||  || specifies the id of the target Federation for a federated query || O ||
 * maxResults ||  || specifies a limit on the maximum number of results the client wishes the query to return || O ||
 * ResponseOption ||  || allows the client to control the format and content of the AdhocQueryResponse || R ||
 * startIndex ||  || value is used to indicate which result must be returned as the first result || O ||

 section 6.1.1 **The AdhocQueryResponse**

that matched the specified query || R?? || in the result set returned by the query || O || set matching the query within the registry || O ||
 * ** AdhocQueryResponse ** ||  ||
 * ** Parameter Names ** || ** Required values ** || Description || Required ||
 * RegistryObjectList ||  || contains the RegistryObject instances
 * $ startIndex ||  || integer value indicates the index for the first result
 * totalResultCount ||  || specifies the size of the complete result

- Success - PartialSuccess - Failure || See references ITI-TF6 section for URN and format requirements. ||
 * ** Query Response ** ||  || - ||   ||
 * ** AdHocQueryResponse Status Value ** || IHE ITI-TF6: 3.18.4.1.2.3.5 || ** Required, ** shall contain **ONE** of the following:

6.3.2 Invoking a Stored Query A stored query is invoked using the AdhocQueryRequest with the following constraints:
 * The  element MUST not contain a  element.
 * The  element's id attribute value MUST match the id attribute value of the store query.
 * The  element MAY have a Slot for each non-context parameter defined for the stored query being invoked. These Slots provide the value for the query parameters.

6.3.2.1 Specifying Query Invocation Parameters A stored query MAY be defined with zero or more parameters. A client may specify zero or more of the parameters defined for the stored query when submitting the AdhocQueryRequest for the stored query. It is important to note that the client MAY specify fewer parameters than those declared for the stored query. A registry MUST prune any predicates of the stored query that contain parameters that were not supplied by the client during invocation of the stored query. In essence, the client may narrow or widen the specificity of the search by supplying more or less parameters.

A client specifies a query invocation parameter by using a Slot whose name matches the parameter name and whose value MUST be a single value that matches the specified value for the parameter. A registry MUST ignore any parameters specified by the client for a stored query that do not match the parameters defined by the stored query. The following listing shows an example of how the stored query shown earlier is invoked. It shows: • The stored query being identified by the value of the id attribute of the  element. • The value for the $name parameter being supplied • The value of other parameters defined by the query not being supplied. This indicates that the client does not wish to use those parameters as serach criterea.

6.3.3 Response to Stored Query Invocation A registry MUST send a standard AdhocQueryResponse when a client invokes a stored query using an AdhocQueryRequest.

- 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 NHIN. || Example Link || Where is format specified? Vol3? UTC? ||
 * |||||| 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. ||