View source for OHF IHE MAIN BRANCH

Back to: [[OHF IHE]]

Back to: [[OHF Bridge]]

== Introduction ==
The main trunk in CVS is the development branch. This code is being perpared and tested for the 2008 North American Connectathon. Details regarding the main trunk, as well as documentation regarding changes from previous branches is documented here. 

=== Current Status ===
Initial versions of the IHE and OHF Bridge plug-ins for use at the 2008 IHE Connecathons are now available.  These files are labeled as OHF IHE and OHF Bridge 0.3.0.v.XXX.  We will use this numbering scheme for binaries compatible with 2007-2008 IHE infrastructure.  If you are interested in using OHF with 2006-2007 IHE infrastructure, please see the 0.2.0 branch and refer to [[OHF IHE 2007 BRANCH]].

For 2008, the following changes have been made in terms of IHE funcionality:
* All CPs relevant to the existing ATNA, PIX, PDQ, and XDS code have been applied
* Support for the new XDS.b profile added
* Support for the new XCA profile added
* Support for the PDQ Demographics and Visit query (PDVQ) added

Known outstanding issues
* ATNA CP 164 is still under debate in IHE and we will finalize OHF code changes once this debate concludes.
* Support for the new XUA profile is forthcoming

This code is in alpha state and we continue to work through the pre-Connectathon testing requirements. Please watch the newsgroup for more information as this becomes available.  Also, continue to monitor the newsgroup and mailing list as we update the binaries with bug fixes as we move toward Connectathon.

=== Downloads ===
For binary downloads of the 0.3.0 versions, please see the official OHF Connectathon Downloads page:
* http://www.eclipse.org/ohf/downloads/connectathon.php

== Documentation ==
To be posted soon. For now refer to the PDF's posted on the [[OHF IHE]] site and the list of API changes below. Additionally, notes on using OHF to execute XDS.b transactions can be found on the following site:
*[[OHF_Using_XDS.b | '''OHF_Using_XDS.b''']]

== API Changes from OHF IHE 2007 BRANCH ==
A number of changes have been made between the 2007 branch and the 2008 branch.  Major changes are listed below:

===IHE ATNA Plug-ins===
'''Change 1:'''  ''Initiating User and Audit Source Id now set in context''

--> FOR PLUG-IN USERS
In previous years, the initiating user for ATNA was specified at the call to the actor transaction (for example, PixConsumer.sendQuery()). The ATNA API now exposes two methods, one for setting the initiating user and another for setting the audit source id.  To set these values, use the following calls in your code before you make a call to a PIX, PDQ, or XDS actor.

For setting the initiating user
AtnaAgentFactory.getAtnaAgent().setInitiatingUser("AuditUserName");

For setting the Audit Source Id.  For Connectathon, this will be your system name - "OTHER_IBM", etc.
AtnaAgentFactory.getAtnaAgent().setInitiatingUser("ConnectathonSystemName");

--> FOR BRIDGE USERS
You are not affected by these changes.  These values will be pulled from the SessionContext.user and SessionContext.userApplicationName, respectively (as normal).


'''Change 2:''' ''<font color="#ff0000">Pending Integration with CP 164</font>''

Changes to the ATNA API are *NOT YET COMPLETE* and are pending some work from the IHE to close gaps in ITI CP-164.  If you are using the ATNA API directly, then I recommend that you wait until this is cleared up before attempting to incorporate the changes.  Please note:  THIS DOES NOT AFFECT MOST USERS, AS MOST AUDITING IS TAKEN CARE OF BY THE CORE ACTORS.

=== IHE PIX/PDQ Plug-ins ===
'''Change 1:'''  ''API change removed the initiatingUser parameter.''

--> FOR PLUG-IN USERS
Remove the last string parameter from existing PIX/PDQ actor calls.

--> FOR BRIDGE USERS
You are not affected by this change.


'''Change 2:'''  ''API change to enable PDQ Patient Demographics and Visit Queries.''

--> FOR PLUG-IN USERS
The addition of a second query and response type to PDQ code was done in an identical way that PIX code supports multiple message types.  Anyone using PDQ from last year will need to update their code.

For PDQ-only queries:

Old -    PdqConsumer pdqQuery = new PdqConsumer(...);
    PdqConsumerQuery message = pdqQuery.createQuery();
    pdqQuery.sendQuery(message, isValidateOn, auditUser);

