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

# Edit impression fields

> Updates diagnosis complexity and/or status on a specific impression and synchronously pushes to the EHR. ModMed only. The impressionId is found in the SOAP note response at soapNote.impressionsPlans[].impressionId. Requires write:soap_notes scope.



## OpenAPI

````yaml /openapi-v3.json patch /notes/{noteId}/impressions/{impressionId}
openapi: 3.0.0
info:
  title: Max AI Public API
  description: API for third-party marketplace apps
  version: '3.0'
  contact: {}
servers:
  - url: https://api.maxcare.ai/v3
security: []
tags: []
paths:
  /notes/{noteId}/impressions/{impressionId}:
    patch:
      tags:
        - Notes
      summary: Edit impression fields
      description: >-
        Updates diagnosis complexity and/or status on a specific impression and
        synchronously pushes to the EHR. ModMed only. The impressionId is found
        in the SOAP note response at soapNote.impressionsPlans[].impressionId.
        Requires write:soap_notes scope.
      operationId: NotesPublicController_updateImpression
      parameters:
        - name: noteId
          required: true
          in: path
          description: Note ID (stable root ID or any version ID)
          schema:
            type: string
        - name: impressionId
          required: true
          in: path
          description: >-
            Impression integration ID (from
            soapNote.impressionsPlans[].impressionId)
          schema:
            type: number
        - name: providerId
          required: true
          in: query
          schema:
            type: string
        - name: X-Organization-Id
          in: header
          required: true
          schema:
            type: string
          description: Target clinic organization ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateImpressionBody'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateImpressionSuccessResponseV3'
        '400':
          description: Missing or invalid request parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiBadRequestResponse'
        '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'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiNotFoundResponse'
        '409':
          description: Resource conflict (e.g. editing a signed note)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiConflictResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiRateLimitResponse'
        '502':
          description: EHR sync failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiBadGatewayResponse'
        '503':
          description: EHR integration unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiServiceUnavailableResponse'
      security:
        - api-key: []
