Index

A B C E G H I N R S T U W

A

Address - Class in io.zhkv.api.nppesnpi: This class represents the wrapper for address object.
Address() - Constructor for class io.zhkv.api.nppesnpi.Address: This class represents the wrapper for address object.
AddressPurpose - Enum in io.zhkv.api.nppesnpi: This class enumerates the possible address purposes. Refers to whether the address information entered pertains to the provider's Mailing Address or the provider's Practice Location Address.
AddressPurpose() - Constructor for enum io.zhkv.api.nppesnpi.AddressPurpose: This class enumerates the possible address purposes. Refers to whether the address information entered pertains to the provider's Mailing Address or the provider's Practice Location Address.

B

Basic - Class in io.zhkv.api.nppesnpi: This class represents the wrapper for basic section of the result.
Basic() - Constructor for class io.zhkv.api.nppesnpi.Basic: This class represents the wrapper for basic section of the result.
build() - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: Builds the class NppesRequest based on givven data.

C

Companion - Static variable in class io.zhkv.api.nppesnpi.NppesNpi: Companion object of a NppesNpi.
component1() - Method in class io.zhkv.api.nppesnpi.NppesRequest: The unique,
component10() - Method in class io.zhkv.api.nppesnpi.NppesRequest: Limit the results returned.
component11() - Method in class io.zhkv.api.nppesnpi.NppesRequest: The first N
component2() - Method in class io.zhkv.api.nppesnpi.NppesRequest: The Read API can be refined to retrieve only Individual Providers or Organizational Providers.
component3() - Method in class io.zhkv.api.nppesnpi.NppesRequest: Search for providers by their taxonomy by entering the taxonomy description.
component4() - Method in class io.zhkv.api.nppesnpi.NppesRequest: This field only applies to Organizational Providers.
component5() - Method in class io.zhkv.api.nppesnpi.NppesRequest: Refers to whether the address information entered pertains to the provider
component6() - Method in class io.zhkv.api.nppesnpi.NppesRequest: The City associated with the provider
component7() - Method in class io.zhkv.api.nppesnpi.NppesRequest: The State abbreviation associated with the provider
component8() - Method in class io.zhkv.api.nppesnpi.NppesRequest: The Postal Code associated with the provider
component9() - Method in class io.zhkv.api.nppesnpi.NppesRequest: The Country associated with the provider
copy(number, enumerationType, taxonomyDescription, organizationName, addressPurpose, city, state, postalCode, countryCode, limit, skip) - Method in class io.zhkv.api.nppesnpi.NppesRequest: The data class is used to hold the request parameters and build the URL to perform the request to NPPES NPI Registry.

E

EnumerationType - Enum in io.zhkv.api.nppesnpi: This class enumerates the possible enumeration types. Can be refined to retrieve only Individual Providers or Organizational Providers.
EnumerationType(value) - Constructor for enum io.zhkv.api.nppesnpi.EnumerationType: This class enumerates the possible enumeration types. Can be refined to retrieve only Individual Providers or Organizational Providers.
equals(p) - Method in class io.zhkv.api.nppesnpi.NppesRequest

G

