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

practitioner
string

The roles one practitioner holds. Give a Practitioner id, Practitioner/{id}, or the fullUrl this service returned. An address on another server is refused.

Required string length: 1 - 256
organization
string

The roles held at one organization. Give a Organization id, Organization/{id}, or the fullUrl this service returned. An address on another server is refused.

Required string length: 1 - 256
location
string

The roles held 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
endpoint
string

The roles reached through one endpoint. Give a Endpoint id, Endpoint/{id}, or the fullUrl this service returned. An address on another server is refused.

Required string length: 1 - 256
specialty
string

A NUCC Health Care Provider Taxonomy code, bare or as http://nucc.org/provider-taxonomy|{code} (for example 207RC0000X, cardiovascular disease). Any other system is refused, because the directory codes specialties in NUCC alone and would answer another system with nothing. Narrows a search; cannot be used on its own.

Required string length: 1 - 256
network
string

The roles the directory lists in one insurance network (an Organization of type ntwk). Cannot be used on its own: send it beside practitioner, organization, location or specialty. A search that breaks this rule is refused before the directory is asked. Beside a specialty or a busy location the directory can take 10 to 15 seconds. A role the network's records do not list is not shown to be out of network: the directory's network data is sparse. Give a Organization id, Organization/{id}, or the fullUrl this service returned. An address on another server is refused.

Required string length: 1 - 256
new-patient-from-network
string

The roles accepting new patients from one insurance network. Cannot be used on its own: send it beside practitioner, organization, location or specialty. 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
new-patient
string

Whether the role accepts new patients: newpt, nopt, existptonly or existptfam, bare or under http://terminology.hl7.org/CodeSystem/accepting-patients. Narrows a search; cannot be used on its own.

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>[]

Bring the records a role points to into the same bundle: PractitionerRole:practitioner, PractitionerRole:organization, PractitionerRole:location, PractitionerRole:network or PractitionerRole:endpoint. Repeat the parameter to include several. Included entries do not count toward _count.

Required array length: 1 - 16 elements
Available options:
PractitionerRole:practitioner,
PractitionerRole:organization,
PractitionerRole:location,
PractitionerRole:network,
PractitionerRole:endpoint
_id
string

A PractitionerRole 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 FHIR R4 Bundle.

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