au.gov.nehta.vendorlibrary.hi.ihi
Class ConsumerSearchIHIClient

java.lang.Object
  extended by au.gov.nehta.vendorlibrary.hi.client.ClientBase<T>
      extended by au.gov.nehta.vendorlibrary.hi.client.BaseClient_30<au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.ConsumerSearchIHIPortType>
          extended by au.gov.nehta.vendorlibrary.hi.ihi.ConsumerSearchIHIClient

public class ConsumerSearchIHIClient
extends BaseClient_30<au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.ConsumerSearchIHIPortType>

An implementation of a Healthcare Identifiers (HI) - Individual Healthcare Identifier (IHI) search client. This class may be used to connect to the Medicare HI Service to do Consumer Search IHI searches.


Nested Class Summary
static class ConsumerSearchIHIClient.ArgumentValidator
          Validates search parameters are correct for the various search types.
 
Field Summary
 
Fields inherited from class au.gov.nehta.vendorlibrary.hi.client.BaseClient_30
individualQualifiedId, organisationQualifiedId, productHeader
 
Fields inherited from class au.gov.nehta.vendorlibrary.hi.client.ClientBase
EMPTY, loggingHandler, port, signingCertificate, signingPrivateKey, SSL_SOCKET_FACTORY, SSL_SOCKET_FACTORY_INTERNAL, sslSocketFactory
 
Constructor Summary
ConsumerSearchIHIClient(java.lang.String searchIhiServiceEndpoint, au.net.electronichealth.ns.hi.common.qualifiedidentifier._3_0.QualifiedId individualQualifiedId, javax.xml.ws.Holder<au.net.electronichealth.ns.hi.common.commoncoreelements._3_0.ProductType> productHeader, java.security.PrivateKey signingPrivateKey, java.security.cert.X509Certificate signingCertificate, javax.net.ssl.SSLSocketFactory sslSocketFactory)
          Constructor which creates a new ConsumerSearchIHIClient with an endpoint and an SSL Socket Factory.
 
Method Summary
 au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHIResponse australianPostalAddressSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHI request)
          Executes a Australian Postal Address ConsumerSearchIHI search.
 au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHIResponse australianStreetAddressSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHI request)
          Executes a Australian Street Address ConsumerSearchIHI search.
 au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHIResponse basicDvaSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHI request)
          Executes a basic DVA ConsumerSearchIHI search.
 au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHIResponse basicMedicareSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHI request)
          Executes a basic Medicare ConsumerSearchIHI search.
 au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHIResponse basicSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHI request)
          Executes a basic ConsumerSearchIHI search.
 au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHIResponse detailedSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHI request)
          Executes a Detailed ConsumerSearchIHI search.
 au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHIResponse internationalAddressSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHI request)
          Executes an International Address ConsumerSearchIHI search.
 
Methods inherited from class au.gov.nehta.vendorlibrary.hi.client.BaseClient_30
getTimestampHeader, hasNoOrganisationQualifiedId
 
Methods inherited from class au.gov.nehta.vendorlibrary.hi.client.ClientBase
configureEndpoint, getBindingProvider, getLastSoapRequest, getLastSoapResponse, getPort, isEmpty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConsumerSearchIHIClient

public ConsumerSearchIHIClient(java.lang.String searchIhiServiceEndpoint,
                               au.net.electronichealth.ns.hi.common.qualifiedidentifier._3_0.QualifiedId individualQualifiedId,
                               javax.xml.ws.Holder<au.net.electronichealth.ns.hi.common.commoncoreelements._3_0.ProductType> productHeader,
                               java.security.PrivateKey signingPrivateKey,
                               java.security.cert.X509Certificate signingCertificate,
                               javax.net.ssl.SSLSocketFactory sslSocketFactory)
Constructor which creates a new ConsumerSearchIHIClient with an endpoint and an SSL Socket Factory.