New -    PdqConsumer pdqQuery = new PdqConsumer(...);
    PdqConsumerDemographicQuery message = pdqQuery.createDemographicQuery();
    pdqQuery.sendDemographicQuery(message, isValidateOn);

For PDVQ queries (including visit data):

New -    PdqConsumer pdqQuery = new PdqConsumer(...);
    PdqConsumerVistQuery message = pdqQuery.createVistQuery();
    pdqQuery.sendVistQuery(message, isValidateOn);

--> FOR BRIDGE USERS
You are not affected by this change.  The Bridge does not yet support PDVQ queries.

=== IHE XDS Plug-ins ===
The XDS plug-ins have been through serious refactoring to comply with 2007-2008 CPs and to add support for XDS.b.

'''Change 1:'''  ''API change removed the initiatingUser parameter.''

--> FOR PLUG-IN USERS
Remove the last string parameter to each of the API calls to the actor plugins

--> FOR BRIDGE USERS
You are not affected by this change.


'''Change 2:'''  ''XDS Responses are now wrapped in an "XDSResponseType", containing a list of error codes to be compliant with CPs.''

--> FOR PLUG-IN USERS
All responses from the XDS Consumer and XDS Source will now come back as an extension of type "XDSResponseType".  For more information
about the XDSResponseType, please see the interface:
    org.eclipse.ohf.ihe.xds.response.XDSResponseType

If you are doing an XDS Query, use the response type:
    org.eclipse.ohf.ihe.xds.response.XDSQueryResponseType

--> FOR BRIDGE USERS
The error response data will be copied into existing data structures in the Bridge response type(s).

'''Change 3:'''  ''Added org.eclipse.ohf.ihe.xds.consumer.B_Consumer, org.eclipse.ohf.ihe.xds.source.B_Source, respectively, for IHE XDS.b support''

--> FOR PLUG-IN USERS
For more information on this, please see the following link: http://wiki.eclipse.org/OHF_Using_XDS.b

--> FOR BRIDGE USERS
For more information on this, please see the following link: http://wiki.eclipse.org/OHF_Using_XDS.b
 
=== OHF Bridge plug-ins ===
In addition to the changes listed above, the Bridge has encountered some minor refactoring to API calls.  It will be necessary to regenerate your Web service proxy to reflect the API changes.

'''Change 1:''' ''API change to session context''
* In SessionContext:
** Renamed 'user' field to 'initiatingUser'.
** Added field 'auditSourceId'

'''Change 2:''' ''API change to response type''
* In ResponseType (inherited by all responses):
** Removed 'failMessage' and 'successMessage'
** Removed 'isFailure'.  Kept 'isSuccess'
** Added 'response' (coded integer), The 'response' coded integers represent the IHE's response code handling.  They are enumerated as follows:
*** UNKNOWN = -1
*** SUCCESS = 0
*** PARTIAL_SUCCESS = 2
*** WARNING = 3
*** ERROR = 4
*** UNAVAILABLE = 5 
** Added 'responseMessages' (array of Strings)
** Added 'responseMessage' (single String, first element of responseMessages)

'''Change 3:''' ''API Change for XDS - Submitting Documents'''
* In the "DocumentSubmissionMetadata" type, there is a new value 'submissionSetUniqueId'.  The Bridge will no longer auto-generate the SubmissionSet UniqueId based on the SourceId. DocumentSubmissionMetadata.submissionSetUniqueId is a required value and the Bridge will throw an exception if empty. To understand the motivation for this bug fix, see the discussion on the newsgroup entitled 'submissionset.uniqueId generation problem' and Bugzilla bug [https://bugs.eclipse.org/bugs/show_bug.cgi?id=182913 182913].

=== OHF RHIO Configuration API ===
The RHIO configuration handler is a piece of code that was available to OHF Bridge users last year and can now be used by everyone.  This will be helpful come Connectathon time when we will distribute a well-formed RHIO configuration with all the testable IHE infrastructure machines listed.  The format of the RHIO configuration file has been modified this year to take advantage of new IHE infrastructure profiles, including XDS.b and XCA.  A sample file is shipped with the OHF Bridge.  More information will be forthcoming on how to use these tools.