Describes relationships between two or more organizations, including the services one organization provides another, the location(s) where they provide services etc.

Get 100 organizations (by default):

GET [base]/fhir/OrganizationAffiliation

Get practitioner role by resource id:

GET [base]/fhir/OrganizationAffiliation/[id]

The full list of FHIR search parameters for OrganizationAffiliation is found below. Aidbox also offers a selection of query parameters to further refine search results. This includes pagination, full-text search, sorting etc. Refer to the FHIR API Search docs for information.

The search results are returned in Bundles by default. Alternatively, you can specify a _result parameter with value array to receive resources in a JSON array.

Example search scenario

  1. Get organization affiliation by network:

GET [base]/fhir/OrganizationAffiliation?network=Direct
  1. Find organization id:

"organization": {
  "reference": "Organization/bc3d21a5-af67-4ff9-9f08-9758b71a7e0e"
  1. Get organization by id:

GET [base]/fhir/Organization/[id]

Bulk API

The following bulk operations on OrganizationAffiliation are available.

Aidbox will respond with Chunked Transfer Encoding ndjson stream, optionally you can get the output in FHIR format or GZIPped.

This is a memory-efficient operation. Aidbox just streams the database cursor to a socket. If your HTTP Client supports processing of Chunked Encoding, you can process resources in stream one by one without waiting for the end of the response. See full docs here.

GET [base]/OrganizationAffiliation/$dump

Dump Organization resources in CSV format.

This operation dumps resource data in Aidbox format as CSV (RFC4180). In this format, columns are paths to JSON values and Rows are values. It includes the header.

Neither the specific order of columns nor the order of rows is guaranteed. See full docs here.

GET [base]/OrganizationAffiliation/$dump-csv


Last updated