> ## Documentation Index
> Fetch the complete documentation index at: https://docs.haau3.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Find the organizations in a network

> Search `OrganizationAffiliation`: which organizations take part in which networks. `network` lists a network's members; with `participating-organization` beside it, it asks whether the directory lists that organization in that network. The directory's network data is sparse, so an organization a network's records do not list is not shown to be out of network. For a network, the primary organization is the network itself.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/fhir/r4/OrganizationAffiliation
openapi: 3.1.0
info:
  title: haau3 Platform API
  version: 1.0.0-preview.4
  description: >-
    The haau3 platform API is in preview: it may change as we build, usually to
    add features or improve performance. Endpoints require an API key, sent as
    `Authorization: Bearer <key>`. Requests without a valid key return 401.
    Create a key in the dashboard at https://platform.haau3.com; a new
    organization starts on the free Developer plan. From 2026-11-01 a request
    past one of its plan's limits (requests a minute on every plan, requests a
    month on Developer) returns 429 with `Retry-After`. Every error under
    `/v1/fhir` is a FHIR `OperationOutcome` and every other error an RFC 9457
    problem; https://docs.haau3.com/errors lists every status, whether to retry
    it, and what a method a path does not take answers.
servers:
  - url: https://api.haau3.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Scheduling
    description: 'Provider availability (SMART Scheduling Links): slots and publishers.'
  - name: FHIR base
    description: >-
      What the FHIR R4 base at `/v1/fhir/r4` answers for every service on it:
      the `CapabilityStatement` that lists them all, and batch Bundles that
      carry several requests to any of them in one round trip.
  - name: Terminology
    description: >-
      FHIR terminology operations over the code systems listed in
      TerminologyCapabilities. Some are resolved from their own source when you
      ask; others are held here at a named release, which that resource also
      names.
  - name: Provider directory
    description: >-
      CMS's National Provider Directory as FHIR R4: practitioners and their
      roles, organizations, payers and insurance networks, network membership,
      healthcare services, locations and endpoints. Every parameter the service
      serves is declared here, and any other is refused by name rather than
      ignored.
  - name: Questionnaires
    description: >-
      FHIR Questionnaire, served as its source publishes it. This service holds
      copies of a curated set and reaches any other questionnaire its source
      publishes by canonical URL, as well as forms published at their own
      address under places this service is set up to reach. Read one by id, and
      build the QuestionnaireResponse in your own application.
  - name: Plan Benefits
    description: >-
      FHIR InsurancePlan: what a Medicare Advantage or ACA Marketplace plan
      covers and what a member pays, read from the files CMS publishes. Every
      plan names the CMS release it was read from. Read a plan by its id, or
      search by identifier, name, state or county, and check whether the CMS
      National Provider Directory lists providers in a plan's network.
  - name: MedList
    description: >-
      One reconciled medication list from one patient's FHIR medication records,
      as US Core MedicationRequests with a Provenance for each. This operation
      receives patient data, so send it only under an executed agreement.
