Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

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

Headers

X-Request-Id
string<uuid>

An id of your own for this request, as a UUID. It comes back in the X-Correlation-Id header and is kept with haau3's record of the request. Any value that is not a UUID is ignored. See https://docs.haau3.com/errors#request-ids.

Query Parameters

location
string

The services offered at one location. Give a Location id, Location/{id}, or the fullUrl this service returned. An address on another server is refused.

Required string length: 1 - 256
network
string

The services the directory lists in one insurance network. Cannot be used on its own: send it beside location. A search that breaks this rule is refused before the directory is asked. Give a Organization id, Organization/{id}, or the fullUrl this service returned. An address on another server is refused.

Required string length: 1 - 256
service-category
string

pharm, bare or as http://terminology.hl7.org/CodeSystem/ndh-healthcare-service-category|pharm: every pharmacy, of any kind. Starts a pharmacy search, as specialty does. A pharmacy search needs location.address-state with location.address-postalcode or location.address-city, or one pharmacy's organization or organization.identifier; name narrows it.

Required string length: 1 - 256
specialty
string

A NUCC pharmacy code, bare or as http://nucc.org/provider-taxonomy|{code}, or several separated by commas to find pharmacies of any of those kinds: for example 3336C0003X (community or retail) or 3336M0002X (mail order). Starts a pharmacy search. A pharmacy may carry only the general code 333600000X or only a specific one, so send 333600000X,3336C0003X to find either, or service-category=pharm for every kind. Only pharmacy codes (333600000X, 3336C0002X, 3336C0003X, 3336C0004X, 3336H0001X, 3336I0012X, 3336L0003X, 3336M0002X, 3336M0003X, 3336N0007X, 3336S0011X) are served. A pharmacy search needs location.address-state with location.address-postalcode or location.address-city, or one pharmacy's organization or organization.identifier; name narrows it.

Required string length: 1 - 256
location.address-state
string

A pharmacy search's state: the two-letter code of the state the pharmacy's store is in. Required, with a ZIP code or a city, unless the search names one pharmacy.

Required string length: 1 - 50
location.address-postalcode
string

Narrows a pharmacy search to stores whose ZIP code starts with this: a ZIP code, or its first two or more digits. Send it with location.address-state.

Required string length: 1 - 10
location.address-city
string

Narrows a pharmacy search to stores in a city whose name starts with this, so Miami also finds Miami Beach. Two or more letters. Send it with location.address-state.

Required string length: 1 - 100
name
string

Narrows a pharmacy search to pharmacies whose name, or a name they do business as, starts with this. Two or more letters. Cannot be used on its own, or with a state alone.

Required string length: 1 - 100
organization
string

One pharmacy: the organization that provides it, as a pharmacy search returned it (Organization-{NPI}). Stands alone on a pharmacy search. Give a Organization id, Organization/{id}, or the fullUrl this service returned. An address on another server is refused.

Required string length: 1 - 256
organization.identifier
string

One pharmacy by its NPI, as {system}|{npi} or a bare 10-digit value, under the same systems Organization accepts. Stands alone on a pharmacy search.

Required string length: 1 - 256
active
enum<string>

true or false. Narrows a search; cannot be used on its own.

Available options:
true,
false
_include
enum<string>[]

On a pharmacy search, HealthcareService:organization brings the organization that provides each pharmacy (its NPI, names and phone), and HealthcareService:location its store (address and phone). Repeat the parameter to include several. Included entries do not count toward _count.

Required array length: 1 - 16 elements
Available options:
HealthcareService:organization,
HealthcareService:location
_id
string

A HealthcareService id. Searching by id rather than reading it lets one request also bring the records an _include or _revinclude names.

Pattern: ^[A-Za-z0-9\-.]{1,64}$
_summary
enum<string>

count only: answers how many records match, as total, with no entries. Cannot be combined with _include, _revinclude, _count or page.

Available options:
count
_count
integer

Results are paged. _count sets the page size (1 to 100); a larger value is refused rather than quietly reduced. Follow link with relation next to continue. The cursor it carries is opaque and must not be constructed or modified.

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

Continuation cursor. Opaque: follow the next link from a previous response, and never construct or modify it. Cursors expire.

Required string length: 1 - 8192

Response

A FHIR Bundle with type: searchset. total is present when the directory sends one; a pharmacy search never carries one, because NPPES gives no count.

A FHIR R4 Bundle.

resourceType
string
required
Allowed value: "Bundle"
type
string
entry
object[]