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

# Payer capabilities

> What each of this organization's EHR instances supports for payers: exact-payer insurance writes and policy types, national directory search, and adding payers. A UI hint stated as a fact about the EHR — calling the endpoint is still the authority. Requires read:payers.



## OpenAPI

````yaml /openapi-v1.json get /payers/capabilities
openapi: 3.0.0
info:
  title: Max AI Public API
  description: API for third-party marketplace apps
  version: '1.0'
  contact: {}
servers:
  - url: https://api.maxcare.ai/v1
security: []
tags: []
paths:
  /payers/capabilities:
    get:
      tags:
        - Payers
      summary: Payer capabilities
      description: >-
        What each of this organization's EHR instances supports for payers:
        exact-payer insurance writes and policy types, national directory
        search, and adding payers. A UI hint stated as a fact about the EHR —
        calling the endpoint is still the authority. Requires read:payers.
      operationId: PayersPublicController_getCapabilities
      parameters:
        - name: X-Organization-Id
          in: header
          required: true
          schema:
            type: string
          description: Target clinic organization ID
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayerCapabilitiesSuccessResponse'
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiUnauthorizedResponse'
        '403':
          description: Insufficient scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiForbiddenResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiRateLimitResponse'
        '503':
          description: EHR integration unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiServiceUnavailableResponse'
      security:
        - api-key: []
components:
  schemas:
    PayerCapabilitiesSuccessResponse:
      type: object
      properties:
        code:
          type: string
          description: Response code
          example: success
        data:
          $ref: '#/components/schemas/PayerCapabilitiesData'
      required:
        - code
        - data
    PublicApiUnauthorizedResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code
          example: unauthorized
        message:
          type: string
          description: Human-readable error message
          example: Invalid or missing API key
        trace_id:
          type: string
          description: Trace ID for debugging
          example: 550e8400-e29b-41d4-a716-446655440000
      required:
        - code
        - message
        - trace_id
    PublicApiForbiddenResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code
          example: forbidden
        message:
          type: string
          description: Human-readable error message
          example: Insufficient scope
        trace_id:
          type: string
          description: Trace ID for debugging
          example: 550e8400-e29b-41d4-a716-446655440000
      required:
        - code
        - message
        - trace_id
    PublicApiRateLimitResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code
          example: rate_limit_exceeded
        message:
          type: string
          description: Human-readable error message
          example: Rate limit exceeded. Maximum 1000 requests per 60 seconds.
        trace_id:
          type: string
          description: Trace ID for debugging
          example: 550e8400-e29b-41d4-a716-446655440000
      required:
        - code
        - message
        - trace_id
    PublicApiServiceUnavailableResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code
          example: server_unresponsive
        message:
          type: string
          description: Human-readable error message
          example: EHR integration is not available for this note
        trace_id:
          type: string
          description: Trace ID for debugging
          example: 550e8400-e29b-41d4-a716-446655440000
      required:
        - code
        - message
        - trace_id
    PayerCapabilitiesData:
      type: object
      properties:
        instances:
          type: array
          items:
            $ref: '#/components/schemas/InstancePayerCapabilities'
      required:
        - instances
    InstancePayerCapabilities:
      type: object
      properties:
        instanceId:
          type: string
          description: EHR instance id — the `instanceId` on payer records
        ehr:
          type: string
          example: modmed
        insurance:
          $ref: '#/components/schemas/PayerInsuranceWriteCapabilities'
        directory:
          type: boolean
          description: >-
            `GET /payers/directory` can search this EHR's national payer
            directory
        create:
          type: boolean
          description: >-
            `POST /payers` can add a directory payer to this instance. It does
            not say where `POST /patients` creates a chart; use `GET
            /payers?newChart=true` for that.
      required:
        - instanceId
        - ehr
        - insurance
        - directory
        - create
    PayerInsuranceWriteCapabilities:
      type: object
      properties:
        payerId:
          type: boolean
          description: >-
            `POST /patients/{id}/insurance:exact` accepts a `payerId` for this
            instance
        policyType:
          type: boolean
          description: >-
            The exact insurance write applies `policyType` (ModMed); elsewhere
            it is ignored
      required:
        - payerId
        - policyType
  securitySchemes:
    api-key:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Marketplace API key

````

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