> ## 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.

# Which live EHR reads each of the organization's EHR instances supports

> A static table per EHR; a read marked false answers 501 `capability_unsupported`.



## OpenAPI

````yaml /openapi-v4.json get /ehr/capabilities
openapi: 3.0.0
info:
  title: Max AI Public API
  description: API for third-party marketplace apps
  version: '4.0'
  contact: {}
servers:
  - url: https://api.maxcare.ai/v4
security: []
tags: []
paths:
  /ehr/capabilities:
    get:
      tags:
        - EHR live reads
      summary: Which live EHR reads each of the organization's EHR instances supports
      description: >-
        A static table per EHR; a read marked false answers 501
        `capability_unsupported`.
      operationId: EhrPublicController_capabilities
      parameters:
        - name: x-session-token
          in: header
          description: >-
            App Bridge session token. The user's own EHR login reads when they
            have one (`actingAs: user`).
          required: false
          schema:
            type: string
        - 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/EhrCapabilitiesSuccessResponse'
        '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'
      security:
        - api-key: []
components:
  schemas:
    EhrCapabilitiesSuccessResponse:
      type: object
      properties:
        code:
          type: string
          description: Response code
          example: success
        data:
          $ref: '#/components/schemas/EhrCapabilitiesData'
      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
    EhrCapabilitiesData:
      type: object
      properties:
        instances:
          type: array
          items:
            $ref: '#/components/schemas/EhrInstanceCapabilities'
      required:
        - instances
    EhrInstanceCapabilities:
      type: object
      properties:
        instanceId:
          type: string
          example: ins_0123456789abcdef0123456789abcdef
        ehr:
          type: string
          enum:
            - modmed
            - ezderm
        connected:
          type: boolean
          description: >-
            Whether the practice's own (system) connection to this instance is
            live. When false, reads without a session token answer 503
            `ehr_unavailable`; a signed-in user's own EHR login
            (`X-Session-Token`) may still read.
        reads:
          type: object
          description: >-
            Read name → supported. An unsupported read answers 501
            `capability_unsupported`.
          additionalProperties:
            type: boolean
      required:
        - instanceId
        - ehr
        - connected
        - reads
  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.