paths:
  /v1/fhir/r4/OrganizationAffiliation:
    get:
      tags:
        - Provider directory
      summary: Find the organizations in a network
      description: >-
        Search `OrganizationAffiliation`: which organizations take part in which
        networks. `network` lists a network's members; with
        `participating-organization` beside it, it asks whether the directory
        lists that organization in that network. The directory's network data is
        sparse, so an organization a network's records do not list is not shown
        to be out of network. For a network, the primary organization is the
        network itself.
      operationId: searchOrganizationAffiliation
      parameters:
        - name: network
          in: query
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 256
          description: >-
            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.
          example: Organization-ea579d05-454e-4359-8751-900c940a599a
        - name: primary-organization
          in: query
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 256
          description: >-
            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.
        - name: participating-organization
          in: query
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 256
          description: >-
            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.
        - name: active
          in: query
          required: false
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
          description: '`true` or `false`. Narrows a search; cannot be used on its own.'
        - name: _include
          in: query
          required: false
          schema:
            minItems: 1
            maxItems: 16
            type: array
            items:
              type: string
              enum:
                - OrganizationAffiliation:participating-organization
                - OrganizationAffiliation:primary-organization
                - OrganizationAffiliation:network
          style: form
          explode: true
          description: >-
            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`.
        - name: _id
          in: query
          required: false
          schema:
            type: string
            pattern: ^[A-Za-z0-9\-.]{1,64}$
          description: >-
            A OrganizationAffiliation id. Searching by id rather than reading it
            lets one request also bring the records an `_include` or
            `_revinclude` names.
        - name: _summary
          in: query
          required: false
          schema:
            type: string
            enum:
              - count
          description: >-
            `count` only: answers how many records match, as `total`, with no
            entries. Cannot be combined with `_include`, `_revinclude`, `_count`
            or `page`.
        - name: _count
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
          description: >-
            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.
          example: 2
        - name: page
          in: query
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 8192
          description: >-
            Continuation cursor. Opaque: follow the `next` link from a previous
            response, and never construct or modify it. Cursors expire.
        - $ref: '#/components/parameters/XRequestId'
      responses:
        '200':
          description: >-
            A FHIR `Bundle` with `type: searchset`. `total` is present when the
            directory sends one.
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/Bundle'
              examples:
                A network's members:
                  summary: A network's members
                  value:
                    resourceType: Bundle
                    type: searchset
                    link:
                      - relation: self
                        url: >-
                          https://api.haau3.com/v1/fhir/r4/OrganizationAffiliation?network=Organization-ea579d05-454e-4359-8751-900c940a599a&_count=2
                      - relation: next
                        url: >-
                          https://api.haau3.com/v1/fhir/r4/OrganizationAffiliation?network=Organization-ea579d05-454e-4359-8751-900c940a599a&_count=2&page=AAMA-EFRSURBSGd2bzlHTkh2NkZNeXNGMkNKelNQaUp6aCtWTXNCNXh6R0owVG0xQ1RtRzZRSFFVaE43NWhqL0RpZURPb1Y3b1lCRkFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTVY5SmxtMisyZzNZNWxtczJBZ0VRZ0R2WmtUK1k2dEhnSkVzZmpid2RNVmxsaWFnNGhUcmVXck54Q2NQQVFIQlBxV25PRisvNjcrRDU0MzY1OTIzczc4dFlFSTIvNWo5cWg4ZXU2dz09O6lhnDedPtaQSgXxE1mpybg5ZuW6Bg8a0GxRUshtbccMOKGc20OQY0VoHnQmdEkcc_ujkS5zaJGKeGnfdG99X4kqwYWB28EzQEFbW4lZktWA7N95LIMpplFREOzrh-HC8Kcvys84QycEvjWDcLfbL6Hdeva4zXEuTN3UOvV4mTsxvneZkCZ3myrjTKLJ8lpDIE1HjyEXTC_dTbhLMCmEe5tJXOKyUu87_xRxtA5C0Gv1mssjTlAZVYSR4CnOx8-Zq4LNY_Axf9G6E41mqe0rUOXZP7YjedeIpu7AeDcIWbzZpHs4CLpip-1hSQxXmuQemDbVLTrCMZPX2jnkAxFsFf_WHaJ248qpRyVV3zdG2xLrPOHjyPO4bHsAfaziMG2xJhzYoBHyccvWHaUB0Qmq5xUTRaA7KXBHAjniV8c7wmdRxbe3CVPWVXHaD2KocLSK6ajsn5qdr4_rujLVRvnIHA4OWfzHSWpAXXeKrrIxgJGEJ3oWCZhG90I50YgTYZ2iBpFV_yA0Ru3H5UhEOcYeKb_LLguhuWJcQd_wYKx3wG_rwkaaGLBhLOI6n4jGdvbpc73UclkFi3KI3eNwuWYs3gI2i3e2seeH_AKZJ2d-t_XVnz5qzSmbxSQms4tnpiXLYaVLuxv6EZGS3B13y_6mqrF28GHS4LclFbgEyvt8FX1HdCbjMov2R7H2-sH0ag-p5e-VdwFw2I__XWUE2IWT1T6DS8uT_eaBUuVSLuLr09Hh7OIS_ngJjCLCLUyjLAL8uYsow1YYqfZoFknKMb19n2Ze_sFZPgsAzUOdRMYOfGo7Lm3QbIQ0hFikMuePB75dwosqxgUET6Ts-nPKJlASOG7hRouXQjcufZuRnlA1xC2Y2MXYfbiWcpqNXIkIwm_1VBdLZ2SpwP41gQnF-W8WTfU8jBsJxY0ZrcG-Edl2-F834R48yXvNFuyIC3AlSvT2Fb3hT-sszQeCyOHeHqiiVeAgSXiXRTI55cU2mvxxt2xU7bNie0OkaKMpluB5NXjK3-OFrvN9p-8cYOxNfVqaXVE4CpEiY-yg
                    entry:
                      - fullUrl: >-
                          https://api.haau3.com/v1/fhir/r4/OrganizationAffiliation/OrganizationAffiliation-000cc9b9-738c-43cd-b923-03ac9ab4714d
                        resource:
                          resourceType: OrganizationAffiliation
                          id: >-
                            OrganizationAffiliation-000cc9b9-738c-43cd-b923-03ac9ab4714d
                          meta:
                            versionId: '1'
                            lastUpdated: '2026-10-14T21:12:38.183722348Z'
                            profile:
                              - >-
                                http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-OrganizationAffiliation
                          active: true
                          organization:
                            reference: >-
                              Organization/Organization-ea579d05-454e-4359-8751-900c940a599a
                          participatingOrganization:
                            reference: Organization/Organization-1972503142
                          network:
                            - reference: >-
                                Organization/Organization-ea579d05-454e-4359-8751-900c940a599a
                        search:
                          mode: match
                      - fullUrl: >-
                          https://api.haau3.com/v1/fhir/r4/OrganizationAffiliation/OrganizationAffiliation-00143df2-30a6-454b-a82c-c3ea8a2d59ae
                        resource:
                          resourceType: OrganizationAffiliation
                          id: >-
                            OrganizationAffiliation-00143df2-30a6-454b-a82c-c3ea8a2d59ae
                          meta:
                            versionId: '1'
                            lastUpdated: '2026-10-14T21:12:37.946536507Z'
                            profile:
                              - >-
                                http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-OrganizationAffiliation
                          active: true
                          organization:
                            reference: >-
                              Organization/Organization-ea579d05-454e-4359-8751-900c940a599a
                          participatingOrganization:
                            reference: Organization/Organization-1932757820
                          network:
                            - reference: >-
                                Organization/Organization-ea579d05-454e-4359-8751-900c940a599a
                        search:
                          mode: match
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            X-Correlation-Id:
              $ref: '#/components/headers/XCorrelationId'
        '400':
          description: >-
            The request named a parameter, identifier system or value this
            service does not serve. Every unsupported parameter is refused by
            name, and none is silently ignored, so a search that returns results
            applied every filter you sent.
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            X-Correlation-Id:
              $ref: '#/components/headers/XCorrelationId'
        '401':
          $ref: '#/components/responses/FhirUnauthorized'
        '404':
          description: No such resource, or no such interaction on this base.
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            X-Correlation-Id:
              $ref: '#/components/headers/XCorrelationId'
        '406':
          $ref: '#/components/responses/FhirNotAcceptable'
        '429':
          $ref: '#/components/responses/FhirTooManyRequests'
        '500':
          $ref: '#/components/responses/FhirServerError'
        '502':
          description: >-
            The directory could not be reached, answered in a shape that cannot
            be served, or answered with more than is served at once: a
            `_revinclude` past the directory's 100 records on a page, or an
            answer over 8 MiB. No answer is given: this is never reported as an
            empty result, which would read as 'no such provider'.
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            X-Correlation-Id:
              $ref: '#/components/headers/XCorrelationId'
        '503':
          description: >-
            The directory is rate limiting requests. Send the request again
            after `Retry-After`. It is also the answer when the API key could
            not be checked just now, with `Retry-After`.
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
          headers:
            Retry-After:
              description: >-
                Sent when waiting will help: the API key could not be checked
                just now, or the source behind this service is rate limiting
                requests. How many seconds to wait before sending the request
                again.
              schema:
                type: integer
                minimum: 0
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            X-Correlation-Id:
              $ref: '#/components/headers/XCorrelationId'
        '504':
          description: The directory did not respond in time.
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            X-Correlation-Id:
              $ref: '#/components/headers/XCorrelationId'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >
            curl
            "https://api.haau3.com/v1/fhir/r4/OrganizationAffiliation?network=Organization-ea579d05-454e-4359-8751-900c940a599a&_count=2"
            \
              -H "Authorization: Bearer $HAAU3_API_KEY"
        - lang: typescript
          label: TypeScript
          source: |
            import { Haau3 } from "@haau3/sdk";

            const haau3 = new Haau3(); // reads HAAU3_API_KEY
            const bundle = await haau3.searchOrganizationAffiliation({
              network: "Organization-ea579d05-454e-4359-8751-900c940a599a",
              _count: 2,
            });
            console.log(bundle.entry?.length ?? 0);
        - lang: python
          label: Python
          source: >
            from haau3 import Haau3


            client = Haau3()  # reads HAAU3_API_KEY

            bundle =
            client.search_organization_affiliation(network="Organization-ea579d05-454e-4359-8751-900c940a599a",
            count=2)

            print(len(bundle.get("entry", [])))
        - lang: go
          label: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\t\"github.com/haau3/haau3-go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclient, err := haau3.NewClient() // reads HAAU3_API_KEY\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tbundle, err := client.SearchOrganizationAffiliation(ctx, haau3.SearchOrganizationAffiliationParams{Network: new(\"Organization-ea579d05-454e-4359-8751-900c940a599a\"), Count: new(2)})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Println(len(bundle.Entry))\n}\n"
components:
  parameters:
    XRequestId:
      name: X-Request-Id
      in: header
      required: false
      schema:
        type: string
        format: uuid
      description: >-
        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.
  schemas:
    Bundle:
      type: object
      description: A FHIR R4 [Bundle](https://hl7.org/fhir/R4/bundle.html).
      properties:
        resourceType:
          type: string
          const: Bundle
        type:
          type: string
        entry:
          type: array
          items:
            type: object
            additionalProperties: true
      required:
        - resourceType
      additionalProperties: true
    OperationOutcome:
      type: object
      description: >-
        A FHIR R4
        [OperationOutcome](https://hl7.org/fhir/R4/operationoutcome.html).
      properties:
        resourceType:
          type: string
          const: OperationOutcome
        issue:
          type: array
          items:
            type: object
            properties:
              severity:
                type: string
                enum:
                  - fatal
                  - error
                  - warning
                  - information
              code:
                type: string
              details:
                type: object
                properties:
                  text:
                    type: string
                additionalProperties: true
              diagnostics:
                type: string
              expression:
                type: array
                items:
                  type: string
            required:
              - severity
              - code
            additionalProperties: true
      required:
        - resourceType
        - issue
  headers:
    XRequestId:
      description: >-
        The id haau3 gave this request, a UUID, on every response. Quote it in a
        question about the response. A problem carries the same id as its
        `instance`.
      schema:
        type: string
        format: uuid
    XCorrelationId:
      description: The `X-Request-Id` you sent, when it was a UUID.
      schema:
        type: string
        format: uuid
  responses:
    FhirUnauthorized:
      description: Missing or invalid API key.
      content:
        application/fhir+json:
          schema:
            $ref: '#/components/schemas/OperationOutcome'
      headers:
        WWW-Authenticate:
          description: >-
            The scheme to authenticate with: `Bearer realm="api.haau3.com"`,
            with `error="invalid_token"` when a key was sent and not recognised.
          schema:
            type: string
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
        X-Correlation-Id:
          $ref: '#/components/headers/XCorrelationId'
    FhirNotAcceptable:
      description: >-
        The request asked for a format other than JSON (`Accept` or `_format`),
        or for a FHIR release this endpoint does not serve (the `fhirVersion`
        media-type parameter).
      content:
        application/fhir+json:
          schema:
            $ref: '#/components/schemas/OperationOutcome'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
        X-Correlation-Id:
          $ref: '#/components/headers/XCorrelationId'
    FhirTooManyRequests:
      description: >-
        A limit of the organization's plan was reached: its requests a minute,
        or the Developer plan's requests a month. Send the request again after
        `Retry-After`, which for the monthly limit runs to the 1st of the next
        month (UTC).
      content:
        application/fhir+json:
          schema:
            $ref: '#/components/schemas/OperationOutcome'
      headers:
        Retry-After:
          description: How many seconds to wait before sending the request again.
          schema:
            type: integer
            minimum: 0
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
        X-Correlation-Id:
          $ref: '#/components/headers/XCorrelationId'
    FhirServerError:
      description: The server failed to process this request.
      content:
        application/fhir+json:
          schema:
            $ref: '#/components/schemas/OperationOutcome'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
        X-Correlation-Id:
          $ref: '#/components/headers/XCorrelationId'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your platform API key (`haau3_sk_…`), sent as `Authorization: Bearer
        <key>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.