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

name
string

Matches the organization's name.

Required string length: 1 - 100
identifier
string

An organization's NPI, as {system}|{npi} or a bare 10-digit value, under the same systems Practitioner accepts. An NPI search can return more than the practice that holds the NPI: a parent organization that lists it among several NPIs is a match too, because it carries the NPI as an NPI.

Required string length: 1 - 256
partof
string

The organizations that are part of 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
type
string

An organization type from http://terminology.hl7.org/CodeSystem/organization-type, bare or with that system: prov for healthcare providers, pay for payers, ntwk for insurance networks. ntwk is also accepted under Plan-Net's http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrgTypeCS. type=ntwk and type=pay may stand alone, to list every network or every payer; any other type narrows a search. The directory records networks by the text of their type rather than a code; this service searches that text and confirms each answer is a network, and answers 502 rather than serve one that is not.

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

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

Available options:
true,
false
address-city
string

Narrows a search by city; cannot be used on its own. Matches any of the organization's addresses, so a result can still list addresses in another city.

Required string length: 1 - 100
address-state
string

Narrows a search by state; cannot be used on its own. Matches any of the organization's addresses, so a result can still list addresses in another state.

Required string length: 1 - 50
address-postalcode
string

Narrows a search by postal code; cannot be used on its own. Matches any of the organization's addresses, so a result can still list addresses in another postal code.

Required string length: 1 - 100
_include
enum<string>[]

Organization:partof brings the organization each match is part of. Repeat the parameter to include several. Included entries do not count toward _count.

Required array length: 1 - 16 elements
Available options:
Organization:partof
_revinclude
enum<string>[]

Bring the records that point at each match: PractitionerRole:organization, OrganizationAffiliation:primary-organization, OrganizationAffiliation:participating-organization, Location:organization, Endpoint:organization or Organization:partof. Repeat the parameter to include several. Included entries do not count toward _count. The directory returns at most 100 included records per page; a page with more is refused with a 502 rather than served short.

Required array length: 1 - 16 elements
Available options:
PractitionerRole:organization,
OrganizationAffiliation:primary-organization,
OrganizationAffiliation:participating-organization,
Location:organization,
Endpoint:organization,
Organization:partof
_id
string

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