Skip to main content
Jump to: navigation, search

Difference between revisions of "OHF Using XDS.b"

(XDS.b Document Consumer)
(XDS.b Document Consumer)
Line 13: Line 13:
 
The OHF XDS.b Document Consumer implements two transactions:  Registry Stored Query and Retrieve Document Set.  The Stored Query transaction is semantically identical to the XDS.a Registry Stored Query transaction.  The Retrieve Document Set transaction is new.
 
The OHF XDS.b Document Consumer implements two transactions:  Registry Stored Query and Retrieve Document Set.  The Stored Query transaction is semantically identical to the XDS.a Registry Stored Query transaction.  The Retrieve Document Set transaction is new.
  
''' XDS.b Document Consumer API '''
+
The XDS.b Document Consumer API is controlled by the class '''org.eclipse.ohf.ihe.xds.consumer.B_Consumer'''.
  
The XDS.b Document Consumer API is controlled by the '''class org.eclipse.ohf.ihe.xds.consumer.B_Consumer'''.
+
==== Registry Stored Query ====
  
''' Registry Stored Query '''
+
==== Retrieve Document Set ====
 
+
''' Retrieve Document Set '''
+
  
 
Due to the nature of the XDS.b profile, a new transaction Retrieve Document Set has been created.  The API is as follows:
 
Due to the nature of the XDS.b profile, a new transaction Retrieve Document Set has been created.  The API is as follows:
 
  XDSResponseType org.eclipse.ohf.ihe.xds.consumer.B_Consumer.retrieveDocumentSet(RetrieveDocumentSetRequestType,List);
 
  XDSResponseType org.eclipse.ohf.ihe.xds.consumer.B_Consumer.retrieveDocumentSet(RetrieveDocumentSetRequestType,List);
  
 +
* Parameter 1:  '''RetrieveDocumentSetRequestType'''
 
The '''RetrieveDocumentSetRequestType''' is an EMF-generated structure that represents a request for a document set in XDS.b.  It contains a list of requests with each request containing minimally a '''repositoryUniqueId''' and a '''documentUniqueId'''.   
 
The '''RetrieveDocumentSetRequestType''' is an EMF-generated structure that represents a request for a document set in XDS.b.  It contains a list of requests with each request containing minimally a '''repositoryUniqueId''' and a '''documentUniqueId'''.   
  
Optionally, each request can contain a '''homeCommunityId''' - the identifier for use with cross-community requests (XCA).  Per the XDS specification, any query that contains a '''homeCommunityId''', all subsequent queries or requests related to the result must contain the '''homeCommunityId'''.  Please see the section about using XCA for more information.
+
Optionally, each request can contain a '''homeCommunityId''' - the identifier for use with cross-community requests (XCA).  Per the XDS specification any XDS query result that contains a homeCommunityId, all subsequent queries or requests related to the result must contain the homeCommunityId.  Please see the section about using XCA for more information.
  
The second parameter, a List, should be a pre-instantiated list that will contain the documents in response.  These results will be of type org.eclipse.ohf.ihe.xds.document.Document and contains a byte array, MIME type, documentUniqueId, repositoryUniqueId, and (optionally) homeCommunityId.
+
* Parameter 2:  List
 +
The second parameter, a List, is a pre-instantiated list that will contain the documents in response.  These results will be of type org.eclipse.ohf.ihe.xds.document.Document and contains a byte array, MIME type, documentUniqueId, repositoryUniqueId, and (optionally) homeCommunityId.

Revision as of 19:04, 24 October 2007

About XDS.b

XDS.b is a profile proposed and accepted for trial implementation in the 2007-2008 IHE profile cycle. The primary purpose of the profile is to take the existing XDS specification and make it more consistent with existing and emerging Web service standards.

To read the trial implementation of the XDS.b profile, please see the IHE XDS.b Supplement

The previous XDS profile has been renamed to XDS.a.

XDS.b and OHF

The version of OHF for use at the 2007-2008 IHE Connectathon supports the XDS.b Document Consumer and the XDS.b Document Source in addition to the existing support for XDS.a Document Consumer and Source.

XDS.b Document Consumer

The OHF XDS.b Document Consumer implements two transactions: Registry Stored Query and Retrieve Document Set. The Stored Query transaction is semantically identical to the XDS.a Registry Stored Query transaction. The Retrieve Document Set transaction is new.

The XDS.b Document Consumer API is controlled by the class org.eclipse.ohf.ihe.xds.consumer.B_Consumer.

Registry Stored Query

Retrieve Document Set

Due to the nature of the XDS.b profile, a new transaction Retrieve Document Set has been created. The API is as follows:

XDSResponseType org.eclipse.ohf.ihe.xds.consumer.B_Consumer.retrieveDocumentSet(RetrieveDocumentSetRequestType,List);
  • Parameter 1: RetrieveDocumentSetRequestType

The RetrieveDocumentSetRequestType is an EMF-generated structure that represents a request for a document set in XDS.b. It contains a list of requests with each request containing minimally a repositoryUniqueId and a documentUniqueId.

Optionally, each request can contain a homeCommunityId - the identifier for use with cross-community requests (XCA). Per the XDS specification any XDS query result that contains a homeCommunityId, all subsequent queries or requests related to the result must contain the homeCommunityId. Please see the section about using XCA for more information.

  • Parameter 2: List

The second parameter, a List, is a pre-instantiated list that will contain the documents in response. These results will be of type org.eclipse.ohf.ihe.xds.document.Document and contains a byte array, MIME type, documentUniqueId, repositoryUniqueId, and (optionally) homeCommunityId.

Back to the top