get(request) - Method in class io.zhkv.api.nppesnpi.NppesNpi.Companion: Performs the get request to NPPES NPI Registry based on a given class NppesRequest.
get(request) - Method in class io.zhkv.api.nppesnpi.NppesNpi.Companion: Performs the get request to NPPES NPI Registry based on a given class NppesRequestBuilder. This function may be more suitable to use with Java based application.
get(request) - Static method in class io.zhkv.api.nppesnpi.NppesNpi: Performs the get request to NPPES NPI Registry based on a given class NppesRequest.
get(request) - Static method in class io.zhkv.api.nppesnpi.NppesNpi: Performs the get request to NPPES NPI Registry based on a given class NppesRequestBuilder. This function may be more suitable to use with Java based application.
getAddress1() - Method in class io.zhkv.api.nppesnpi.Address: The address 1
getAddress2() - Method in class io.zhkv.api.nppesnpi.Address: The address 2
getAddresses() - Method in class io.zhkv.api.nppesnpi.Result: The list of addresses class Address.
getAddressPurpose() - Method in class io.zhkv.api.nppesnpi.Address: The address purpose. Could be one of enum AddressPurpose.
getAddressPurpose() - Method in class io.zhkv.api.nppesnpi.NppesRequest: Refers to whether the address information entered pertains to the provider
getAddressPurpose() - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: Refers to whether the address information entered pertains to the provider's Mailing Address or the provider's Practice Location Address. When not specified, the results will contain the providers where either the Mailing Address or the Practice Location Addresses match the entered address information
getAddressType() - Method in class io.zhkv.api.nppesnpi.Address: The address type.
getBasic() - Method in class io.zhkv.api.nppesnpi.Result: The basic information class Basic.
getCity() - Method in class io.zhkv.api.nppesnpi.Address: The city associated with the provider's address.
getCity() - Method in class io.zhkv.api.nppesnpi.NppesRequest: The City associated with the provider
getCity() - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: The City associated with the provider's address identified in Address Purpose.
getCode() - Method in class io.zhkv.api.nppesnpi.Identifier: The identifier code.
getCode() - Method in class io.zhkv.api.nppesnpi.Taxonomy: The taxonomy code.
getCount() - Method in class io.zhkv.api.nppesnpi.NppesResponse: The number of results for this response.
getCountryCode() - Method in class io.zhkv.api.nppesnpi.Address: The country code associated with the provider's address identified in Address Purpose.
getCountryCode() - Method in class io.zhkv.api.nppesnpi.NppesRequest: The Country associated with the provider
getCountryCode() - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: The Country associated with the provider's address identified in Address Purpose. This field can be used as the only input criterion as long as the value selected is not US (United States).
getCountryName() - Method in class io.zhkv.api.nppesnpi.Address: The country name associated with the provider's address.
getCreatedEpoch() - Method in class io.zhkv.api.nppesnpi.Result: The created epoch timestamp.
getDate() - Method in class io.zhkv.api.nppesnpi.Basic: The creation date.
getDesc() - Method in class io.zhkv.api.nppesnpi.Identifier: The identifier description.
getDesc() - Method in class io.zhkv.api.nppesnpi.Taxonomy: The taxonomy description.
getEnumerationType() - Method in class io.zhkv.api.nppesnpi.NppesRequest: The Read API can be refined to retrieve only Individual Providers or Organizational Providers.
getEnumerationType() - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: The Read API can be refined to retrieve only Individual Providers or Organizational Providers. When using the Enumeration Type, it cannot be the only criteria entered. Additional criteria must also be entered as well.
getEnumerationType() - Method in class io.zhkv.api.nppesnpi.Result: The enumeration type. One of enum EnumerationType.
getFax() - Method in class io.zhkv.api.nppesnpi.Address: The fax number associated with the provider's address.
getIdentifier() - Method in class io.zhkv.api.nppesnpi.Identifier: The identifier.
getIdentifiers() - Method in class io.zhkv.api.nppesnpi.Result: The list of class Identifier
getIssuer() - Method in class io.zhkv.api.nppesnpi.Identifier: The issuer name.
getIssuer() - Method in class io.zhkv.api.nppesnpi.Taxonomy: The issuer name.
getLastUpdated() - Method in class io.zhkv.api.nppesnpi.Basic: The last update date.
getLastUpdatedEpoch() - Method in class io.zhkv.api.nppesnpi.Result: The last updated timestamp
getLicense() - Method in class io.zhkv.api.nppesnpi.Taxonomy: The license.
getLimit() - Method in class io.zhkv.api.nppesnpi.NppesRequest: Limit the results returned.
getLimit() - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: Limit the results returned. The default value is 10. The value can be set to any value from 1 to 200.
getName() - Method in class io.zhkv.api.nppesnpi.Basic: The name.
getNumber() - Method in class io.zhkv.api.nppesnpi.NppesRequest: The unique,
getNumber() - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: The unique, 10-digit National Provider Identifier (NPI) assigned to the provider.
getNumber() - Method in class io.zhkv.api.nppesnpi.Result: The NPI Number is the unique 10-digit National Provider Identifier assigned to the provider.
getOfficialFirstName() - Method in class io.zhkv.api.nppesnpi.Basic: The official first name.
getOfficialLastName() - Method in class io.zhkv.api.nppesnpi.Basic: The official last name.
getOfficialTelephoneNumber() - Method in class io.zhkv.api.nppesnpi.Basic: The official telephone number.
getOrganizationName() - Method in class io.zhkv.api.nppesnpi.NppesRequest: This field only applies to Organizational Providers.
getOrganizationName() - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: This field only applies to Organizational Providers. Trailing wildcard entries are permitted requiring at least two characters to be entered.
getOrgName() - Method in class io.zhkv.api.nppesnpi.Basic: The name of the organization.
getParentOrgEIN() - Method in class io.zhkv.api.nppesnpi.Basic: The parent organization EIN.
getParentOrgName() - Method in class io.zhkv.api.nppesnpi.Basic: The parent organization name.
getPostalCode() - Method in class io.zhkv.api.nppesnpi.NppesRequest: The Postal Code associated with the provider
getPostalCode() - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: The Postal Code associated with the provider's address identified in Address Purpose. There is an implied trailing wildcard. If you enter a 5 digit postal code, it will match any appropriate 9 digit (zip+4) codes in the data.
getResults() - Method in class io.zhkv.api.nppesnpi.NppesResponse: Collections of class Result objects.
getSkip() - Method in class io.zhkv.api.nppesnpi.NppesRequest: The first N
getSkip() - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: The first N (value entered) results meeting the entered criteria will be bypassed and will not be included in the output.
getState() - Method in class io.zhkv.api.nppesnpi.Address: The state associated with the provider's address.
getState() - Method in class io.zhkv.api.nppesnpi.Identifier: The issuer state.
getState() - Method in class io.zhkv.api.nppesnpi.NppesRequest: The State abbreviation associated with the provider
getState() - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: The State abbreviation associated with the provider's address identified in Address Purpose.
getState() - Method in class io.zhkv.api.nppesnpi.Taxonomy: The issuer state.
getStatus() - Method in class io.zhkv.api.nppesnpi.Basic: The status.
getSubPart() - Method in class io.zhkv.api.nppesnpi.Basic: The organizational subpart. Could be 'YES' or 'NO'
getTaxonomies() - Method in class io.zhkv.api.nppesnpi.Result: The list of class Taxonomy
getTaxonomyDescription() - Method in class io.zhkv.api.nppesnpi.NppesRequest: Search for providers by their taxonomy by entering the taxonomy description.
getTaxonomyDescription() - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: Search for providers by their taxonomy by entering the taxonomy description.
getTelephone() - Method in class io.zhkv.api.nppesnpi.Address: The telephone number associated with the provider's address.
getTitle() - Method in class io.zhkv.api.nppesnpi.Basic: The official title or position.
getValue() - Method in enum io.zhkv.api.nppesnpi.EnumerationType: the actual value of enumeration type.
getZip() - Method in class io.zhkv.api.nppesnpi.Address: The postal code associated with the provider's address.

H

hashCode() - Method in class io.zhkv.api.nppesnpi.NppesRequest

I

Identifier - Class in io.zhkv.api.nppesnpi: This class describes the identifier.
Identifier() - Constructor for class io.zhkv.api.nppesnpi.Identifier: This class describes the identifier.
io.zhkv.api.nppesnpi - package io.zhkv.api.nppesnpi

N

NppesNpi - Class in io.zhkv.api.nppesnpi: This class is behave as a wrapper for internal get(url: String) function, providing the ability to use class NppesRequest or class NppesRequestBuilder to perform the api call.
NppesNpi() - Constructor for class io.zhkv.api.nppesnpi.NppesNpi: This class is behave as a wrapper for internal get(url: String) function, providing the ability to use class NppesRequest or class NppesRequestBuilder to perform the api call.
NppesNpi.Companion - Class in io.zhkv.api.nppesnpi: Companion object of a NppesNpi.
NppesNpiKt - Class in io.zhkv.api.nppesnpi
NppesRequest - Class in io.zhkv.api.nppesnpi: The data class is used to hold the request parameters and build the URL to perform the request to NPPES NPI Registry.
NppesRequest(number, enumerationType, taxonomyDescription, organizationName, addressPurpose, city, state, postalCode, countryCode, limit, skip) - Constructor for class io.zhkv.api.nppesnpi.NppesRequest: Creates an immutable NPPES request based on provided parameters and default values.
NppesRequest() - Constructor for class io.zhkv.api.nppesnpi.NppesRequest: Creates an immutable NPPES request based on provided parameters and default values.
NppesRequestBuilder - Class in io.zhkv.api.nppesnpi: This class is used as an adapter for class NppesRequest and make it easier to build request in Java env.
NppesRequestBuilder() - Constructor for class io.zhkv.api.nppesnpi.NppesRequestBuilder: This class is used as an adapter for class NppesRequest and make it easier to build request in Java env.
NppesResponse - Class in io.zhkv.api.nppesnpi: This class represents the wrapper for NPPES NPI Registry response output.
NppesResponse() - Constructor for class io.zhkv.api.nppesnpi.NppesResponse: This class represents the wrapper for NPPES NPI Registry response output.

R

Result - Class in io.zhkv.api.nppesnpi: This class represents the wrapper for single result of the response.
Result() - Constructor for class io.zhkv.api.nppesnpi.Result: This class represents the wrapper for single result of the response.

S

setAddress1(p) - Method in class io.zhkv.api.nppesnpi.Address: The address 1
setAddress2(p) - Method in class io.zhkv.api.nppesnpi.Address: The address 2
setAddresses(p) - Method in class io.zhkv.api.nppesnpi.Result: The list of addresses class Address.
setAddressPurpose(p) - Method in class io.zhkv.api.nppesnpi.Address: The address purpose. Could be one of enum AddressPurpose.
setAddressPurpose(p) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: Refers to whether the address information entered pertains to the provider's Mailing Address or the provider's Practice Location Address. When not specified, the results will contain the providers where either the Mailing Address or the Practice Location Addresses match the entered address information
setAddressType(p) - Method in class io.zhkv.api.nppesnpi.Address: The address type.
setBasic(p) - Method in class io.zhkv.api.nppesnpi.Result: The basic information class Basic.
setCity(p) - Method in class io.zhkv.api.nppesnpi.Address: The city associated with the provider's address.
setCity(p) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: The City associated with the provider's address identified in Address Purpose.
setCode(p) - Method in class io.zhkv.api.nppesnpi.Identifier: The identifier code.
setCode(p) - Method in class io.zhkv.api.nppesnpi.Taxonomy: The taxonomy code.
setCount(p) - Method in class io.zhkv.api.nppesnpi.NppesResponse: The number of results for this response.
setCountryCode(p) - Method in class io.zhkv.api.nppesnpi.Address: The country code associated with the provider's address identified in Address Purpose.
setCountryCode(p) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: The Country associated with the provider's address identified in Address Purpose. This field can be used as the only input criterion as long as the value selected is not US (United States).
setCountryName(p) - Method in class io.zhkv.api.nppesnpi.Address: The country name associated with the provider's address.
setCreatedEpoch(p) - Method in class io.zhkv.api.nppesnpi.Result: The created epoch timestamp.
setDate(p) - Method in class io.zhkv.api.nppesnpi.Basic: The creation date.
setDesc(p) - Method in class io.zhkv.api.nppesnpi.Identifier: The identifier description.
setDesc(p) - Method in class io.zhkv.api.nppesnpi.Taxonomy: The taxonomy description.
setEnumerationType(p) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: The Read API can be refined to retrieve only Individual Providers or Organizational Providers. When using the Enumeration Type, it cannot be the only criteria entered. Additional criteria must also be entered as well.
setEnumerationType(p) - Method in class io.zhkv.api.nppesnpi.Result: The enumeration type. One of enum EnumerationType.
setFax(p) - Method in class io.zhkv.api.nppesnpi.Address: The fax number associated with the provider's address.
setIdentifier(p) - Method in class io.zhkv.api.nppesnpi.Identifier: The identifier.
setIdentifiers(p) - Method in class io.zhkv.api.nppesnpi.Result: The list of class Identifier
setIssuer(p) - Method in class io.zhkv.api.nppesnpi.Identifier: The issuer name.
setIssuer(p) - Method in class io.zhkv.api.nppesnpi.Taxonomy: The issuer name.
setLastUpdated(p) - Method in class io.zhkv.api.nppesnpi.Basic: The last update date.
setLastUpdatedEpoch(p) - Method in class io.zhkv.api.nppesnpi.Result: The last updated timestamp
setLicense(p) - Method in class io.zhkv.api.nppesnpi.Taxonomy: The license.
setLimit(p) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: Limit the results returned. The default value is 10. The value can be set to any value from 1 to 200.
setName(p) - Method in class io.zhkv.api.nppesnpi.Basic: The name.
setNumber(p) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: The unique, 10-digit National Provider Identifier (NPI) assigned to the provider.
setNumber(p) - Method in class io.zhkv.api.nppesnpi.Result: The NPI Number is the unique 10-digit National Provider Identifier assigned to the provider.
setOfficialFirstName(p) - Method in class io.zhkv.api.nppesnpi.Basic: The official first name.
setOfficialLastName(p) - Method in class io.zhkv.api.nppesnpi.Basic: The official last name.
setOfficialTelephoneNumber(p) - Method in class io.zhkv.api.nppesnpi.Basic: The official telephone number.
setOrganizationName(p) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: This field only applies to Organizational Providers. Trailing wildcard entries are permitted requiring at least two characters to be entered.
setOrgName(p) - Method in class io.zhkv.api.nppesnpi.Basic: The name of the organization.
setParentOrgEIN(p) - Method in class io.zhkv.api.nppesnpi.Basic: The parent organization EIN.
setParentOrgName(p) - Method in class io.zhkv.api.nppesnpi.Basic: The parent organization name.
setPostalCode(p) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: The Postal Code associated with the provider's address identified in Address Purpose. There is an implied trailing wildcard. If you enter a 5 digit postal code, it will match any appropriate 9 digit (zip+4) codes in the data.
setResults(p) - Method in class io.zhkv.api.nppesnpi.NppesResponse: Collections of class Result objects.
setSkip(p) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: The first N (value entered) results meeting the entered criteria will be bypassed and will not be included in the output.
setState(p) - Method in class io.zhkv.api.nppesnpi.Address: The state associated with the provider's address.
setState(p) - Method in class io.zhkv.api.nppesnpi.Identifier: The issuer state.
setState(p) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: The State abbreviation associated with the provider's address identified in Address Purpose.
setState(p) - Method in class io.zhkv.api.nppesnpi.Taxonomy: The issuer state.
setStatus(p) - Method in class io.zhkv.api.nppesnpi.Basic: The status.
setSubPart(p) - Method in class io.zhkv.api.nppesnpi.Basic: The organizational subpart. Could be 'YES' or 'NO'
setTaxonomies(p) - Method in class io.zhkv.api.nppesnpi.Result: The list of class Taxonomy
setTaxonomyDescription(p) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: Search for providers by their taxonomy by entering the taxonomy description.
setTelephone(p) - Method in class io.zhkv.api.nppesnpi.Address: The telephone number associated with the provider's address.
setTitle(p) - Method in class io.zhkv.api.nppesnpi.Basic: The official title or position.
setZip(p) - Method in class io.zhkv.api.nppesnpi.Address: The postal code associated with the provider's address.

T

Taxonomy - Class in io.zhkv.api.nppesnpi: This class describes the taxonomy.
Taxonomy() - Constructor for class io.zhkv.api.nppesnpi.Taxonomy: This class describes the taxonomy.
toString() - Method in class io.zhkv.api.nppesnpi.NppesRequest

U

url() - Method in class io.zhkv.api.nppesnpi.NppesRequest: Builds the request URL based on provided data.

W

withAddressPurpose(purpose) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: Sets the addressPurpose value.
withCity(city) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: Sets the city value.
withCountrylCode(countryCode) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: Sets the countryCode value.
withEnumerationType(type) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: Sets the enumerationType value.
withLimit(limit) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: Sets the limit value.
withNumber(number) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: Sets the number value.
withOrganizationName(orgName) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: Sets the organizationName value.
withPostalCode(postalCode) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: Sets the postalCode value.
withSkip(skip) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: Sets the skip value.
withState(state) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: Sets the state value.
withTaxonomyDescription(desc) - Method in class io.zhkv.api.nppesnpi.NppesRequestBuilder: Sets the taxonomyDescription value.

A B C E G H I N R S T U W