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

network
string

The affiliations the directory lists in one insurance network. An organization 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
primary-organization
string

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

Required string length: 1 - 256
participating-organization
string

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

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 organizations an affiliation names: OrganizationAffiliation:participating-organization, OrganizationAffiliation:primary-organization or OrganizationAffiliation:network. Repeat the parameter to include several. Included entries do not count toward _count.

Required array length: 1 - 16 elements
Available options:
OrganizationAffiliation:participating-organization,
OrganizationAffiliation:primary-organization,
OrganizationAffiliation:network
_id
string

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