au.gov.nehta.vendorlibrary.hi.hpii
Class ProviderSearchForProviderIndividualClient

java.lang.Object
  extended by au.gov.nehta.vendorlibrary.hi.client.ClientBase<T>
      extended by au.gov.nehta.vendorlibrary.hi.client.BaseClient_3<au.net.electronichealth.ns.hi.svc.hiprovidersearchindividual._5_0_0.ProviderSearchForProviderIndividualPortType>
          extended by au.gov.nehta.vendorlibrary.hi.hpii.ProviderSearchForProviderIndividualClient

public class ProviderSearchForProviderIndividualClient
extends BaseClient_3<au.net.electronichealth.ns.hi.svc.hiprovidersearchindividual._5_0_0.ProviderSearchForProviderIndividualPortType>

An implementation of a Healthcare Identifiers (HI) - Healthcare Provider Identifier Organisation (HPI-O) search client. This class may be used to connect to the Medicare HI Service to do Provider Search HI Provider Directory For Organisation searches.


Nested Class Summary
static class ProviderSearchForProviderIndividualClient.ArgumentValidator
          Validates search parameters are correct for the various search types.
 
Field Summary
 
Fields inherited from class au.gov.nehta.vendorlibrary.hi.client.BaseClient_3
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
ProviderSearchForProviderIndividualClient(java.lang.String serviceEndpoint, au.net.electronichealth.ns.hi.xsd.common.qualifiedidentifier._3.QualifiedId individualQualifiedId, javax.xml.ws.Holder<au.net.electronichealth.ns.hi.xsd.common.commoncoreelements._3.ProductType> productHeader, java.security.PrivateKey signingPrivateKey, java.security.cert.X509Certificate signingCertificate, javax.net.ssl.SSLSocketFactory sslSocketFactory)
          Constructor which creates a new Client with an endpoint and an SSL Socket Factory.
ProviderSearchForProviderIndividualClient(java.lang.String serviceEndpoint, au.net.electronichealth.ns.hi.xsd.common.qualifiedidentifier._3.QualifiedId individualQualifiedId, au.net.electronichealth.ns.hi.xsd.common.qualifiedidentifier._3.QualifiedId organisationQualifiedId, javax.xml.ws.Holder<au.net.electronichealth.ns.hi.xsd.common.commoncoreelements._3.ProductType> productHeader, java.security.PrivateKey signingPrivateKey, java.security.cert.X509Certificate signingCertificate, javax.net.ssl.SSLSocketFactory sslSocketFactory)
          Constructor which creates a new ProviderSearchForProviderOrganisation Client with an endpoint and an SSL Socket Factory, with the optional contracted service providers HPI-O organisation qualified ID set.
 
Method Summary
 au.net.electronichealth.ns.hi.svc.hiprovidersearchindividual._5_0_0.SearchForProviderIndividualResponse demographicSearch(au.net.electronichealth.ns.hi.svc.hiprovidersearchindividual._5_0_0.SearchForProviderIndividual request)
          Executes an demographic search.
 au.net.electronichealth.ns.hi.svc.hiprovidersearchindividual._5_0_0.SearchForProviderIndividualResponse identifierSearch(au.net.electronichealth.ns.hi.svc.hiprovidersearchindividual._5_0_0.SearchForProviderIndividual request)
          Executes an Identifier HPII search.
 
Methods inherited from class au.gov.nehta.vendorlibrary.hi.client.BaseClient_3
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

ProviderSearchForProviderIndividualClient

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

Parameters:
serviceEndpoint - the Web Service endpoint for the Medicare HI Service interface (Mandatory)
individualQualifiedId - The qualified user ID for connecting to the ProviderSearchHIProviderDirectoryForOrganisation service (Mandatory)
productHeader - The product header data for connecting to the ProviderSearchHIProviderDirectoryForOrganisation 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

ProviderSearchForProviderIndividualClient

public ProviderSearchForProviderIndividualClient(java.lang.String serviceEndpoint,
                                                 au.net.electronichealth.ns.hi.xsd.common.qualifiedidentifier._3.QualifiedId individualQualifiedId,
                                                 au.net.electronichealth.ns.hi.xsd.common.qualifiedidentifier._3.QualifiedId organisationQualifiedId,
                                                 javax.xml.ws.Holder<au.net.electronichealth.ns.hi.xsd.common.commoncoreelements._3.ProductType> productHeader,
                                                 java.security.PrivateKey signingPrivateKey,
                                                 java.security.cert.X509Certificate signingCertificate,
                                                 javax.net.ssl.SSLSocketFactory sslSocketFactory)
Constructor which creates a new ProviderSearchForProviderOrganisation Client with an endpoint and an SSL Socket Factory, with the optional contracted service providers HPI-O organisation qualified ID set.

Parameters:
serviceEndpoint - the Web Service endpoint for the Medicare HI Service interface (Mandatory)
individualQualifiedId - The qualified user ID for connecting to the ProviderSearchHIProviderDirectoryForOrganisation service (Mandatory)
organisationQualifiedId - The qualified organisation ID for connecting to the ProviderSearchHIProviderDirectoryForOrganisation service (Optional)
productHeader - The product header data for connecting to the ProviderSearchHIProviderDirectoryForOrganisation 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
Method Detail

demographicSearch

public final au.net.electronichealth.ns.hi.svc.hiprovidersearchindividual._5_0_0.SearchForProviderIndividualResponse demographicSearch(au.net.electronichealth.ns.hi.svc.hiprovidersearchindividual._5_0_0.SearchForProviderIndividual request)
                                                                                                                                throws au.net.electronichealth.ns.hi.svc.hiprovidersearchindividual._5_0_0.StandardErrorMsg
Executes an demographic search.

Parameters:
request - the SearchForProviderIndividual request object containing the following mandatory fields: FamilyName
Returns:
Throws:
au.net.electronichealth.ns.hi.svc.hiprovidersearchindividual._5_0_0.StandardErrorMsg - if the Web Service call fails.
au.net.electronichealth.ns.hi.svc.hiprovidersearchindividual._5_0_0.StandardErrorMsg

identifierSearch

public final au.net.electronichealth.ns.hi.svc.hiprovidersearchindividual._5_0_0.SearchForProviderIndividualResponse identifierSearch(au.net.electronichealth.ns.hi.svc.hiprovidersearchindividual._5_0_0.SearchForProviderIndividual request)
                                                                                                                               throws au.net.electronichealth.ns.hi.svc.hiprovidersearchindividual._5_0_0.StandardErrorMsg
Executes an Identifier HPII search.

Parameters:
request - the SearchHIProviderDirectoryForIndividual request object containing the following mandatory fields: HPII or Registraion ID FamilyName
Returns:
Throws:
au.net.electronichealth.ns.hi.svc.hiprovidersearchindividual._5_0_0.StandardErrorMsg - if the Web Service call fails.
au.net.electronichealth.ns.hi.svc.hiprovidersearchindividual._5_0_0.StandardErrorMsg