IT+Infrastructure+Technical+Framework+Volume+2a

IT Infrastructure Technical Framework Volume 2a 10 (ITI TF-2a) Transactions Part A – Sections 3.1 – 3.28 Revision 6.0 – Final Text August 10, 2009 [|Full Document]

This document, the IHE IT Infrastructure Technical Framework (ITI TF), defines specific implementations of established standards to achieve integration goals that promote appropriate sharing of medical information to support optimal patient care.

Sections Relevant to NHIN Specifications:

3.18 Registry Stored Query

This section corresponds to Transaction 18 of the IHE Technical Framework. Transaction 18 is used by the Document Registry and Document Consumer actors. The Registry Stored Query transaction supports a variety of types of queries. Examples include the following: The list of XDS registry entries attributes that can be the target of a query are defined in ITI TF-3: 4.1.7 through 4.1.9. This transaction will document the basic syntax and semantics of XDS Document Registry queries.
 * Query by patient (Id) for a time interval, by document type(s), by practice setting(s), by author person
 * Query by Document Source
 * Query for XDS Folders updated during a time interval
 * Query for all documents in a Folder or Submission Set
 * Query by time of submission

All queries return:
 * Metadata for one or more registry objects, or
 * Object references for one or more registry objects (registry UUIDs).

Registry Stored Query is a query request to the Document Registry from a Document Consumer. The query request contains:
 * A reference to a pre-defined query stored on the Document Registry actor.
 * Parameters to the query. The query parameters are matched up with the query variables defined in the query definition on the Document Registry actor.

Implementors of this transaction shall comply with all requirements described in [|ITI TF-2x: Appendix V: Web Services for IHE Transactions] except for the level of SOAP supported.
 * Profile implemented by actor || SOAP level required of actor ||
 * XDS.a || SOAP 1.1 ||
 * XDS.b || SOAP 1.2 ||
 * XDS.a & XDS.b || SOAP 1.1 and SOAP 1.2 for all Registry Stored Query requests without reconfiguration or restart ||

3.18.4.1.2.3 Query Request Parameters – Coding Style The ebXML Registry stored query facility (Invoke Stored Query transaction) accepts the following parameters:
 * returnType – ‗LeafClass‘ or ‗ObjectRef‘
 * Query ID – a UUID from the Stored Query IDs section (ITI TF-2a: 3.18.4.1.2.4)
 * Query Parameters – as defined in the Query Parameters section (ITI TF-2a: 3.18.4.1.2.3.7)

3.18.4.1.2.4 Stored Query IDs

The standard XDS queries are assigned the following Query IDs. These IDs are used in the AdhocQueryRequest to reference queries stored on the Document registry actor. Query IDs are in UUID format (RFC4122). An error shall be returned when an unsupported stored query ID is received.


 * Query Name || Query ID ||
 * FindDocuments || urn:uuid:14d4debf-8f97-4251-9a74-a90016b0af0d ||
 * FindSubmissionSets || urn:uuid:f26abbcb-ac74-4422-8a30-edb644bbc1a9 ||
 * FindFolders || urn:uuid:958f3006-baad-4929-a4de-ff1114824431 ||
 * GetAll || urn:uuid:10b545ea-725c-446d-9b95-8aeb444eddf3 ||
 * GetDocuments || urn:uuid:5c4f972b-d56b-40ac-a5fc-c8ca9b40b9d4 ||
 * GetFolders || urn:uuid:5737b14c-8a1a-4539-b659-e03a34a5e1e4 ||
 * GetAssociations || urn:uuid:a7ae438b-4bc2-4642-93e9-be891f7bb155 ||
 * GetDocumentsAndAssociations || urn:uuid:bab9529a-4a10-40b3-a01f-f68a615d247a ||
 * GetSubmissionSets || urn:uuid:51224314-5390-4169-9b91-b1980040715a ||
 * GetSubmissionSetAndContents || urn:uuid:e8e3cb2c-e39c-46b9-99e4-c12f57260b83 ||
 * GetFolderAndContents || urn:uuid:b909a503-523d-4517-8acf-8e5834dfc4c7 ||
 * GetFoldersForDocument || urn:uuid:10cae35a-c7f9-4cf5-b61e-fc3278ffb578 ||
 * GetRelatedDocuments || urn:uuid:d90e5407-b356-4d91-a89f-873917b4b0e6 ||

 Sections 3.16.4.1.4.1 and 3.18.4.1.2.3.7.1 FindDocuments