components:
  schemas:
    UpdateImpressionBody:
      type: object
      properties:
        dxComplexity:
          type: string
          description: Diagnosis complexity (problemAddressed). ModMed only.
          example: STABLE CHRONIC ILLNESS
        dxStatus:
          type: string
          description: Diagnosis status (chronicity). ModMed only.
          example: Active
    UpdateImpressionSuccessResponseV3:
      type: object
      properties:
        code:
          type: string
          description: Response code
          example: success
        data:
          $ref: '#/components/schemas/ExternalNoteResponseV3'
      required:
        - code
        - data
    PublicApiBadRequestResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code
          example: bad_request
        message:
          type: string
          description: Human-readable error message
          example: '''id'' must be a valid UUID'
        trace_id:
          type: string
          description: Trace ID for debugging
          example: 550e8400-e29b-41d4-a716-446655440000
      required:
        - code
        - message
        - trace_id
    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
    PublicApiNotFoundResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code
          example: not_found
        message:
          type: string
          description: Human-readable error message
          example: Resource not found
        trace_id:
          type: string
          description: Trace ID for debugging
          example: 550e8400-e29b-41d4-a716-446655440000
      required:
        - code
        - message
        - trace_id
    PublicApiConflictResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code
          example: conflict
        message:
          type: string
          description: Human-readable error message
          example: Cannot edit a signed note
        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
    PublicApiBadGatewayResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code
          example: unexpected_integration_error
        message:
          type: string
          description: Human-readable error message
          example: EHR sync failed
        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
    ExternalNoteResponseV3:
      type: object
      properties:
        id:
          type: string
          description: Stable note identifier
          example: nte_3cc73cb69c59403ca9108af6c5693b25
        version:
          type: number
          description: Version number (increments when note content changes)
          example: 3
        visitDate:
          type: string
          description: Visit date (ISO timestamp)
          nullable: true
          example: '2026-03-20 18:30:00+00'
        status:
          type: string
          description: Workflow status
          example: awaiting_sign
          enum:
            - new
            - synced
            - awaiting_sign
            - awaiting_final_sign
            - signed
            - outdated
            - archived
        aiStatus:
          type: string
          description: AI check status
          nullable: true
          example: issues_found
          enum:
            - pending
            - success
            - issues_found
            - skipped
        aiIssueCount:
          type: number
          description: Number of AI issues found
          example: 2
        patient:
          description: Patient details
          allOf:
            - $ref: '#/components/schemas/ExternalNotePatientV3'
        facility:
          description: Facility details
          nullable: true
          allOf:
            - $ref: '#/components/schemas/ExternalNoteFacilityV3'
        ehrType:
          type: string
          description: EHR type
          example: modmed
          enum:
            - modmed
            - ezderm
        assignedProviders:
          description: Assigned providers
          type: array
          items:
            $ref: '#/components/schemas/ExternalNoteAssignedProviderV3'
        soapNote:
          type: object
          description: SOAP note content (only when includeSoapNote=true)
          nullable: true
        createdAt:
          type: string
          description: Created timestamp
          example: '2026-03-20 18:35:10.209452+00'
        updatedAt:
          type: string
          description: Last updated timestamp
          example: '2026-03-23 03:15:47.285+00'
      required:
        - id
        - version
        - visitDate
        - status
        - aiStatus
        - aiIssueCount
        - patient
        - facility
        - ehrType
        - assignedProviders
        - createdAt
        - updatedAt
    ExternalNotePatientV3:
      type: object
      properties:
        id:
          type: string
          description: Patient ID
          example: pat_8de030393a9e417ab2b3a8b8df183631
        mrn:
          type: string
          description: Medical record number
          nullable: true
          example: MRN-10042
        firstName:
          type: string
          description: First name
          nullable: true
          example: Sarah
        lastName:
          type: string
          description: Last name
          nullable: true
          example: Johnson
        middleName:
          type: string
          description: Middle name
          nullable: true
          example: Marie
        gender:
          type: string
          description: Gender
          nullable: true
          example: Female
        dateOfBirth:
          type: string
          description: Date of birth (YYYY-MM-DD)
          nullable: true
          example: '1985-03-15'
        email:
          type: string
          description: Email address
          nullable: true
          example: sarah.johnson@email.com
        phone:
          type: string
          description: Phone number
          nullable: true
          example: (555) 123-4567
        avatar:
          type: string
          description: Presigned URL for the patient avatar image (expires in 1 hour)
          nullable: true
          example: >-
            https://s3.amazonaws.com/bucket/patients-avatars/org/avatar.jpg?X-Amz-...
        createdAt:
          type: string
          description: Created timestamp
          example: '2024-08-15T09:30:00.000Z'
        updatedAt:
          type: string
          description: Last updated timestamp
          example: '2025-01-20T14:22:00.000Z'
      required:
        - id
        - mrn
        - firstName
        - lastName
        - middleName
        - gender
        - dateOfBirth
        - email
        - phone
        - avatar
        - createdAt
        - updatedAt
    ExternalNoteFacilityV3:
      type: object
      properties:
        id:
          type: string
          description: Facility ID
          example: fac_b2c3d4e5f6a74b8c9d0e1f2a3b4c5d6e
        name:
          type: string
          description: Facility name
          example: West LA Dermatology
        timezone:
          type: string
          description: Timezone
          nullable: true
          example: America/Los_Angeles
        specialty:
          type: string
          description: Specialty
          nullable: true
          example: Dermatology
        isVisible:
          type: boolean
          description: Whether the facility is visible
          example: true
        organizationNpi:
          type: string
          description: Organization NPI number
          nullable: true
          example: '1234567890'
        createdAt:
          type: string
          description: Created timestamp
          example: '2024-05-01T10:00:00.000Z'
        updatedAt:
          type: string
          description: Last updated timestamp
          example: '2025-01-15T12:30:00.000Z'
      required:
        - id
        - name
        - timezone
        - specialty
        - isVisible
        - organizationNpi
        - createdAt
        - updatedAt
    ExternalNoteAssignedProviderV3:
      type: object
      properties:
        id:
          type: string
          description: Provider unique identifier
          example: prv_d4e5f6a7b8c94d0e1f2a3b4c5d6e7f8a
        firstName:
          type: string
          description: First name
          nullable: true
          example: James
        lastName:
          type: string
          description: Last name
          nullable: true
          example: Wilson
        displayFirstName:
          type: string
          description: Display first name
          nullable: true
          example: Dr. James
        displayLastName:
          type: string
          description: Display last name
          nullable: true
          example: Wilson, MD
        username:
          type: string
          description: EHR username
          nullable: true
          example: jwilson
        roles:
          description: Provider roles
          example:
            - Physician
          type: array
          items:
            type: string
        individualNpi:
          type: string
          description: Individual NPI number
          nullable: true
          example: '1234567890'
        canFinalize:
          type: boolean
          description: Whether the provider can finalize (bill-under) notes
          example: true
        canCosign:
          type: boolean
          description: Whether the provider can cosign other providers' notes
          example: false
        hidden:
          type: boolean
          description: Whether the provider is hidden
          example: false
        roleType:
          type: string
          description: Role on this note
          example: PRIMARY_PROVIDER
      required:
        - id
        - firstName
        - lastName
        - displayFirstName
        - displayLastName
        - username
        - roles
        - individualNpi
        - canFinalize
        - canCosign
        - hidden
        - roleType
  securitySchemes:
    api-key:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Marketplace API key

````