Parameters:
searchIhiServiceEndpoint - the Web Service endpoint for the Medicare HI Service interface (Mandatory)
individualQualifiedId - The qualified user ID for connecting to the ConsumerSearchIHI service (Mandatory)
productHeader - The product header data for connecting to the ConsumerSearchIHI service (Mandatory)
signingPrivateKey - The private key to be used for signing (Mandatory)
signingCertificate - The certificate to be used for signing (Mandatory)
sslSocketFactory - the SSL Socket Factory to be used when connecting to the Web Service provider (Mandatory)
Method Detail

basicSearch

public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHIResponse basicSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHI request)
                                                                                             throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.StandardErrorMsg
Executes a basic ConsumerSearchIHI search.

Parameters:
request - the SearchIHI request object containing the following mandatory fields: IHI Number Family Name Date of Birth Sex and the following optional fields Given Name
Returns:
the response from the ConsumerSearchIHI service
Throws:
au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.StandardErrorMsg - if the Web Service call fails.

basicMedicareSearch

public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHIResponse basicMedicareSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHI request)
                                                                                                     throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.StandardErrorMsg
Executes a basic Medicare ConsumerSearchIHI search.

Parameters:
request - the SearchIHI request object containing the following mandatory fields: Medicare Card Number Family Name Date of Birth Sex and the following optional fields Given Name Medicare IRN
Returns:
the response from the ConsumerSearchIHI service
Throws:
au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.StandardErrorMsg - if the Web Service call fails.

basicDvaSearch

public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHIResponse basicDvaSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHI request)
                                                                                                throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.StandardErrorMsg
Executes a basic DVA ConsumerSearchIHI search.

Parameters:
request - the SearchIHI request object containing the following mandatory fields: DVA File Number Family Name Date of Birth Sex and the following optional fields Given Name
Returns:
the response from the ConsumerSearchIHI service
Throws:
au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.StandardErrorMsg - if the Web Service call fails.

detailedSearch

public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHIResponse detailedSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHI request)
                                                                                                throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.StandardErrorMsg
Executes a Detailed ConsumerSearchIHI search.

Parameters:
request - the SearchIHI request object containing the following mandatory fields: Family Name Date of Birth Sex and the following optional fields Given Name
Returns:
the response from the ConsumerSearchIHI service
Throws:
au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.StandardErrorMsg - if the Web Service call fails.

australianPostalAddressSearch

public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHIResponse australianPostalAddressSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHI request)
                                                                                                               throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.StandardErrorMsg
Executes a Australian Postal Address ConsumerSearchIHI search.

Parameters:
request - the SearchIHI request object containing the following mandatory fields: Family Name Date of Birth Sex Australian Street Address: Postal Delivery Group Australian Street Address: Postal Delivery Type Australian Street Address: State Australian Street Address: Post Code Australian Street Address: Suburb and the following optional fields Given Name
Returns:
the response from the ConsumerSearchIHI service
Throws:
au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.StandardErrorMsg - if the Web Service call fails.

australianStreetAddressSearch

public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHIResponse australianStreetAddressSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHI request)
                                                                                                               throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.StandardErrorMsg
Executes a Australian Street Address ConsumerSearchIHI search.

Parameters:
request - the SearchIHI request object containing the following mandatory fields: Family Name Date of Birth Sex Australian Street Address: Street Name Australian Street Address: Suburb Australian Street Address: State Australian Street Address: Post Code and the following optional fields Given Name
Returns:
the response from the ConsumerSearchIHI service
Throws:
au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.StandardErrorMsg - if the Web Service call fails.

internationalAddressSearch

public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHIResponse internationalAddressSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.SearchIHI request)
                                                                                                            throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.StandardErrorMsg
Executes an International Address ConsumerSearchIHI search.

Parameters:
request - the SearchIHI request object containing the following mandatory fields: Family Name Date of Birth Sex International Address: Line International Address: Post Code International Address: State/Province International Address: Country and the following optional fields Given Name
Returns:
the response from the ConsumerSearchIHI service
Throws:
au.net.electronichealth.ns.hi.svc.consumersearchihi._3_0.StandardErrorMsg - if the Web Service call fails.