Definition: Find documents (XDSDocumentEntry objects) in the registry for a given patientID with a matching‗status‘ attribute. The other parameters can be used to restrict the set of XDSDocumentEntry objects returned. Returns: XDSDocumentEntry objects matching the query parameters Parameters:


 * ** FindDocuments ** ||||||  ||
 * ** Parameter Names ** || Attribute || Opt || Mult ||
 * $XDSDocumentEntryPatientId || XDSDocumentEntry. patientId || R || -- ||
 * $XDSDocumentEntryClassCode || XDSDocumentEntry. classCode || R || M ||
 * $XDSDocumentEntryTypeCode || XDSDocumentEntry.typeCode || O || M ||
 * $XDSDocumentEntryPracticeSettingCode || XDSDocumentEntry.practiceSettingCode || O || M ||
 * $XDSDocumentEntryCreationTimeFrom || Lower value of XDSDocumentEntry.creationTime || O || -- ||
 * $XDSDocumentEntryCreationTimeTo || Upper value of XDSDocumentEntry.creationTime || O || -- ||
 * $XDSDocumentEntryServiceStartTimeTo || Lower value of XDSDocumentEntry. serviceStartTime || O || -- ||
 * $XDSDocumentEntryServiceStartTimeTo || Upper value of XDSDocumentEntry.serviceStartTime || O || -- ||
 * $XDSDocumentEntryServiceStopTimeFrom || Lower value of XDSDocumentEntry.serviceStopTime || O || -- ||
 * $XDSDocumentEntryServiceStopTimeTo || Upper value of XDSDocumentEntry.serviceStopTime || O || -- ||
 * $XDSDocumentEntryHealthcareFacilityTypeCode || XDSDocumentEntry.healthcareFacilityTypeCode || O || M ||
 * $XDSDocumentEntryEventCodeList || XDSDocumentEntry.eventCodeList3 || O || M ||
 * $XDSDocumentEntryConfidentialityCode || XDSDocumentEntry.confidentialityCode3 || O || M ||
 * $XDSDocumentEntryAuthorPerson || XDSDocumentEntry.confidentialityCode3 || O || M ||
 * $XDSDocumentEntryFormatCode || XDSDocumentEntry. formatCode || O || M ||
 * $XDSDocumentEntryStatus || XDSDocumentEntry. status || R || M ||

 Sections .16.4.1.4.4 and 3.18.4.1.2.3.7.4 GetAll

Definition: Get all registry content for a patient given the indicated status, format codes, and confidentiality codes. Returns:
 * XDSSubmissionSet, XDSDocumentEntry, and XDSFolder objects with patientId attribute matching $patientId parameter
 * Association objects with sourceObject or targetObject attribute matching one of the above objects

XDSSubmissionSet. patientId, XDSDocumentEntry. patientId || R || -- || confidentialityCode1 || O || M ||  sections 3.16.4.1.4.5 and 3.18.4.1.2.3.7.5 GetDocuments
 * ** Get All ** ||||||  ||
 * ** Parameter Names ** || Attribute || Opt || Mult ||
 * $patientId || XDSFolder. patientId,
 * $XDSDocumentEntryStatus || XDSDocumentEntry. status || R || M ||
 * $XDSSubmissionSetStatus || XDSSubmissionSet. status || R || M ||
 * $XDSFolderStatus || XDSFolder. status || R || M ||
 * $XDSDocumentEntryFormatCode || XDSDocumentEntry. formatCode || O || M ||
 * $XDSDocumentEntryConfidentialityCode || XDSDocumentEntry.

Definition: Retrieve a collection of XDSDocumentEntry objects. XDSDocumentEntry objects are selected either by their entryUUID or uniqueId attribute.

Returns: XDSDocumentEntry objects requested

Parameters:
 * ** Get Documents ** ||||||  ||
 * ** Parameter Names ** || Attribute || Opt || Mult ||
 * $XDSDocumentEntryEntryUUID || XDSDocumentEntry. entryUUID || R || M ||
 * $$XDSDocumentEntryUniqueId || XDSDocumentEntry. uniqueId || R || M ||
 * $homeCommunityId || None || O || -- ||