|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectau.gov.nehta.vendorlibrary.hi.client.ClientBase<T>
au.gov.nehta.vendorlibrary.hi.client.BaseClient_3<au.net.electronichealth.ns.hi.svc.consumersearchihi._3.ConsumerSearchIHIPortType>
au.gov.nehta.vendorlibrary.hi.ihi.ConsumerSearchIHIClient
public class ConsumerSearchIHIClient
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_3 |
---|
individualQualifiedId, organisationQualifiedId, productHeader |
Fields inherited from class au.gov.nehta.vendorlibrary.hi.client.ClientBase |
---|
certificateValidator, EMPTY, loggingHandler, port, QUALIFIED_ID_MISSING, signingCertificate, signingPrivateKey, SSL_SOCKET_FACTORY, SSL_SOCKET_FACTORY_INTERNAL, sslSocketFactory |
Constructor Summary | |
---|---|
ConsumerSearchIHIClient(java.lang.String serviceEndpoint,
ProductType productHeader,
java.security.PrivateKey signingPrivateKey,
java.security.cert.X509Certificate signingCertificate,
javax.net.ssl.SSLSocketFactory sslSocketFactory)
Constructor which creates a new ProviderSearchHIProviderDirectoryForIndividual Client with an endpoint and an SSL Socket Factory. |
|
ConsumerSearchIHIClient(java.lang.String searchIhiServiceEndpoint,
au.net.electronichealth.ns.hi.xsd.common.qualifiedidentifier._3.QualifiedId individualQualifiedId,
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 ConsumerSearchIHIClient with an endpoint and an SSL Socket Factory. |
|
ConsumerSearchIHIClient(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,
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,
au.gov.nehta.xsp.CertificateValidator certificateValidator)
Constructor which creates a new ConsumerSearchIHIClient with an endpoint and an SSL Socket Factory, with the optional contracted service providers HPI-O organisation qualified ID set. |
|
ConsumerSearchIHIClient(java.lang.String serviceEndpoint,
QualifiedId individualQualifiedId,
QualifiedId organisationQualifiedId,
ProductType productHeader,
java.security.PrivateKey signingPrivateKey,
java.security.cert.X509Certificate signingCertificate,
javax.net.ssl.SSLSocketFactory sslSocketFactory,
au.gov.nehta.xsp.CertificateValidator certificateValidator)
Constructor which creates a new ConsumerSearchIHIClient 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.consumersearchihi._3.SearchIHIResponse |
australianPostalAddressSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request)
Executes a Australian Postal Address ConsumerSearchIHI search. |
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse |
australianPostalAddressSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request,
QualifiedId individualId)
Executes a Australian Postal Address ConsumerSearchIHI search. |
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse |
australianStreetAddressSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request)
Executes a Australian Street Address ConsumerSearchIHI search. |
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse |
australianStreetAddressSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request,
QualifiedId individualId)
Executes a Australian Street Address ConsumerSearchIHI search. |
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse |
basicDvaSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request)
Executes a basic DVA ConsumerSearchIHI search. |
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse |
basicDvaSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request,
QualifiedId individualId)
Executes a basic DVA ConsumerSearchIHI search. |
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse |
basicMedicareSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request)
Executes a basic Medicare ConsumerSearchIHI search. |
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse |
basicMedicareSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request,
QualifiedId individualId)
Executes a basic Medicare ConsumerSearchIHI search. |
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse |
basicSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request)
Executes a basic ConsumerSearchIHI search. |
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse |
basicSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request,
QualifiedId individualId)
Executes a basic ConsumerSearchIHI search. |
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse |
detailedSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request)
Executes a Detailed ConsumerSearchIHI search. |
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse |
detailedSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request,
QualifiedId individualId)
Executes a Detailed ConsumerSearchIHI search. |
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse |
internationalAddressSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request)
Executes an International Address ConsumerSearchIHI search. |
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse |
internationalAddressSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request,
QualifiedId individualId)
Executes an International Address ConsumerSearchIHI search. |
Methods inherited from class au.gov.nehta.vendorlibrary.hi.client.BaseClient_3 |
---|
checkUserID, 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 |
---|
public ConsumerSearchIHIClient(java.lang.String searchIhiServiceEndpoint, au.net.electronichealth.ns.hi.xsd.common.qualifiedidentifier._3.QualifiedId individualQualifiedId, 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)
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)public ConsumerSearchIHIClient(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, 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, au.gov.nehta.xsp.CertificateValidator certificateValidator)
serviceEndpoint
- the Web Service endpoint for the Medicare HI Service interface (Mandatory)individualQualifiedId
- The qualified user ID for connecting to the ConsumerSearchIHI service (Mandatory)organisationQualifiedId
- The qualified organisation ID for connecting to the ConsumerSearchIHI service (Optional)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)certificateValidator
- (optional) a user supplied validator to authenticate the response certificate.public ConsumerSearchIHIClient(java.lang.String serviceEndpoint, QualifiedId individualQualifiedId, QualifiedId organisationQualifiedId, ProductType productHeader, java.security.PrivateKey signingPrivateKey, java.security.cert.X509Certificate signingCertificate, javax.net.ssl.SSLSocketFactory sslSocketFactory, au.gov.nehta.xsp.CertificateValidator certificateValidator)
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 providercertificateValidator
- (optional) a user supplied validator to authenticate the response certificate.public ConsumerSearchIHIClient(java.lang.String serviceEndpoint, ProductType productHeader, java.security.PrivateKey signingPrivateKey, java.security.cert.X509Certificate signingCertificate, javax.net.ssl.SSLSocketFactory sslSocketFactory)
serviceEndpoint
- the Web Service endpoint for the Medicare HI Service interface (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 providerMethod Detail |
---|
public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse basicSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request) throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
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
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
- if the Web Service call fails.public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse basicMedicareSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request) throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
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
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
- if the Web Service call fails.public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse basicDvaSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request) throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
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
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
- if the Web Service call fails.public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse detailedSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request) throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
request
- the SearchIHI request object containing the following mandatory fields:
Family Name
Date of Birth
Sex
and the following optional fields
Given Name
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
- if the Web Service call fails.public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse australianPostalAddressSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request) throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
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
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
- if the Web Service call fails.public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse australianStreetAddressSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request) throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
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
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
- if the Web Service call fails.public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse internationalAddressSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request) throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
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
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
- if the Web Service call fails.public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse basicSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request, QualifiedId individualId) throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
request
- the SearchIHI request object containing the following mandatory fields:
IHI Number
Family Name
Date of Birth
Sex
and the following optional fields
Given NameindividualId
- the qualified user id of the user making the request
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
- if the Web Service call fails.public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse basicMedicareSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request, QualifiedId individualId) throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
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 IRNindividualId
- the qualified user id of the user making the request *
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
- if the Web Service call fails.public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse basicDvaSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request, QualifiedId individualId) throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
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 NameindividualId
- the qualified user id of the user making the request
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
- if the Web Service call fails.public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse detailedSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request, QualifiedId individualId) throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
request
- the SearchIHI request object containing the following mandatory fields:
Family Name
Date of Birth
Sex
and the following optional fields
Given NameindividualId
- the qualified user id of the user making the request
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
- if the Web Service call fails.public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse australianPostalAddressSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request, QualifiedId individualId) throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
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 NameindividualId
- the qualified user id of the user making the request
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
- if the Web Service call fails.public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse australianStreetAddressSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request, QualifiedId individualId) throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
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 NameindividualId
- the qualified user id of the user making the request
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
- if the Web Service call fails.public final au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHIResponse internationalAddressSearch(au.net.electronichealth.ns.hi.svc.consumersearchihi._3.SearchIHI request, QualifiedId individualId) throws au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
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 NameindividualId
- the qualified user id of the user making the request
au.net.electronichealth.ns.hi.svc.consumersearchihi._3.StandardErrorMsg
- if the Web Service call fails.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |