Skip to main content
GET
Find a practitioner by NPI or name

Authorizations

Authorization
string
header
required

Your platform API key (haau3_sk_…), sent as Authorization: Bearer <key>.

Query Parameters

identifier
string

{system}|{npi} or a bare 10-digit NPI. Required unless page is given.

name
string

Matches across the whole name.

family
string

The family name. Required unless identifier, name, given or page is given.

given
string

A given name.

address-city
string

Narrows a name search. Matches any of the practitioner's addresses, so a result can still list addresses in other cities. Cannot be used on its own.

address-state
string

Narrows a name search. Matches any of the practitioner's addresses, so a result can still list addresses in other states. Cannot be used on its own.

_revinclude
enum<string>

Include the practitioner's roles in the same bundle. Included entries do not count toward _count.

Available options:
PractitionerRole:practitioner
_count
integer

Page size, 1 to 100. A larger value is refused rather than quietly reduced.

Required range: 1 <= x <= 100
page
string

Continuation cursor. Opaque — follow the next link from a previous response; never construct or modify it. Cursors expire.

Response

A FHIR Bundle with type: searchset. Entries carry fullUrls and links on this service. No total is returned, because the directory does not provide one.

The response is of type object.