openapi: 3.0.0
info:
  title: Public API – Access Management
  description: Operations related to patients, appointments, providers and so on.
  version: 169.0.17
servers:
  - url: https://test.hs1api.com/ascend-gateway
    description: Sandbox
  - url: https://prod.hs1api.com/ascend-gateway/api
security:
  - bearerAuth: []
  - oAuthSandbox: []
tags: []
x-tagGroups:
  - name: Access Management
    tags:
      - AccessToken (V1)
paths:
  /oauth/client_credential/accesstoken:
    post:
      summary: Get Access Token (Client Credentials)
      description: >
        Exchanges Client ID and Client Secret for an access token using OAuth
        2.0 client credentials flow.


        This endpoint implements server-side token caching to avoid exposing
        client secrets to frontend applications.

        Tokens are automatically refreshed when near expiry.


        **Environment URLs:**

        - Sandbox: https://test.hs1api.com

        - Production: https://prod.hs1api.com


        **Note**: Sandbox and Production use different base URLs and
        credentials.
      tags:
        - AccessToken (V1)
      security: []
      parameters:
        - $ref: '#/components/parameters/OrganizationId'
        - name: grant_type
          in: query
          required: true
          description: Must be "client_credentials"
          schema:
            type: string
            enum:
              - client_credentials
            example: client_credentials
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - client_id
                - client_secret
              properties:
                client_id:
                  type: string
                  description: OAuth client ID provided by HS1 Support
                  example: YOUR_CLIENT_ID
                client_secret:
                  type: string
                  description: OAuth client secret provided by HS1 Support
                  example: YOUR_CLIENT_SECRET
            examples:
              sandbox:
                summary: Sandbox credentials example
                value:
                  client_id: YOUR_CLIENT_ID
                  client_secret: YOUR_CLIENT_SECRET
      responses:
        '200':
          description: Token issued successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  access_token:
                    type: string
                    description: Bearer token for API authentication
                    example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
                  token_type:
                    type: string
                    description: Token type (always "Bearer")
                    example: Bearer
                  expires_in:
                    type: integer
                    description: Token lifetime in seconds
                    example: 3600
                  scope:
                    type: string
                    description: Granted scopes (if requested)
                    example: publicapi.read publicapi.write
                  organizationid:
                    type: string
                    description: >-
                      Organization ID (if provided in request). Note lowercase
                      'd' is intentional for legacy API compatibility
                    example: '1006'
              examples:
                success:
                  summary: Successful token response
                  value:
                    access_token: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
                    token_type: Bearer
                    expires_in: 3600
        '400':
          description: Invalid request (missing or invalid parameters)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: invalid_request
                  message:
                    type: string
                    example: client_id and client_secret are required
        '401':
          description: Invalid client credentials
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: invalid_client
                  message:
                    type: string
                    example: Invalid client credentials
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: rate_limit_exceeded
                  message:
                    type: string
                    example: Too many requests. Please try again later.
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: server_error
                  message:
                    type: string
                    example: An unexpected error occurred
        '502':
          description: Upstream token service unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: upstream_error
                  message:
                    type: string
                    example: Token service unavailable
      operationId: PostOauthClientCredentialAccesstokenV1
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
        title:
          type: string
        description:
          type: string
        source:
          type: string
      example:
        code: ERR101
        title: Example Title
    PatientUpdateV1:
      type: object
      properties:
        title:
          type: string
          maxLength: 25
          example: Dr.
        firstName:
          type: string
          minLength: 1
          maxLength: 25
          example: John
        middleInitial:
          type: string
          maxLength: 1
          example: P
        lastName:
          type: string
          minLength: 1
          maxLength: 25
          example: Doe
        nameSuffix:
          type: string
          maxLength: 10
          example: Jr.
        preferredName:
          type: string
          maxLength: 25
          example: Johnny
        gender:
          type: string
          enum:
            - M
            - F
            - O
          example: M
        dateOfBirth:
          type: string
          format: date
          description: A date in the ISO format YYYY-MM-DD. Example - 2021-01-19
          example: '1985-08-25'
        contactMethod:
          type: string
          enum:
            - Call me
            - Text me
            - Email me
          example: Email me
        languageType:
          type: string
          enum:
            - English
            - Spanish
            - Arabic
            - Armenian
            - Bengali
            - Bosnian
            - Cambodian
            - Chinese_Mandarin
            - Chinese_Cantonese
            - French
            - German
            - Greek
            - Hebrew
            - Hindi
            - Italian
            - Japanese
            - Korean
            - Laotian
            - Polish
            - Portuguese
            - Russian
            - Somali
            - Tagalog
            - Vietnamese
          example: English
        patientStatus:
          type: string
          enum:
            - NEW
            - ACTIVE
            - NON-PATIENT
            - INACTIVE
            - DUPLICATE
          example: ACTIVE
        emailAddress:
          type: string
          maxLength: 60
          format: email
          example: john.doe@example.com
        chartNumber:
          type: string
          maxLength: 10
          example: CH10023456
        preferredDays:
          type: array
          items:
            type: string
            enum:
              - SUNDAY
              - MONDAY
              - TUESDAY
              - WEDNESDAY
              - THURSDAY
              - FRIDAY
              - SATURDAY
          example:
            - MONDAY
            - TUESDAY
            - WEDNESDAY
        preferredTimes:
          type: array
          items:
            type: string
            enum:
              - EARLY_MORNING
              - LATE_MORNING
              - EARLY_AFTERNOON
              - LATE_AFTERNOON
          example:
            - EARLY_MORNING
            - LATE_MORNING
        address1:
          type: string
          minLength: 1
          maxLength: 50
          example: 123 Maple Street
        address2:
          type: string
          maxLength: 50
          example: Apt 101
        city:
          type: string
          minLength: 1
          maxLength: 30
          example: Anytown
        state:
          type: string
          enum:
            - AA
            - AE
            - AP
            - AL
            - AK
            - AS
            - AZ
            - AR
            - CA
            - CO
            - CNMI
            - CT
            - DE
            - DC
            - FM
            - FL
            - FSM
            - GA
            - GU
            - HI
            - ID
            - IL
            - IN
            - IA
            - KS
            - KY
            - LA
            - ME
            - MD
            - MH
            - MA
            - MI
            - MN
            - MS
            - MO
            - MT
            - NE
            - NV
            - NH
            - NJ
            - NM
            - NY
            - NC
            - ND
            - MP
            - OH
            - OK
            - OR
            - PW
            - PA
            - PR
            - RI
            - SC
            - SD
            - TN
            - TX
            - UT
            - VT
            - VI
            - VA
            - WA
            - WV
            - WI
            - WY
          example: CA
        postalCode:
          type: string
          minLength: 5
          maxLength: 10
          example: '90210'
        income:
          type: number
          format: double
          minimum: 0
          maximum: 99999.99
          example: 45000.5
        familySize:
          type: number
          format: int32
          example: 3
        discountType:
          type: string
          enum:
            - NONE
            - BASIC
            - SLIDING_FEES
          example: SLIDING_FEES
        discountPlan:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        discountPlanExpirationDate:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
        isOrthoPatient:
          type: boolean
          example: true
        phones:
          type: array
          items:
            type: object
            required:
              - phoneType
              - number
              - sequence
            properties:
              id:
                type: integer
                format: int64
                example: 1234
                readOnly: true
              phoneType:
                type: string
                enum:
                  - HOME
                  - WORK
                  - MOBILE
                  - OTHER
                example: MOBILE
              number:
                type: string
                maxLength: 10
                example: '5551234567'
              extension:
                type: string
                maxLength: 10
                example: '1231234545'
              sequence:
                description: >-
                  A number (1 or greater) representing the order of the phone
                  within the phoneType. The combination of phoneType and
                  sequence must be unique.
                type: integer
                format: int32
                example: 1
        primaryProvider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        duplicateOfPatient:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        title: Dr.
        firstName: John
    PatientV1:
      allOf:
        - $ref: '#/components/schemas/PatientUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - firstName
            - lastName
            - contactMethod
            - languageType
            - patientStatus
            - gender
            - dateOfBirth
            - preferredLocation
            - address1
            - city
            - state
            - postalCode
          properties:
            id:
              type: integer
              format: int64
              readOnly: true
            firstVisitDate:
              type: string
              format: date
              readOnly: true
              example: '2024-05-02T00:00:00.000Z'
            emergencyContact:
              type: object
              readOnly: true
              properties:
                name:
                  type: string
                  example: Bob Barker
                relationship:
                  type: string
                  example: Father
                phoneType:
                  type: string
                  enum:
                    - Home
                    - Work
                    - Mobile
                    - Other
                  example: Home
                phoneNumber:
                  type: string
                  example: 213-6745
                phoneExtension:
                  type: string
                  example: '222'
            referredByPatient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            referredByReferral:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            primaryGuarantor:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            secondaryGuarantor:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            primaryContact:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            secondaryContact:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            preferredLocation:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            referredPatients:
              type: array
              readOnly: true
              items:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
            lastModified:
              type: string
              format: date-time
              readOnly: true
              example: '2018-07-09T19:00:00.000Z'
      example: {}
    Pagination:
      type: object
      description: Pagination info
      properties:
        limit:
          type: integer
          format: int32
          example: 10
        offset:
          type: integer
          format: int32
          example: 0
        total:
          type: integer
          format: int32
          example: 100
      example:
        limit: 10
        offset: 0
    PatientCalcV1:
      type: object
      properties:
        patientId:
          type: integer
          format: int64
          readOnly: true
        lastVisitDate:
          type: string
          format: date-time
          readOnly: true
          example: '2024-05-02T19:00:00.000Z'
      example:
        patientId: 12445
        lastVisitDate: '2024-05-02T19:00:00.000Z'
    AppointmentUpdateV1:
      type: object
      properties:
        confirmed:
          type: string
          format: date-time
          example: '2024-05-02T16:30:00.000Z'
          readOnly: true
        needsFollowUp:
          type: boolean
          example: true
        followedUpOn:
          type: string
          format: date-time
          example: '2024-05-09T17:00:00.000Z'
        start:
          type: string
          format: date-time
          readOnly: false
          example: '2024-05-09T12:00:00.000Z'
        bookingType:
          type: string
          enum:
            - TREATMENT
            - RECARE
            - NEW_PATIENT
            - EXISTING_PATIENT
          example: TREATMENT
        needsPremedicate:
          type: boolean
          example: true
        note:
          type: string
          example: string
        other:
          type: string
          maxLength: 90
          example: string
        bookedOnline:
          type: boolean
          example: true
        leftMessage:
          type: string
          format: date
          example: '2024-05-02T00:00:00.000Z'
          readOnly: true
        duration:
          type: integer
          minimum: 5
          maximum: 1440
          example: 60
        asap:
          type: boolean
          example: true
        lastModified:
          type: string
          format: date-time
          example: '2024-05-09T17:00:00.000Z'
          readOnly: true
        labCaseDentalLab:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type and url at
            which the model can be accessed. Setting this field to null is going
            to set all labCase fields to null (labCaseStatus, labCaseDueDate,
            labCaseNote)
          properties:
            id:
              type: integer
              format: int64
            type:
              type: string
              example: string
            url:
              type: string
              format: url
              example: string
        labCaseStatus:
          type: string
          enum:
            - OUTSTANDING
            - RECEIVED
          example: OUTSTANDING
        labCaseDueDate:
          type: string
          format: date-time
          example: '2024-05-09T17:00:00.000Z'
        labCaseNote:
          type: string
          example: string
        patientProcedures:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
        practiceProcedures:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
        visits:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
      example:
        confirmed: '2024-05-02T16:30:00.000Z'
        needsFollowUp: true
    AppointmentV1:
      allOf:
        - $ref: '#/components/schemas/AppointmentUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - start
            - provider
            - status
            - patient
            - operatory
          properties:
            id:
              type: integer
              format: int64
              readOnly: true
            start:
              type: string
              format: date-time
              readOnly: false
              example: '2024-05-09T12:00:00.000Z'
            end:
              type: string
              format: date-time
              readOnly: true
              example: '2024-05-09T13:00:00.000Z'
            created:
              type: string
              format: date-time
              readOnly: true
              example: '2024-05-09T13:05:00.000Z'
            duration:
              type: integer
              minimum: 5
              maximum: 1440
              readOnly: false
              example: 1440
            status:
              type: string
              enum:
                - LATE
                - HERE
                - READY
                - CHAIR
                - COMPLETED
                - WILL_CALL
                - CONFIRMED
                - UNCONFIRMED
                - NO_SHOW
                - BROKEN
                - LEFT_MESSAGE
                - CHECKOUT
                - UNREACHABLE
                - CANCELLEDBYOFFICE
              example: COMPLETED
            statusId:
              type: number
              readOnly: true
            lastModified:
              type: string
              format: date-time
              readOnly: true
              example: '2024-05-09T13:30:00.000Z'
            labCaseDentalLab:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type and url
                at which the model can be accessed. Setting this field to null
                is going to set all labCase fields to null (labCaseStatus,
                labCaseDueDate, labCaseNote)
              properties:
                id:
                  type: integer
                  format: int64
                type:
                  type: string
                  example: string
                url:
                  type: string
                  format: url
                  example: string
            timePattern:
              type: object
              description: >-
                Used to represent who is providing care to the patient during
                the appointment.
              readOnly: true
              properties:
                duration:
                  type: integer
                  minimum: 5
                  maximum: 1440
                  readOnly: true
                  example: 1440
                blocksPerHour:
                  type: integer
                  readOnly: true
                  example: 6
                rows:
                  type: array
                  items:
                    type: object
                    properties:
                      activity:
                        type: string
                        enum:
                          - assistant
                          - provider
                          - chair
                          - none
                      order:
                        type: integer
                        example: 1
            labCaseDueDate:
              type: string
              format: date-time
              example: '2024-05-09T17:00:00.000Z'
            labCaseNote:
              type: string
              example: string
            provider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            otherProvider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            operatory:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    AppointmentUpdateV2:
      type: object
      properties:
        confirmed:
          type: string
          format: date-time
          example: '2024-05-02T16:30:00.000Z'
          readOnly: true
        needsFollowUp:
          type: boolean
          example: true
        followedUpOn:
          type: string
          format: date-time
          example: '2024-05-09T17:00:00.000Z'
        start:
          type: string
          format: date-time
          readOnly: false
          example: '2024-05-09T12:00:00.000Z'
        bookingType:
          type: string
          enum:
            - TREATMENT
            - RECARE
            - NEW_PATIENT
            - EXISTING_PATIENT
          example: TREATMENT
        needsPremedicate:
          type: boolean
          example: true
        note:
          type: string
          example: string
        other:
          type: string
          maxLength: 90
          example: string
        bookedOnline:
          type: boolean
          example: true
        leftMessage:
          type: string
          format: date
          example: '2024-05-02T00:00:00.000Z'
          readOnly: true
        duration:
          type: integer
          minimum: 5
          maximum: 1440
          example: 60
        asap:
          type: boolean
          example: true
        lastModified:
          type: string
          format: date-time
          example: '2024-05-09T17:00:00.000Z'
          readOnly: true
        labCaseDentalLab:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type and url at
            which the model can be accessed. Setting this field to null is going
            to set all labCase fields to null (labCaseStatus, labCaseDueDate,
            labCaseNote)
          properties:
            id:
              type: integer
              format: int64
            type:
              type: string
              example: string
            url:
              type: string
              format: url
              example: string
        labCaseStatus:
          type: string
          enum:
            - OUTSTANDING
            - RECEIVED
          example: OUTSTANDING
        labCaseDueDate:
          type: string
          format: date-time
          example: '2024-05-09T17:00:00.000Z'
        labCaseNote:
          type: string
          example: string
        patientProcedures:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
        practiceProcedures:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
        visits:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
      example:
        confirmed: '2024-05-02T16:30:00.000Z'
        needsFollowUp: true
    AppointmentV2:
      allOf:
        - $ref: '#/components/schemas/AppointmentUpdateV2'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - start
            - provider
            - status
            - patient
            - operatory
          properties:
            id:
              type: integer
              format: int64
              readOnly: true
            start:
              type: string
              format: date-time
              readOnly: false
              example: '2024-05-09T12:00:00.000Z'
            end:
              type: string
              format: date-time
              readOnly: true
              example: '2024-05-09T13:00:00.000Z'
            created:
              type: string
              format: date-time
              readOnly: true
              example: '2024-05-09T13:05:00.000Z'
            duration:
              type: integer
              minimum: 5
              maximum: 1440
              readOnly: false
              example: 1440
            status:
              type: string
              enum:
                - LATE
                - HERE
                - READY
                - CHAIR
                - COMPLETED
                - WILL_CALL
                - CONFIRMED
                - UNCONFIRMED
                - NO_SHOW
                - BROKEN
                - LEFT_MESSAGE
                - CHECKOUT
                - UNREACHABLE
                - CANCELLEDBYOFFICE
              example: COMPLETED
            statusId:
              type: number
              readOnly: true
            lastModified:
              type: string
              format: date-time
              readOnly: true
              example: '2024-05-09T13:30:00.000Z'
            labCaseDentalLab:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type and url
                at which the model can be accessed. Setting this field to null
                is going to set all labCase fields to null (labCaseStatus,
                labCaseDueDate, labCaseNote)
              properties:
                id:
                  type: integer
                  format: int64
                type:
                  type: string
                  example: string
                url:
                  type: string
                  format: url
                  example: string
            timePattern:
              type: object
              description: >-
                Used to represent who is providing care to the patient during
                the appointment.
              readOnly: true
              properties:
                duration:
                  type: integer
                  minimum: 5
                  maximum: 1440
                  readOnly: true
                  example: 1440
                blocksPerHour:
                  type: integer
                  readOnly: true
                  example: 6
                rows:
                  type: array
                  items:
                    type: object
                    properties:
                      activity:
                        type: string
                        enum:
                          - assistant
                          - provider
                          - chair
                          - none
                      order:
                        type: integer
                        example: 1
            labCaseDueDate:
              type: string
              format: date-time
              example: '2024-05-09T17:00:00.000Z'
            labCaseNote:
              type: string
              example: string
            provider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            otherProvider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            operatory:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    AppointmentHistoryV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
        type:
          type: string
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
        historyType:
          type: string
          enum:
            - BROKEN
            - NOSHOW
            - RESCHEDULED
            - CANCELED
          example: CANCELED
        originalDateTime:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
        rescheduledDateTime:
          type: string
          format: date-time
          example: '2018-08-09T19:00:00.000Z'
        insertDateTime:
          type: string
          format: date-time
          example: '2018-08-09T19:00:00.000Z'
        appointment:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        patient:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        id: 12445
        type: example_type
    AppointmentStatusHistoryV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1234
        type:
          type: string
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
        appointmentStatus:
          type: string
          enum:
            - LATE
            - HERE
            - READY
            - CHAIR
            - COMPLETED
            - WILL_CALL
            - CONFIRMED
            - UNCONFIRMED
            - NO_SHOW
            - BROKEN
            - LEFT_MESSAGE
            - CHECKOUT
            - UNREACHABLE
            - CANCELLEDBYOFFICE
          example:
            - READY
        effectiveTime:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
        appointment:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        id: 1234
        type: example_type
    AppointmentTaskUpdateV1:
      type: object
      properties:
        appointment:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        appointment:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
    AppointmentTaskV1:
      allOf:
        - $ref: '#/components/schemas/AppointmentTaskUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - taskType
          properties:
            id:
              type: integer
              format: int64
              readOnly: true
            taskType:
              type: string
              enum:
                - SCHEDULE_RECARE
                - COLLECT_PAYMENT
                - COLLECT_PHONE
                - COLLECT_EMAIL
              example: SCHEDULE_RECARE
            succeeded:
              readOnly: true
              type: boolean
            skippedReason:
              type: string
              enum:
                - WE_DID_NOT_ASK
                - PATIENT_DECLINED
                - PATIENT_WAS_UNABLE_TO_COMPLY
                - PATIENT_DEPARTED_WITHOUT_CHECKOUT
                - OTHER
              example: OTHER
            comment:
              type: string
              description: Can be provided only if skippedReason has value OTHER
              example: comments
            user:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    ProviderNumber:
      type: object
      required:
        - location
      properties:
        number:
          type: string
          maxLength: 20
          example: '32131'
        location:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        location:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        number: '32131'
    ProviderUpdateV1:
      type: object
      properties:
        type:
          type: string
          example: provider
          enum:
            - Provider
        firstName:
          type: string
          minLength: 1
          maxLength: 25
          example: first
        middleInitial:
          type: string
          maxLength: 1
          example: m
        lastName:
          type: string
          minLength: 1
          maxLength: 50
          example: last
        shortName:
          type: string
          minLength: 3
          maxLength: 6
          example: short
        npi:
          type: string
          maxLength: 10
        color:
          type: string
          maxLength: 6
        active:
          type: boolean
          example: true
        stateId:
          type: string
          minLength: 1
          maxLength: 20
          example: s1234567890098765432
        tin:
          type: string
          minLength: 9
          maxLength: 9
        specialty:
          type: string
          enum:
            - DENTALPUBLICHEALTH
            - DENTALSPECIALTY
            - DENTIST
            - DENTAL
            - ENDODONTICS
            - FEDERALLYQUALIFIEDHEALTHCENTER
            - GENERALPRACTICE
            - HYGIENIST
            - MULTISPECIALTY
            - ORTHODONTICS
            - ORALMAXILLOFACIALPATHOLOGY
            - ORALMAXILLOFACIALRADIOLOGY
            - ORALMAXILLOFACIALSURGERY
            - PEDIATRICDENTISTRY
            - PERIODONTICS
            - PROSTHODONTICS
            - SINGLESPECIALTY
          example: DENTIST
        isPrimaryProvider:
          type: boolean
          example: true
        title:
          type: string
          maxLength: 50
        signatureOnFile:
          type: boolean
          example: true
        address1:
          type: string
          maxLength: 50
          example: 123 example st
        address2:
          type: string
          maxLength: 50
          example: 456 example st
        city:
          type: string
          maxLength: 30
        state:
          type: string
          enum:
            - AA
            - AE
            - AP
            - AL
            - AK
            - AS
            - AZ
            - AR
            - CA
            - CO
            - CNMI
            - CT
            - DE
            - DC
            - FM
            - FL
            - FSM
            - GA
            - GU
            - HI
            - ID
            - IL
            - IN
            - IA
            - KS
            - KY
            - LA
            - ME
            - MD
            - MH
            - MA
            - MI
            - MN
            - MS
            - MO
            - MT
            - NE
            - NV
            - NH
            - NJ
            - NM
            - NY
            - NC
            - ND
            - MP
            - OH
            - OK
            - OR
            - PW
            - PA
            - PR
            - RI
            - SC
            - SD
            - TN
            - TX
            - UT
            - VT
            - VI
            - VA
            - WA
            - WV
            - WI
            - WY
          example: AA
        postalCode:
          type: string
          minLength: 5
          maxLength: 10
          example: 2345670987
        isLocumTenens:
          type: boolean
        stateIdExpiration:
          type: string
          format: date
          example: '2018-07-09T00:00:00.000Z'
        providerNumbers:
          type: array
          items:
            $ref: '#/components/schemas/ProviderNumber'
        insuranceCarriers:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
        feeSchedule:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        user:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        location:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        type: provider
        firstName: first
    ProviderV1:
      allOf:
        - $ref: '#/components/schemas/ProviderUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - firstName
            - lastName
            - shortName
            - specialty
            - isPrimaryProvider
            - address1
            - city
            - state
            - postalCode
          properties:
            id:
              type: integer
              format: int64
              example: 32432432
              readOnly: true
            isNonPersonEntity:
              type: boolean
              example: false
              readOnly: true
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
      example: {}
    ProviderHourUpdateV1:
      type: object
      properties:
        startDate:
          type: string
          format: date
          example: '2024-05-10'
        endDate:
          type: string
          format: date
          example: '2024-05-10'
        numberOfWeeks:
          type: integer
          format: int32
          minimum: 1
          maximum: 4
          example: 4
        startDayIndex:
          type: integer
          format: int32
          minimum: 1
          maximum: 31
          example: 31
        type:
          type: string
          enum:
            - ProviderHour
          example: ProviderHour
        days:
          type: object
          properties:
            SUNDAY:
              type: array
              items:
                type: object
                properties:
                  weekNumber:
                    type: integer
                    format: int32
                    example: 5
                  hours:
                    type: array
                    items:
                      type: object
                      properties:
                        startTime:
                          type: string
                          format: time
                          example: '13:00'
                        endTime:
                          type: string
                          format: time
                          example: '15:00'
            MONDAY:
              type: array
              items:
                type: object
                properties:
                  weekNumber:
                    type: integer
                    format: int32
                    example: 5
                  hours:
                    type: array
                    items:
                      type: object
                      properties:
                        startTime:
                          type: string
                          format: time
                          example: '13:00'
                        endTime:
                          type: string
                          format: time
                          example: '15:00'
            TUESDAY:
              type: array
              items:
                type: object
                properties:
                  weekNumber:
                    type: integer
                    format: int32
                    example: 5
                  hours:
                    type: array
                    items:
                      type: object
                      properties:
                        startTime:
                          type: string
                          format: time
                          example: '13:00'
                        endTime:
                          type: string
                          format: time
                          example: '15:00'
            WEDNESDAY:
              type: array
              items:
                type: object
                properties:
                  weekNumber:
                    type: integer
                    format: int32
                    example: 5
                  hours:
                    type: array
                    items:
                      type: object
                      properties:
                        startTime:
                          type: string
                          format: time
                          example: '13:00'
                        endTime:
                          type: string
                          format: time
                          example: '15:00'
            THURSDAY:
              type: array
              items:
                type: object
                properties:
                  weekNumber:
                    type: integer
                    format: int32
                    example: 5
                  hours:
                    type: array
                    items:
                      type: object
                      properties:
                        startTime:
                          type: string
                          format: time
                          example: '13:00'
                        endTime:
                          type: string
                          format: time
                          example: '15:00'
            FRIDAY:
              type: array
              items:
                type: object
                properties:
                  weekNumber:
                    type: integer
                    format: int32
                    example: 5
                  hours:
                    type: array
                    items:
                      type: object
                      properties:
                        startTime:
                          type: string
                          format: time
                          example: '13:00'
                        endTime:
                          type: string
                          format: time
                          example: '15:00'
            SATURDAY:
              type: array
              items:
                type: object
                properties:
                  weekNumber:
                    type: integer
                    format: int32
                    example: 5
                  hours:
                    type: array
                    items:
                      type: object
                      properties:
                        startTime:
                          type: string
                          format: time
                          example: '13:00'
                        endTime:
                          type: string
                          format: time
                          example: '15:00'
        isDefaultSchedule:
          type: boolean
          example: true
      example:
        startDate: '2024-05-10'
        endDate: '2024-05-10'
    ProviderHourV1:
      allOf:
        - $ref: '#/components/schemas/ProviderHourUpdateV1'
        - type: object
          required:
            - startDate
            - numberOfWeeks
            - startDayIndex
            - provider
            - location
          properties:
            id:
              type: integer
              format: int64
              example: 32424
              readOnly: true
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
            provider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    FeeScheduleV1:
      type: object
      required:
        - name
      properties:
        id:
          type: integer
          format: int64
          example: 324324
          readOnly: true
        name:
          type: string
          minLength: 1
          maxLength: 64
        lastModified:
          type: string
          format: date-time
          readOnly: true
          example: '2018-07-09T19:00:00.000Z'
      example:
        name: Example Name
        id: 324324
        lastModified: '2018-07-09T19:00:00.000Z'
    FeeScheduleRangeUpdateV1:
      type: object
      properties:
        startDate:
          type: string
          format: date
          example: '2024-04-01T00:00:00.000Z'
          description: >
            should be earlier than endDate<br>

            should not be earlier than the startDate of the previous range<br>

            should be null if it is the first range in fee schedule<br>

            field is recalculated on the update of the startDate of the next
            range<br>

            field should have value equal to the value of the endDate of the
            previous range + 1 day<br>
        items:
          type: object
          properties:
            (practiceProcedureId):
              type: number
              format: double
              maxLength: 10
              maximum: 9999999.99
              minimum: 0
              example: 9999999.99
          description: >
            supports partial update: you can provide only changed fees of
            procedures
      example:
        startDate: '2024-04-01T00:00:00.000Z'
        items:
          (practiceProcedureId): 9999999.99
    FeeScheduleRangeV1:
      allOf:
        - $ref: '#/components/schemas/FeeScheduleRangeUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide 
          required:
            - feeSchedule
            - startDate
          properties:
            id:
              type: integer
              format: int64
              example: 232133
              readOnly: true
            feeScheduleVersion:
              type: integer
              example: 5
              readOnly: true
            feeSchedule:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            endDate:
              type: string
              format: date
              example: '2024-05-10T00:00:00.000Z'
              readOnly: true
              description: >
                should be later than startDate<br>

                should not be later than the endDate of the next range<br>

                should be null if it is the last range in fee schedule<br>

                field is recalculated on the update of the endDate of the
                previous range<br>

                field should have value equal to the value of the startDate of
                the next range - 1 day<br>
            lastModified:
              type: string
              format: date-time
              readOnly: true
              example: '2018-07-09T19:00:00.000Z'
      example: {}
    ReferralSourceUpdateV1:
      type: object
      properties:
        firstName:
          type: string
          maxLength: 25
          example: first
        middleInitial:
          type: string
          maxLength: 1
          example: m
        lastName:
          type: string
          minLength: 1
          maxLength: 50
          example: last
        title:
          type: string
          maxLength: 25
        specialty:
          type: string
          enum:
            - DENTALPUBLICHEALTH
            - DENTALSPECIALTY
            - DENTIST
            - DENTAL
            - ENDODONTICS
            - FEDERALLYQUALIFIEDHEALTHCENTER
            - GENERALPRACTICE
            - HYGIENIST
            - MULTISPECIALTY
            - ORTHODONTICS
            - ORALMAXILLOFACIALPATHOLOGY
            - ORALMAXILLOFACIALRADIOLOGY
            - ORALMAXILLOFACIALSURGERY
            - PEDIATRICDENTISTRY
            - PERIODONTICS
            - PROSTHODONTICS
            - SINGLESPECIALTY
          example: DENTIST
        referralSourceType:
          type: string
          enum:
            - MARKETING
            - OTHER
            - PROFESSIONAL
          example: OTHER
        note:
          type: string
          maxLength: 512
        npi:
          type: string
          maxLength: 10
          minLength: 10
        stateId:
          type: string
          maxLength: 15
        address1:
          type: string
          maxLength: 50
          example: 123 example st
        address2:
          type: string
          maxLength: 50
          example: 456 example st
        city:
          type: string
          maxLength: 30
        state:
          type: string
          enum:
            - AA
            - AE
            - AP
            - AL
            - AK
            - AS
            - AZ
            - AR
            - CA
            - CO
            - CNMI
            - CT
            - DE
            - DC
            - FM
            - FL
            - FSM
            - GA
            - GU
            - HI
            - ID
            - IL
            - IN
            - IA
            - KS
            - KY
            - LA
            - ME
            - MD
            - MH
            - MA
            - MI
            - MN
            - MS
            - MO
            - MT
            - NE
            - NV
            - NH
            - NJ
            - NM
            - NY
            - NC
            - ND
            - MP
            - OH
            - OK
            - OR
            - PW
            - PA
            - PR
            - RI
            - SC
            - SD
            - TN
            - TX
            - UT
            - VT
            - VI
            - VA
            - WA
            - WV
            - WI
            - WY
          example: AA
        postalCode:
          type: string
          minLength: 5
          maxLength: 10
          example: '3445345678'
        phone1_number:
          type: string
          minLength: 10
          maxLength: 10
          example: '1236547685'
        phone1_type:
          type: string
          enum:
            - HOME
            - WORK
            - MOBILE
            - OTHER
          example: HOME
        phone1_extension:
          type: string
          maxLength: 10
          example: '7654345645'
        phone2_number:
          type: string
          minLength: 10
          maxLength: 10
          example: '8654765869'
        phone2_type:
          type: string
          enum:
            - HOME
            - WORK
            - MOBILE
            - OTHER
          example: WORK
        phone2_extension:
          type: string
          maxLength: 10
          example: '3248767678'
        phone3_number:
          type: string
          minLength: 10
          maxLength: 10
          example: '7876754353'
        phone3_type:
          type: string
          enum:
            - HOME
            - WORK
            - MOBILE
            - OTHER
          example: MOBILE
        phone3_extension:
          type: string
          maxLength: 10
          example: '8765434345'
        email:
          type: string
          format: email
          maxLength: 60
          example: example@email.com
      example:
        firstName: first
        middleInitial: m
    ReferralSourceV1:
      allOf:
        - $ref: '#/components/schemas/ReferralSourceUpdateV1'
        - type: object
          required:
            - lastName
            - referralSourceType
          properties:
            id:
              type: integer
              format: int64
              example: 3423432
              readOnly: true
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
      example: {}
    LocationV1:
      type: object
      description: >
        This Endpoint is being rate limited. More information can be found here:
        https://portal.hs1api.com/guide
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
          maxLength: 50
          example: string
        abbreviation:
          type: string
          maxLength: 5
          example: strin
        taxPercentage:
          type: number
          format: double
          minimum: 0
          maximum: 100
          example: 100
        timeZone:
          type: string
          readOnly: true
          example: string
        website:
          type: string
          maxLength: 100
          example: string
        email:
          type: string
          format: email
          maxLength: 60
          example: string
        phone:
          type: string
          maxLength: 10
          minLength: 10
          example: string
        address1:
          type: string
          maxLength: 50
          example: string
        address2:
          type: string
          maxLength: 50
          example: string
        city:
          type: string
          maxLength: 30
          example: string
        state:
          type: string
          enum:
            - AA
            - AE
            - AP
            - AL
            - AK
            - AS
            - AZ
            - AR
            - CA
            - CO
            - CNMI
            - CT
            - DE
            - DC
            - FM
            - FL
            - FSM
            - GA
            - GU
            - HI
            - ID
            - IL
            - IN
            - IA
            - KS
            - KY
            - LA
            - ME
            - MD
            - MH
            - MA
            - MI
            - MN
            - MS
            - MO
            - MT
            - NE
            - NV
            - NH
            - NJ
            - NM
            - NY
            - NC
            - ND
            - MP
            - OH
            - OK
            - OR
            - PW
            - PA
            - PR
            - RI
            - SC
            - SD
            - TN
            - TX
            - UT
            - VT
            - VI
            - VA
            - WA
            - WV
            - WI
            - WY
          example: AA
        postalCode:
          type: string
          minLength: 5
          maxLength: 10
          example: string
        billing_entityEnabled:
          type: boolean
          example: true
        billing_name:
          type: string
          maxLength: 50
          example: string
        billing_address1:
          type: string
          maxLength: 50
          example: string
        billing_address2:
          type: string
          maxLength: 50
          example: string
        billing_city:
          type: string
          maxLength: 30
          example: string
        billing_state:
          type: string
          enum:
            - AA
            - AE
            - AP
            - AL
            - AK
            - AS
            - AZ
            - AR
            - CA
            - CO
            - CNMI
            - CT
            - DE
            - DC
            - FM
            - FL
            - FSM
            - GA
            - GU
            - HI
            - ID
            - IL
            - IN
            - IA
            - KS
            - KY
            - LA
            - ME
            - MD
            - MH
            - MA
            - MI
            - MN
            - MS
            - MO
            - MT
            - NE
            - NV
            - NH
            - NJ
            - NM
            - NY
            - NC
            - ND
            - MP
            - OH
            - OK
            - OR
            - PW
            - PA
            - PR
            - RI
            - SC
            - SD
            - TN
            - TX
            - UT
            - VT
            - VI
            - VA
            - WA
            - WV
            - WI
            - WY
          example: AA
        billing_postalCode:
          type: string
          minLength: 10
          maxLength: 10
          example: '##########'
        billing_phone:
          type: string
          maxLength: 10
          minLength: 10
          example: string
        image:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        provider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        feeSchedule:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
      example:
        id: 12445
        name: string
    OperatoryUpdateV1:
      type: object
      properties:
        name:
          type: string
          maxLength: 25
        shortName:
          type: string
          minLength: 1
          maxLength: 25
          example: short name
        active:
          type: boolean
          example: true
      example:
        name: Example Name
        shortName: short name
    OperatoryV1:
      allOf:
        - $ref: '#/components/schemas/OperatoryUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - shortName
            - location
          properties:
            id:
              type: integer
              format: int64
              readOnly: true
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    OrganizationV1:
      type: object
      required:
        - name
        - softwareType
        - customer
        - alias
        - allowAutoClaimSubmission
        - isTestingOrganization
        - isEnabled
        - writeOffAutoPostEnabled
      properties:
        id:
          type: integer
          format: int64
          example: 32432432
        name:
          type: string
          minLength: 1
          maxLength: 255
        timeZone:
          type: string
        email:
          type: string
          example: example@email.com
        address1:
          type: string
          maxLength: 50
          example: 123 example st
        address2:
          type: string
          maxLength: 50
          example: 456 example st
        city:
          type: string
          maxLength: 30
        state:
          type: string
          enum:
            - AA
            - AE
            - AP
            - AL
            - AK
            - AS
            - AZ
            - AR
            - CA
            - CO
            - CNMI
            - CT
            - DE
            - DC
            - FM
            - FL
            - FSM
            - GA
            - GU
            - HI
            - ID
            - IL
            - IN
            - IA
            - KS
            - KY
            - LA
            - ME
            - MD
            - MH
            - MA
            - MI
            - MN
            - MS
            - MO
            - MT
            - NE
            - NV
            - NH
            - NJ
            - NM
            - NY
            - NC
            - ND
            - MP
            - OH
            - OK
            - OR
            - PW
            - PA
            - PR
            - RI
            - SC
            - SD
            - TN
            - TX
            - UT
            - VT
            - VI
            - VA
            - WA
            - WV
            - WI
            - WY
          example: AA
        postalCode:
          type: string
          minLength: 5
          maxLength: 10
          example: '2342387987'
        phone:
          type: string
          maxLength: 10
          minLength: 10
          example: '6788763232'
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
      example:
        name: Example Name
        id: 32432432
        timeZone: timeZone
    PracticeProcedureBaseV1:
      type: object
      properties:
        description:
          type: string
          maxLength: 255
        abbreviatedDescription:
          type: string
          maxLength: 255
          example: abbreviated description
        favorite:
          type: boolean
          example: false
        active:
          type: boolean
          example: true
      example:
        description: Example description for description
        abbreviatedDescription: abbreviated description
    PracticeProcedureUpdateV1:
      allOf:
        - $ref: '#/components/schemas/PracticeProcedureBaseV1'
        - type: object
          properties:
            category:
              type: string
              enum:
                - DIAGNOSTIC
                - PREVENTIVE
                - RESTORATIVE
                - ENDODONTICS
                - PERIODONTICS
                - PROSTHREMOV
                - MAXILLOPROSTH
                - IMPLANTSERV
                - PROSTHOFIXED
                - ORALSURGERY
                - ORTHODONTICS
                - ADJUNCTSERV
                - MULTICODES
                - PRODUCTS
                - SLEEPAPNEASERV
            treatmentArea:
              type: string
              description: >-
                if MULTICODES, codeType must be set to either Standard or
                Bridge.
              enum:
                - TOOTH
                - MOUTH
                - SURFACE
                - QUADRANT
                - ROOT
                - MULTICODES
                - ARCH
                - SEXTANT
            chartingSymbol:
              type: string
              enum:
                - CROWN_3_4_HATCHED
                - CROWN_3_4_OUTLINE
                - CROWN_3_4_SOLID
                - ABSCESS
                - APICOECTOMY
                - BRIDGE_HATCHED
                - BRIDGE_OUTLINE
                - BRIDGE_RETAINER_CROWN_HATCHED
                - BRIDGE_RETAINER_CROWN_OUTLINE
                - CROWN_HATCHED
                - CROWN_OUTLINE
                - CROWN_SOLID
                - DENTURE_HATCHED
                - DENTURE_OUTLINE
                - DENTURE_SOLID
                - DRIFTING_DISTAL
                - DRIFTING_MESIAL
                - EXTRACTION
                - FRACTURED_CHIPPED_TOOTH
                - HYPERSENSITIVITY
                - IMPLANT_BLADE
                - IMPLANT_CYLINDER
                - NON_FUNCTIONAL_TOOTH
                - PINS
                - POSTS
                - RECESSION
                - ROOT_CANAL
                - SEALANT
                - SURFACE_RESTORATION_DOTTED
                - SURFACE_RESTORATION_HATCHED
                - SURFACE_RESTORATION_SOLID
                - UNERUPTED
                - WATCH_TOOTH
                - BRIDGE_SOLID
                - BRIDGE_RETAINER_CROWN_SOLID
                - RETAINED_ROOT_OUTLINE
                - IMPACTED_TOOTH
                - LACK_OF_INTERPROXIMAL_TOOTH_CONTACT
            billToInsurance:
              type: boolean
            fee:
              type: number
              format: double
            needsPredetermination:
              type: boolean
            isClinicalNoteRequired:
              type: boolean
      example: {}
    PracticeProcedureUpdateStandardV1:
      allOf:
        - $ref: '#/components/schemas/PracticeProcedureBaseV1'
        - type: object
          properties:
            procedures:
              type: array
              description: used for MULTICODES case if codeType field is Standard
              items:
                type: object
                properties:
                  practiceProcedure:
                    type: object
                    description: >-
                      A reference to a linked model. Includes the id, the type,
                      and URL at which the model can be accessed.
                    required:
                      - id
                      - url
                    properties:
                      id:
                        type: integer
                        format: int64
                        description: The unique identifier for the linked model.
                        example: 12345
                      type:
                        type: string
                        description: The type of the linked model. This field is read-only.
                        example: ExampleModelType
                        readOnly: true
                      url:
                        type: string
                        format: uri
                        description: >-
                          The URL at which the linked model can be accessed.
                          This field is read-only.
                        example: https://api.example.com/models/12345
                        readOnly: true
                  multiCodeType:
                    type: string
                    enum:
                      - Standard
                      - Bridge
                  occlusalIncisal:
                    type: boolean
                  mesial:
                    type: boolean
                  buccalFacial:
                    type: boolean
                  distal:
                    type: boolean
                  lingual:
                    type: boolean
                  classFive:
                    type: boolean
      example: {}
    PracticeProcedureUpdateBridgeV1:
      allOf:
        - $ref: '#/components/schemas/PracticeProcedureBaseV1'
        - type: object
          description: >-
            ponticProcedure and retainerProcedure are ONLY used for MULTICODES
            case if codeType field is Bridge
          properties:
            ponticProcedure:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            retainerProcedure:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    PracticeProcedureV1:
      allOf:
        - $ref: '#/components/schemas/PracticeProcedureUpdateV1'
        - $ref: '#/components/schemas/PracticeProcedureUpdateStandardV1'
        - $ref: '#/components/schemas/PracticeProcedureUpdateBridgeV1'
        - type: object
          required:
            - adaCode
            - abbreviatedDescription
            - description
            - category
            - treatmentArea
          properties:
            id:
              type: integer
              format: int64
              example: 1250
              readOnly: true
            adaCode:
              type: string
              maxLength: 10
              example: ada code
            isTreatmentInfoRequired:
              type: boolean
              example: true
            codeExtension:
              type: string
              minLength: 1
              maxLength: 5
              example: strin
            codeVersion:
              type: integer
              minimum: 0
              format: int16
              example: 1
            defaultTeethRange:
              type: string
              enum:
                - D5110
                - D5120
                - D5130
                - D5140
                - D5863
                - D5865
                - D5511
                - D5512
                - D6118
                - D6119
                - D0365
                - D0366
                - D0381
                - D0382
              example: D5110
            codeType:
              type: string
              description: >-
                procedures field is required if Standard. both ponticProcedure
                and retainerProcedure fields are required if Bridge.
              enum:
                - Standard
                - Bridge
              example: Standard
            hasProsthesis:
              type: boolean
              example: true
            recareTemplate:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
      example: {}
    PatientProcedure:
      type: object
      description: >
        This Endpoint is being rate limited. More information can be found here:
        https://portal.hs1api.com/guide
      required:
        - practiceProcedure
        - renderingProvider
        - amount
        - state
        - status
        - patient
        - location
        - billToInsurance
      properties:
        id:
          type: integer
          format: int64
          example: 32432
        amount:
          type: number
          format: float
          example: 100
        entryDate:
          type: string
          format: date
          example: '2021-09-29'
        serviceDate:
          type: string
          format: date
          example: '2021-09-29'
        startDate:
          type: string
          format: date
          example: '2018-07-09'
        endDate:
          type: string
          format: date
          example: '2018-07-09'
        treatmentPlannedDate:
          type: string
          format: date
          example: '2018-07-09'
        entryDateTime:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
        serviceDateTime:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
        startDateTime:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
        endDateTime:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
        treatmentPlannedDateTime:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
        status:
          type: string
          enum:
            - COMPLETED
            - EXISTING
            - TREATMENT_PLAN
          example: COMPLETED
        oralCavity:
          type: string
          enum:
            - UPPER_LEFT
            - UPPER_RIGHT
            - LOWER_LEFT
            - LOWER_RIGHT
            - ARCH_MAXILLARY
            - ARCH_MANDI_BULAR
            - UPPER_LEFT_SEXTANT
            - UPPER_ANTERIOR_SEXTANT
            - UPPER_RIGHT_SEXTANT
            - LOWER_LEFT_SEXTANT
            - LOWER_ANTERIOR_SEXTANT
            - LOWER_RIGHT_SEXTANT
          example: UPPER_LEFT
        notes:
          type: string
          maxLength: 255
          example: note
        state:
          type: string
          enum:
            - ACTIVE
            - CANCELLED
            - INVALIDATED
          example: ACTIVE
        primaryInsuranceEstimateOverride:
          type: number
          format: double
          example: 100
        secondaryInsuranceEstimateOverride:
          type: number
          format: double
          example: 100
        billToInsurance:
          type: boolean
          example: true
        expirationDate:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
        voidReason:
          type: string
          enum:
            - MISTAKE
            - OTHER
            - ALLERGIC_REACTION
            - OTHER_REACTION
            - INEFFECTIVE
            - MISTAKE_NOT_PRESCRIBED
          example: OTHER
        voidNote:
          type: string
          maxLength: 500
          example: note
        voidDate:
          type: string
          format: date
          example: '2018-08-09T00:00:00.000Z'
          readOnly: true
        autoCalculateEstimateEnabled:
          type: boolean
          example: true
        procedureTeeth:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                example: abc123
              procedureId:
                type: integer
                format: int64
                example: 987654321
              mesial:
                type: boolean
                example: true
              incisal:
                type: boolean
                example: false
              occlusal:
                type: boolean
                example: true
              distal:
                type: boolean
                example: false
              lingual:
                type: boolean
                example: true
              facial:
                type: boolean
                example: true
              buccal:
                type: boolean
                example: false
              classFive:
                type: boolean
                example: true
              toothId:
                type: string
                example: T123
              incisalOcclusal:
                type: boolean
                example: false
              facialBuccal:
                type: boolean
                example: true
        patient:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        location:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        practiceProcedure:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        renderingProvider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        treatmentPlannedProvider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        user:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        insuranceClaims:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
        patientConditions:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
        perioExams:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
        replacedBy:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        primaryInsurance:
          type: number
          format: float
          example: 100
          writeOnly: true
        secondaryInsurance:
          type: number
          format: float
          example: 200
          writeOnly: true
        writeOff:
          type: number
          format: float
          example: 500
          writeOnly: true
        guarantorPortion:
          type: number
          format: float
          example: 200
          writeOnly: true
      example:
        amount: 100
        status: COMPLETED
        state: ACTIVE
        billToInsurance: true
        patient:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        location:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        practiceProcedure:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        renderingProvider:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        id: 32432
        entryDate: '2021-09-29'
    PatientProcedureCalc:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 854228
        isEditable:
          type: boolean
          example: true
        appointmentToBeDeleted:
          type: number
          example: 0
      example:
        id: 854228
        isEditable: true
    PatientProcedureUpdateV1:
      type: object
      properties:
        amount:
          type: number
          format: float
          example: 123.56
        entryDate:
          type: string
          format: date
          example: '2021-09-29T00:00:00.000Z'
        serviceDate:
          type: string
          format: date
          example: '2021-09-29T00:00:00.000Z'
        startDate:
          type: string
          format: date
          example: '2018-07-09T00:00:00.000Z'
        endDate:
          type: string
          format: date
          example: '2018-07-09T00:00:00.000Z'
        treatmentPlannedDate:
          type: string
          format: date
          example: '2018-07-09T00:00:00.000Z'
        expirationDate:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
        status:
          type: string
          enum:
            - COMPLETED
            - EXISTING
            - TREATMENT_PLAN
          example: COMPLETED
        oralCavity:
          type: string
          enum:
            - UPPER_LEFT
            - UPPER_RIGHT
            - LOWER_LEFT
            - LOWER_RIGHT
            - ARCH_MAXILLARY
            - ARCH_MANDI_BULAR
            - UPPER_LEFT_SEXTANT
            - UPPER_ANTERIOR_SEXTANT
            - UPPER_RIGHT_SEXTANT
            - LOWER_LEFT_SEXTANT
            - LOWER_ANTERIOR_SEXTANT
            - LOWER_RIGHT_SEXTANT
          example: UPPER_LEFT
        notes:
          type: string
          maxLength: 255
          exclusiveMaximum: false
          example: string
        state:
          type: string
          enum:
            - ACTIVE
            - CANCELLED
            - INVALIDATED
          example: ACTIVE
        primaryInsuranceEstimateOverride:
          type: number
          format: double
          example: 1.23456
        secondaryInsuranceEstimateOverride:
          type: number
          format: double
          example: 1.23456
        billToInsurance:
          type: boolean
          example: true
        autoCalculateEstimateEnabled:
          type: boolean
          description: Required if status field is COMPLETED
          example: true
        monthsRemaining:
          type: number
          format: int16
          example: 0
        referredOut:
          type: boolean
          example: true
        procedureTeeth:
          type: array
          description: >-
            Required if treatmentArea of practiceProcedure is in [TOOTH,
            SURFACE, ROOT]
          items:
            type: object
            properties:
              id:
                type: string
                example: abc123
              procedureId:
                type: integer
                format: int64
                example: 987654321
              mesial:
                type: boolean
                example: true
              incisal:
                type: boolean
                example: false
              occlusal:
                type: boolean
                example: true
              distal:
                type: boolean
                example: false
              lingual:
                type: boolean
                example: true
              facial:
                type: boolean
                example: true
              buccal:
                type: boolean
                example: false
              classFive:
                type: boolean
                example: true
              toothId:
                type: string
                example: T123
              incisalOcclusal:
                type: boolean
                example: false
              facialBuccal:
                type: boolean
                example: true
        practiceProcedure:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        renderingProvider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        treatmentPlannedProvider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        insuranceClaims:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
        patientConditions:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
        perioExams:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
        primaryInsurance:
          type: number
          format: float
          writeOnly: true
          example: 1.23
        secondaryInsurance:
          type: number
          format: float
          writeOnly: true
          example: 1.23
        writeOff:
          type: number
          format: float
          writeOnly: true
          example: 1.23
        guarantorPortion:
          type: number
          format: float
          writeOnly: true
          example: 1.23
        replacedBy:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        amount: 123.56
        entryDate: '2021-09-29T00:00:00.000Z'
    PatientProcedureGraphV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
        amount:
          type: number
          format: float
          example: 153.25
        entryDate:
          type: string
          format: date
          example: '2021-09-29T00:00:00.000Z'
        serviceDate:
          type: string
          format: date
          example: '2021-09-29T00:00:00.000Z'
        entryDateTime:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
        serviceDateTime:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
        status:
          type: string
          enum:
            - COMPLETED
            - EXISTING
            - TREATMENT_PLAN
          example: COMPLETED
        state:
          type: string
          enum:
            - ACTIVE
            - CANCELLED
            - INVALIDATED
          example: ACTIVE
        billToInsurance:
          type: boolean
          example: true
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
        procedureTeeth:
          type: array
          items:
            type: object
            properties:
              tooth:
                type: integer
                description: toothIndex
                example: 0
              toothId:
                type: integer
                description: global tooth ID
              universalCode:
                type: string
                example: string
              surfaces:
                description: Can be empty or null if treatmentArea is not SURFACE
                type: string
                example: string
        practiceProcedure:
          type: object
          properties:
            id:
              type: integer
              format: int64
            adaCode:
              type: string
              example: string
            description:
              type: string
              example: string
            abbreviatedDescription:
              type: string
              example: string
            category:
              type: string
              enum:
                - DIAGNOSTIC
                - PREVENTIVE
                - RESTORATIVE
                - ENDODONTICS
                - PERIODONTICS
                - PROSTHREMOV
                - MAXILLOPROSTH
                - IMPLANTSERV
                - PROSTHOFIXED
                - ORALSURGERY
                - ORTHODONTICS
                - ADJUNCTSERV
                - MULTICODES
                - PRODUCTS
                - SLEEPAPNEASERV
              example: DIAGNOSTIC
            treatmentArea:
              type: string
              enum:
                - TOOTH
                - MOUTH
                - SURFACE
                - QUADRANT
                - ROOT
                - MULTICODES
                - ARCH
                - SEXTANT
              example: TOOTH
        provider:
          type: object
          properties:
            id:
              type: integer
              format: int64
            npi:
              type: string
              example: string
            firstName:
              type: string
              example: string
            lastName:
              type: string
              example: string
            specialty:
              type: string
              enum:
                - DENTALPUBLICHEALTH
                - DENTALSPECIALTY
                - DENTIST
                - DENTAL
                - ENDODONTICS
                - FEDERALLYQUALIFIEDHEALTHCENTER
                - GENERALPRACTICE
                - HYGIENIST
                - MULTISPECIALTY
                - ORTHODONTICS
                - ORALMAXILLOFACIALPATHOLOGY
                - ORALMAXILLOFACIALRADIOLOGY
                - ORALMAXILLOFACIALSURGERY
                - PEDIATRICDENTISTRY
                - PERIODONTICS
                - PROSTHODONTICS
                - SINGLESPECIALTY
              example: DENTALPUBLICHEALTH
        patient:
          type: object
          properties:
            id:
              type: integer
              format: int64
            firstName:
              type: string
              example: string
            lastName:
              type: string
              example: string
        location:
          type: object
          properties:
            id:
              type: integer
              format: int64
            name:
              type: string
              example: string
        txCase:
          type: object
          properties:
            id:
              type: integer
              format: int64
            name:
              type: string
              example: string
            note:
              type: string
              example: string
            status:
              type: string
              enum:
                - NEW
                - PRESENTED
                - ACCEPTED
                - REJECTED
              example: ACCEPTED
      example:
        id: 12445
        amount: 153.25
    PatientProcedureVoidV1:
      type: object
      required:
        - voidReason
        - voidNote
        - user
      properties:
        voidReason:
          type: string
          enum:
            - MISTAKE
            - OTHER
            - ALLERGIC_REACTION
            - OTHER_REACTION
            - INEFFECTIVE
            - MISTAKE_NOT_PRESCRIBED
          example: OTHER
        voidNote:
          type: string
          maxLength: 500
          example: string
        voidDate:
          type: string
          format: date
          readOnly: true
          example: '2024-05-02'
        user:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        voidReason: OTHER
        voidNote: string
        user:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        voidDate: '2024-05-02'
    PatientProcedureV1:
      allOf:
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - practiceProcedure
            - renderingProvider
            - amount
            - state
            - status
            - patient
            - location
            - billToInsurance
          properties:
            id:
              type: integer
              format: int64
              readOnly: true
            unlock:
              type: boolean
              readOnly: true
              example: true
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
            amount:
              type: number
              format: float
              example: 123.56
            entryDate:
              type: string
              format: date
              example: '2021-09-29T00:00:00.000Z'
            serviceDate:
              type: string
              format: date
              example: '2021-09-29T00:00:00.000Z'
            startDate:
              type: string
              format: date
              example: '2018-07-09T00:00:00.000Z'
            endDate:
              type: string
              format: date
              example: '2018-07-09T00:00:00.000Z'
            treatmentPlannedDate:
              type: string
              format: date
              example: '2018-07-09T00:00:00.000Z'
            expirationDate:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
            status:
              type: string
              enum:
                - COMPLETED
                - EXISTING
                - TREATMENT_PLAN
              example: COMPLETED
            oralCavity:
              type: string
              enum:
                - UPPER_LEFT
                - UPPER_RIGHT
                - LOWER_LEFT
                - LOWER_RIGHT
                - ARCH_MAXILLARY
                - ARCH_MANDI_BULAR
                - UPPER_LEFT_SEXTANT
                - UPPER_ANTERIOR_SEXTANT
                - UPPER_RIGHT_SEXTANT
                - LOWER_LEFT_SEXTANT
                - LOWER_ANTERIOR_SEXTANT
                - LOWER_RIGHT_SEXTANT
              example: UPPER_LEFT
            notes:
              type: string
              maxLength: 255
              exclusiveMaximum: false
              example: string
            state:
              type: string
              enum:
                - ACTIVE
                - CANCELLED
                - INVALIDATED
              example: ACTIVE
            primaryInsuranceEstimateOverride:
              type: number
              format: double
              example: 1.23456
            secondaryInsuranceEstimateOverride:
              type: number
              format: double
              example: 1.23456
            billToInsurance:
              type: boolean
              example: true
            autoCalculateEstimateEnabled:
              type: boolean
              description: Required if status field is COMPLETED
              example: true
            monthsRemaining:
              type: number
              format: int16
              example: 0
            procedureTeeth:
              type: array
              description: >-
                Required if treatmentArea of practiceProcedure is in [TOOTH,
                SURFACE, ROOT]
              items:
                type: object
                properties:
                  id:
                    type: string
                    example: abc123
                  procedureId:
                    type: integer
                    format: int64
                    example: 987654321
                  mesial:
                    type: boolean
                    example: true
                  incisal:
                    type: boolean
                    example: false
                  occlusal:
                    type: boolean
                    example: true
                  distal:
                    type: boolean
                    example: false
                  lingual:
                    type: boolean
                    example: true
                  facial:
                    type: boolean
                    example: true
                  buccal:
                    type: boolean
                    example: false
                  classFive:
                    type: boolean
                    example: true
                  toothId:
                    type: string
                    example: T123
                  incisalOcclusal:
                    type: boolean
                    example: false
                  facialBuccal:
                    type: boolean
                    example: true
            practiceProcedure:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            renderingProvider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            treatmentPlannedProvider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            insuranceClaims:
              type: array
              items:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
            patientConditions:
              type: array
              items:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
            perioExams:
              type: array
              items:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    PatientProcedureCalcV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
        isEditable:
          type: boolean
          example: true
        appointmentToBeDeleted:
          type: number
          example: 0
      example:
        id: 12445
        isEditable: true
    PatientProcedureApptV1:
      type: object
      properties:
        visit:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        appointment:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        visit:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        appointment:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
    PatientProcedureV2:
      allOf:
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - practiceProcedure
            - renderingProvider
            - amount
            - state
            - status
            - patient
            - location
            - billToInsurance
          properties:
            id:
              type: integer
              format: int64
              readOnly: true
            placeOfTreatment:
              type: string
              readOnly: true
              example: string
            unlock:
              type: boolean
              readOnly: true
              example: true
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
            amount:
              type: number
              format: float
              example: 123.56
            entryDate:
              type: string
              format: date
              example: '2021-09-29T00:00:00.000Z'
            serviceDate:
              type: string
              format: date
              example: '2021-09-29T00:00:00.000Z'
            startDate:
              type: string
              format: date
              example: '2018-07-09T00:00:00.000Z'
            endDate:
              type: string
              format: date
              example: '2018-07-09T00:00:00.000Z'
            treatmentPlannedDate:
              type: string
              format: date
              example: '2018-07-09T00:00:00.000Z'
            expirationDate:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
            status:
              type: string
              enum:
                - COMPLETED
                - EXISTING
                - TREATMENT_PLAN
              example: COMPLETED
            oralCavity:
              type: string
              enum:
                - UPPER_LEFT
                - UPPER_RIGHT
                - LOWER_LEFT
                - LOWER_RIGHT
                - ARCH_MAXILLARY
                - ARCH_MANDI_BULAR
                - UPPER_LEFT_SEXTANT
                - UPPER_ANTERIOR_SEXTANT
                - UPPER_RIGHT_SEXTANT
                - LOWER_LEFT_SEXTANT
                - LOWER_ANTERIOR_SEXTANT
                - LOWER_RIGHT_SEXTANT
              example: UPPER_LEFT
            notes:
              type: string
              maxLength: 255
              exclusiveMaximum: false
              example: string
            state:
              type: string
              enum:
                - ACTIVE
                - CANCELLED
                - INVALIDATED
              example: ACTIVE
            primaryInsuranceEstimateOverride:
              type: number
              format: double
              example: 1.23456
            secondaryInsuranceEstimateOverride:
              type: number
              format: double
              example: 1.23456
            billToInsurance:
              type: boolean
              example: true
            autoCalculateEstimateEnabled:
              type: boolean
              description: Required if status field is COMPLETED
              example: true
            monthsRemaining:
              type: number
              format: int16
              example: 0
            procedureTeeth:
              type: array
              description: >-
                Required if treatmentArea of practiceProcedure is in [TOOTH,
                SURFACE, ROOT]
              items:
                type: object
                properties:
                  id:
                    type: string
                    example: abc123
                  procedureId:
                    type: integer
                    format: int64
                    example: 987654321
                  mesial:
                    type: boolean
                    example: true
                  incisal:
                    type: boolean
                    example: false
                  occlusal:
                    type: boolean
                    example: true
                  distal:
                    type: boolean
                    example: false
                  lingual:
                    type: boolean
                    example: true
                  facial:
                    type: boolean
                    example: true
                  buccal:
                    type: boolean
                    example: false
                  classFive:
                    type: boolean
                    example: true
                  toothId:
                    type: string
                    example: T123
                  incisalOcclusal:
                    type: boolean
                    example: false
                  facialBuccal:
                    type: boolean
                    example: true
            practiceProcedure:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            renderingProvider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            treatmentPlannedProvider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            insuranceClaims:
              type: array
              items:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
            patientConditions:
              type: array
              items:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
            perioExams:
              type: array
              items:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            version:
              type: integer
              format: int32
              example: 0
            placementType:
              type: string
              enum:
                - INITIAL
                - REPLACEMENT
                - NOT_APPLICABLE
              example: INITAIL
            appliancePlacementDate:
              type: string
              format: date
              example: '2024-05-02T00:00:00.000Z'
            isReplacement:
              type: boolean
              example: true
            replacementDate:
              type: string
              format: date
              example: '2024-05-02T00:00:00.000Z'
            priorPlacementDateKnown:
              type: boolean
              example: true
            accidentType:
              type: string
              enum:
                - OCCUPATIONAL
                - AUTOMOTIVE
                - OTHER
              example: OCCUPATIONAL
            accidentDate:
              type: string
              format: date
              example: '2024-05-02T00:00:00.000Z'
            accidentState:
              type: string
              example: string
            reasonForReplacement:
              type: string
              example: string
            priorPlacementDate:
              type: string
              format: date
              example: '2024-05-02T00:00:00.000Z'
            orderedDate:
              type: string
              format: date
              example: '2024-05-02T00:00:00.000Z'
            forceSave:
              type: boolean
              example: true
            doNotDisplayWarning:
              type: boolean
              example: true
      example: {}
    TxCaseUpdateV1:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 50
        status:
          type: string
          enum:
            - NEW
            - PRESENTED
            - ACCEPTED
            - REJECTED
          example: NEW
        note:
          type: string
          maxLength: 250
        expirationDate:
          type: string
          format: date
          example: '2024-05-10T00:00:00.000Z'
        showExpirationDate:
          type: boolean
          example: true
        showNote:
          type: boolean
          example: true
        providerSignature:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        witnessSignature:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        providerSignatureDate:
          type: string
          format: date
          example: '2024-05-10T00:00:00.000Z'
        witnessSignatureDate:
          type: string
          format: date
          example: '2024-05-10T00:00:00.000Z'
      example:
        name: Example Name
        status: NEW
    TxCaseV1:
      allOf:
        - $ref: '#/components/schemas/TxCaseUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          properties:
            id:
              readOnly: true
              type: integer
              format: int64
              example: 324324
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
      example: {}
    TxCaseCalcV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 324324
        isCompleted:
          type: boolean
          example: true
      example:
        id: 324324
        isCompleted: true
    TxCaseAmountV1:
      type: object
      properties:
        caseAmount:
          type: number
          format: double
          example: 10000
        discount:
          type: number
          format: double
          example: 7500
        guarantorPortion:
          type: number
          format: double
          example: 2500
        visits:
          type: array
          items:
            type: object
            properties:
              visitId:
                type: integer
                format: int64
                example: 32432432
              code:
                type: string
              Th:
                type: string
              surface:
                type: string
              description:
                type: string
              provider:
                type: string
              amount:
                type: number
                format: double
                example: 1000
              discount:
                type: number
                format: double
                example: 500
              guarantorPortion:
                type: number
                format: double
                example: 500
      example:
        caseAmount: 10000
        discount: 7500
    VisitUpdateV1:
      type: object
      properties:
        duration:
          type: integer
          format: int32
          minimum: 0
          maximum: 240
          example: 240
        sequence:
          type: integer
          format: int32
          example: 0
        visitProceduresOrderType:
          type: string
          enum:
            - TEETH
            - CREATED
            - CODE
            - SURFACES
            - DESCRIPTION
            - PROVIDER
            - AMOUNT
            - CUSTOM
          example: TEETH
        descProceduresOrder:
          type: boolean
          example: true
        procedures:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
      example:
        duration: 240
        sequence: 0
    VisitV1:
      allOf:
        - $ref: '#/components/schemas/VisitUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - txCase
            - procedures
            - visitProceduresOrderType
            - descProceduresOrder
          properties:
            id:
              type: integer
              format: int64
              readOnly: true
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
            txCase:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    EventUpdateV1:
      type: object
      properties:
        title:
          type: string
          maxLength: 60
        description:
          type: string
          example: This is a detailed description of the event.
        start:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
        end:
          type: string
          format: date-time
          example: '2018-07-09T20:00:00.000Z'
        allDay:
          type: boolean
          example: true
        recurrenceType:
          type: string
          enum:
            - WEEKLY
            - MONTHLY
          example: WEEKLY
        recurrenceStart:
          type: string
          format: date
          example: '2018-07-09'
        recurrenceEnd:
          type: string
          format: date
          example: '2018-07-09'
        recurrenceFrequency:
          type: integer
          minimum: 1
          example: 1
        recurrenceDays:
          type: array
          items:
            type: string
            enum:
              - SUNDAY
              - MONDAY
              - TUESDAY
              - WEDNESDAY
              - THURSDAY
              - FRIDAY
              - SATURDAY
          example:
            - MONDAY
            - WEDNESDAY
            - FRIDAY
        recurrenceWeek:
          type: string
          enum:
            - FIRST
            - SECOND
            - THIRD
            - FOURTH
            - LAST
          example: FIRST
        recurrenceDay:
          type: string
          enum:
            - SUNDAY
            - MONDAY
            - TUESDAY
            - WEDNESDAY
            - THURSDAY
            - FRIDAY
            - SATURDAY
          example: MONDAY
        color:
          type: string
          pattern: ^[0-9A-Fa-f]{6}$
          maxLength: 6
          example: FF5733
          description: 'Hexadecimal color code (6 characters, without # prefix)'
      example:
        title: Example Title
        description: This is a detailed description of the event.
    EventV1:
      allOf:
        - $ref: '#/components/schemas/EventUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - start
            - location
            - title
          properties:
            id:
              type: integer
              format: int64
              example: 32424423
              readOnly: true
            duration:
              description: >-
                This is a field that returns the duration of the appointment in
                minutes.
              type: integer
              example: 30
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
            groupId:
              type: string
              maxLength: 50
              readOnly: true
            provider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            operatory:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            color:
              type: string
              pattern: ^[0-9A-Fa-f]{6}$
              maxLength: 6
              example: FF5733
              description: 'Hexadecimal color code (6 characters, without # prefix)'
      example: {}
    TransactionDistributionsBaseV1:
      type: array
      items:
        description: >-
          'chargeId' and 'appliedAmount' are only required if the distributions
          array is present in the request
        type: object
        required:
          - chargeId
          - appliedAmount
        properties:
          chargeId:
            type: string
            example: string
          chargeLocationId:
            type: string
            example: string
          appliedAmount:
            type: number
            format: double
            example: 150
          isActive:
            type: boolean
            readOnly: true
            example: true
      example:
        - chargeId: string
          appliedAmount: 150
          chargeLocationId: string
          isActive: true
    TransactionBaseV1:
      type: object
      description: >
        This Endpoint is being rate limited. More information can be found here:
        https://portal.hs1api.com/guide
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        type:
          type: string
          example: Transaction
          readOnly: true
        amount:
          type: number
          format: double
          example: 100
        distributions:
          allOf:
            - $ref: '#/components/schemas/TransactionDistributionsBaseV1'
        note:
          type: string
          maxLength: 255
          example: string
        transactionDate:
          type: string
          format: date
          example: '2018-07-09T00:00:00.000Z'
        entryDate:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
        modifiedDate:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
        isAutomaticallyPosted:
          type: boolean
          readOnly: true
          example: true
        isActive:
          type: boolean
          readOnly: true
          example: true
        previousTransaction:
          allOf:
            - type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
        replacedByTransaction:
          allOf:
            - type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example:
        id: 12445
        type: Transaction
    TransactionPatientPaymentBillingV1:
      type: object
      properties:
        type:
          type: string
          example: PatientPaymentBilling
          readOnly: true
        checkNumber:
          type: string
          maxLength: 20
          example: check number
        bankNumber:
          type: string
          maxLength: 20
          example: bank number
        referenceNumber:
          type: string
          maxLength: 20
          example: reference number
      example:
        type: PatientPaymentBilling
        checkNumber: check number
    TransactionFullV1:
      allOf:
        - $ref: '#/components/schemas/TransactionBaseV1'
        - type: object
          properties:
            transactionDateTime:
              type: string
              format: date-time
              example: '2018-07-09 19:00:00.000'
              readOnly: true
            ledgerType:
              type: string
              enum:
                - PatientChargeAdjustment
                - InsuranceRefundAdjustment
                - PatientCreditCardRefund
                - PatientCreditCardVoid
                - PatientProcedureLedger
                - InsurancePayment
                - PatientCreditAdjustment
                - PatientProcedurePayment
              example: PatientChargeAdjustment
              readOnly: true
            ownership:
              type: string
              enum:
                - PATIENT
                - GUARANTOR
              example: PATIENT
            isPartialPayment:
              type: boolean
              example: true
              readOnly: true
            metBasic:
              type: number
              format: double
              example: 1000
            metPreventive:
              type: number
              format: double
              example: 1000
            metMajor:
              type: number
              format: double
              example: 1000
            metOrtho:
              type: number
              format: double
              example: 1000
            patientPaymentBilling:
              allOf:
                - $ref: '#/components/schemas/TransactionPatientPaymentBillingV1'
            transactionTags:
              type: object
              properties:
                (orderIndex):
                  type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
            reasonTags:
              type: object
              properties:
                (orderIndex):
                  type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            organizationLedgerType:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            provider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            patientProcedure:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            onlineUser:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            insuranceClaim:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            insurancePayment:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            ledgerEstimation:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    TransactionPatientPaymentUpdateV1:
      allOf:
        - $ref: '#/components/schemas/TransactionBaseV1'
        - type: object
          properties:
            ledgerType:
              type: string
              enum:
                - PatientProcedurePayment
                - PatientProcedurePaymentRebill
                - PatientProcedurePaymentCancellation
              example: PatientProcedurePayment
              readOnly: true
            ownership:
              type: string
              enum:
                - PATIENT
                - GUARANTOR
              example: PATIENT
            paidAtVisit:
              type: boolean
              example: true
            patientPaymentBilling:
              allOf:
                - $ref: '#/components/schemas/TransactionPatientPaymentBillingV1'
            transactionTags:
              type: object
              properties:
                (orderIndex):
                  type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
            reasonTags:
              type: object
              properties:
                (orderIndex):
                  type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
      example: {}
    TransactionPatientPaymentV1:
      allOf:
        - $ref: '#/components/schemas/TransactionPatientPaymentUpdateV1'
        - type: object
          required:
            - ownership
            - patient
            - location
            - transactionDate
            - amount
            - organizationLedgerType
            - paidAtVisit
          properties:
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            organizationLedgerType:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    TransactionInsurancePaymentUpdateV1:
      allOf:
        - $ref: '#/components/schemas/TransactionBaseV1'
        - type: object
          properties:
            ledgerType:
              type: string
              enum:
                - InsurancePayment
                - InsurancePaymentRebill
                - InsurancePaymentCancellation
              readOnly: true
              example: InsurancePayment
            ownership:
              type: string
              enum:
                - PATIENT
              readOnly: true
              example: PATIENT
            metBasic:
              type: number
              format: double
              example: 100
            metPreventive:
              type: number
              format: double
              example: 100
            metMajor:
              type: number
              format: double
              example: 100
            metOrtho:
              type: number
              format: double
              example: 100
            distributions:
              allOf:
                - $ref: '#/components/schemas/TransactionDistributionsBaseV1'
                - type: array
                  items:
                    type: object
                    properties:
                      adjustment:
                        type: number
                        format: double
                        writeOnly: true
                        example: 100
            patientPaymentBilling:
              allOf:
                - $ref: '#/components/schemas/TransactionPatientPaymentBillingV1'
            transactionTags:
              type: object
              properties:
                (orderIndex):
                  type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
            reasonTags:
              type: object
              properties:
                (orderIndex):
                  type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
            isPartialPayment:
              type: boolean
      example: {}
    TransactionInsurancePaymentV1:
      allOf:
        - $ref: '#/components/schemas/TransactionInsurancePaymentUpdateV1'
        - type: object
          required:
            - patient
            - location
            - transactionDate
            - amount
            - organizationLedgerType
            - insuranceClaim
            - isPartialPayment
            - metBasic
            - metPreventive
            - metMajor
            - metOrtho
            - distributions
          properties:
            distributions:
              allOf:
                - $ref: '#/components/schemas/TransactionDistributionsBaseV1'
                - type: array
                  items:
                    type: object
                    properties:
                      allowedAmount:
                        type: number
                        format: double
                        writeOnly: true
                        example: 50
                      adjustment:
                        type: number
                        format: double
                        writeOnly: true
                        example: 25
                      insuranceEstimate:
                        type: number
                        format: double
                        writeOnly: true
                        example: 75
            insuranceAdjustment:
              type: object
              properties:
                adjustmentVariant:
                  type: string
                  enum:
                    - NONE
                    - CHARGE
                    - CREDIT
                  example: CREDIT
                organizationLedgerTypeId:
                  type: number
                  format: int64
                adjustmentAmount:
                  type: number
                  format: double
                  example: 50
              writeOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            organizationLedgerType:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            insuranceClaim:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            bulkInsurancePayment:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    TransactionProcedureV1:
      allOf:
        - $ref: '#/components/schemas/TransactionBaseV1'
        - type: object
          properties:
            ownership:
              type: string
              enum:
                - PATIENT
              example: PATIENT
              readOnly: true
            ledgerType:
              type: string
              example: PatientProcedureLedger
              readOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            organizationLedgerType:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            provider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            patientProcedure:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            ledgerEstimation:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    TransactionAdjustmentUpdateV1:
      allOf:
        - $ref: '#/components/schemas/TransactionBaseV1'
        - type: object
          properties:
            ledgerType:
              type: string
              enum:
                - PatientChargeAdjustment
                - PatientCreditAdjustment
              readOnly: true
              example: PatientChargeAdjustment
            ownership:
              type: string
              enum:
                - PATIENT
                - GUARANTOR
              example: PATIENT
            transactionTags:
              type: object
              properties:
                (orderIndex):
                  type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
            reasonTags:
              type: object
              properties:
                (orderIndex):
                  type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
            provider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            patientProcedure:
              allOf:
                - type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
                - type: object
                  readOnly: true
            insuranceClaim:
              allOf:
                - type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
                - type: object
                  readOnly: true
            insurancePayment:
              allOf:
                - type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
                - type: object
                  readOnly: true
            patientPaymentTransaction:
              allOf:
                - type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
                - type: object
                  readOnly: true
      example: {}
    TransactionAdjustmentV1:
      allOf:
        - $ref: '#/components/schemas/TransactionAdjustmentUpdateV1'
        - type: object
          required:
            - ownership
            - patient
            - location
            - transactionDate
            - amount
            - organizationLedgerType
            - ledgerType
          properties:
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            organizationLedgerType:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    TotalCountV1:
      type: object
      properties:
        TotalCountV1:
          type: number
      example:
        TotalCountV1: 10
    GlobalProcedureV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 324242
        adaCode:
          type: string
          maxLength: 10
        description:
          type: string
          maxLength: 255
        abbreviatedDescription:
          type: string
          maxLength: 255
          example: abbreviated description
        category:
          type: string
          enum:
            - DIAGNOSTIC
            - PREVENTIVE
            - RESTORATIVE
            - ENDODONTICS
            - PERIODONTICS
            - PROSTHREMOV
            - MAXILLOPROSTH
            - IMPLANTSERV
            - PROSTHOFIXED
            - ORALSURGERY
            - ORTHODONTICS
            - ADJUNCTSERV
            - MULTICODES
            - PRODUCTS
            - SLEEPAPNEASERV
          example: PREVENTIVE
        treatmentArea:
          type: string
          enum:
            - TOOTH
            - MOUTH
            - SURFACE
            - QUADRANT
            - ROOT
            - MULTICODES
            - ARCH
          example: TOOTH
        codeExtension:
          type: string
          example: code extension
        hasProthesis:
          type: boolean
          example: true
      example:
        id: 324242
        adaCode: ERR101
    GlobalInsuranceCarrierV1:
      type: object
      description: >
        This Endpoint is being rate limited. More information can be found here:
        https://portal.hs1api.com/guide
      properties:
        id:
          type: integer
          format: int64
          example: 8797768
        name:
          type: string
        payorId:
          type: string
          example: '2344'
        url:
          type: string
          example: example.com
        address1:
          type: string
          example: 123 example st
        address2:
          type: string
          example: 456 example st
        city:
          type: string
        state:
          type: string
        postalCode:
          type: string
          example: '21323'
        phonePrimary:
          type: string
          example: '1236540987'
        phonePrimaryExt:
          type: string
          example: '3248764343'
        phoneFax:
          type: string
          example: '1349872323'
        neaPayorId:
          type: string
          example: '432'
        acceptElectronicAttachments:
          type: boolean
          example: true
        acceptEligibilities:
          type: boolean
          example: true
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
      example:
        id: 8797768
        name: Example Name
    InsuranceCarrierUpdateV1:
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 127
          description: >-
            Required when creating a new insurance carrier not based on a Global
            Insurance Carrier
        phonePrimary:
          type: string
          maxLength: 10
          example: 1233214545
        phonePrimaryExt:
          type: string
          maxLength: 10
          example: 4566543232
        phoneFax:
          type: string
          maxLength: 10
          example: 9877896565
        url:
          type: string
          maxLength: 255
          example: example.com
        payorId:
          type: string
          maxLength: 30
          example: '233'
        acceptElectronicAttachments:
          type: boolean
          example: true
        acceptEligibilities:
          type: boolean
          example: true
        adaReportType:
          type: string
          enum:
            - ADA2012
            - ADA2019
          example: ADA2012
      example:
        name: Example Name
        phonePrimary: 1233214545
    InsuranceCarrierV1:
      allOf:
        - $ref: '#/components/schemas/InsuranceCarrierUpdateV1'
        - type: object
          properties:
            id:
              type: integer
              format: int64
              example: 324325
              readOnly: true
            globalInsuranceCarrier:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type and url
                at which the model can be accessed.
              properties:
                id:
                  type: integer
                  format: int64
                  description: >-
                    Required when creating a new insurance carrier based on a
                    Global Insurance Carrier
                  example: 324325
                type:
                  type: string
                url:
                  type: string
                  format: uri
                  example: example.com
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
      example: {}
    AuditV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
        date:
          type: string
          format: date-time
          example: '2024-05-09T12:00:00.000Z'
        description:
          type: string
        additionalInfo:
          type: string
          example: additional info
        auditType:
          type: string
          enum:
            - USER_ROLES
            - REPORT
            - PATIENT
            - LEDGER
            - RECARE
            - CONDITION
            - PERIO_EXAM
            - PRESCRIPTION
            - APPOINTMENT
            - INSURANCE_CLAIM
            - USER_ACCOUNT
            - TX_PLAN_CASE
            - CLINICAL_NOTE
            - MEDICAL_ALERTS
            - LOCATION_INFORMATION
            - IMAGING
            - ORGANIZATION_INFORMATION
            - MISSED_APPOINTMENT
            - SETTINGS
            - PATIENT_NOTE
          example: PATIENT
        action:
          type: string
          enum:
            - UPDATE
            - DELETE
            - CREATE
            - REVIEW
            - PRINT
            - VOID
            - OVERRIDE
          example: UPDATE
        location:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        onlineUser:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        patient:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        id: 12445
        date: '2024-05-09T12:00:00.000Z'
    LocationHourUpdateV1:
      type: object
      properties:
        startTime:
          type: string
          format: time
          example: '13:00'
        endTime:
          type: string
          format: time
          example: '15:00'
        days:
          type: array
          items:
            type: string
            enum:
              - SUNDAY
              - MONDAY
              - TUESDAY
              - WEDNESDAY
              - THURSDAY
              - FRIDAY
              - SATURDAY
          default:
            - MONDAY
            - TUESDAY
            - WEDNESDAY
            - THURSDAY
            - FRIDAY
          example:
            - MONDAY
            - WEDNESDAY
            - FRIDAY
          description: >-
            If the days array isn't present or is empty it will default to
            ['MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY'].
      example:
        startTime: '13:00'
        endTime: '15:00'
    LocationHourV1:
      allOf:
        - $ref: '#/components/schemas/LocationHourUpdateV1'
        - type: object
          required:
            - startTime
            - endTime
            - location
          properties:
            id:
              type: integer
              format: int64
              example: 108756
              readOnly: true
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    MissedAppointmentUpdateV1:
      type: object
      properties:
        cancelledOn:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
        reasonCancelled:
          type: string
          maxLength: 200
          example: reason cancelled
        rescheduledOn:
          type: string
          format: date-time
          example: '2018-08-09T19:00:00.000Z'
        note:
          type: string
      example:
        cancelledOn: '2018-07-09T19:00:00.000Z'
        reasonCancelled: reason cancelled
    MissedAppointmentV1:
      allOf:
        - $ref: '#/components/schemas/MissedAppointmentUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - start
            - duration
            - status
            - patient
            - provider
            - location
            - operatory
          properties:
            id:
              type: integer
              format: int64
              example: 108756
              readOnly: true
            start:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
            duration:
              type: integer
              format: int32
              example: 60
            status:
              type: string
              enum:
                - NO_SHOW
                - BROKEN
              example: NO_SHOW
            other:
              type: string
            procedures:
              type: string
            appointment:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            provider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            operatory:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    AgingBalanceV1:
      type: object
      description: >
        This Endpoint is being rate limited. More information can be found here:
        https://portal.hs1api.com/guide
      properties:
        current:
          type: number
          format: double
          description: 0-30 days balance
        currentInsurancePortion:
          type: number
          format: double
          description: 0-30 days Insurance Portion balance
          example: 100
        currentPatientPortion:
          type: number
          format: double
          description: 0-30 days Patient Portion balance
          example: 25
        currentWriteOff:
          type: number
          format: double
          description: 0-30 days Write Off balance
          example: 125
        thirtyDays:
          type: number
          format: double
          description: 31-60 days balance
          example: 125
        thirtyDaysInsurancePortion:
          type: number
          format: double
          description: 31-60 days Insurance Portion balance
          example: 100
        thirtyDaysPatientPortion:
          type: number
          format: double
          description: 31-60 days Patient Portion balance
          example: 25
        thirtyDaysWriteOff:
          type: number
          format: double
          description: 31-60 days Write Off balance
          example: 125
        sixtyDays:
          type: number
          format: double
          description: 61-90 days balance
          example: 25
        sixtyDaysInsurancePortion:
          type: number
          format: double
          description: 61-90 days Insurance Portion balance
          example: 100
        sixtyDaysPatientPortion:
          type: number
          format: double
          description: 61-90 days Patient Portion balance
          example: 25
        sixtyDaysWriteOff:
          type: number
          format: double
          description: 61-90 days Write Off balance
          example: 125
        ninetyDays:
          type: number
          format: double
          description: 90+ days balance
          example: 125
        ninetyDaysInsurancePortion:
          type: number
          format: double
          description: 90+ days Insurance Portion balance
          example: 100
        ninetyDaysPatientPortion:
          type: number
          format: double
          description: 90+ days Patient Portion balance
          example: 25
        ninetyDaysWriteOff:
          type: number
          format: double
          description: 90+ days Write Off balance
          example: 125
        insurancePortion:
          type: number
          format: double
          description: Total insurance portion of the balance
          example: 100
        writeOffAdjustments:
          type: number
          format: double
          description: Total adjustments written off
          example: 50
        suspendedCredits:
          type: number
          format: double
          description: Credits suspended in the account
          example: 0
        pleasePayAmount:
          type: number
          format: double
          description: Amount the patient is requested to pay
          example: 25
        closeablePaymentPlanState:
          type: boolean
          description: Indicates if the payment plan can be closed
          example: true
        hasCoverageGap:
          type: boolean
          description: Indicates if there is a gap in coverage
          example: true
        balance:
          type: number
          format: double
          description: Total current balance
          example: 125
        patientPortion:
          type: number
          format: double
          description: Total patient portion of the balance
          example: 25
      example:
        current: 1
        currentInsurancePortion: 100
    AgingReceivableV1:
      type: object
      properties:
        firstName:
          type: string
          example: John
        middleInitial:
          type: string
          example: M
        lastName:
          type: string
          example: Doe
        id:
          type: integer
          format: int64
          example: 2134
        current:
          type: number
          format: double
          description: 0-30 days balance
          example: 125
        currentPortion:
          type: object
          description: Breakdown of the current balance into portions
          properties:
            guarantorPortion:
              type: number
              format: double
              example: 25
            insurancePortion:
              type: number
              format: double
              example: 190
            writeOff:
              type: number
              format: double
              example: 215
        thirtyDays:
          type: number
          format: double
          description: 31-60 days balance
          example: 215
        thirtyDaysPortion:
          type: object
          description: Breakdown of the thirty days balance into portions
          properties:
            guarantorPortion:
              type: number
              format: double
              example: 25
            insurancePortion:
              type: number
              format: double
              example: 190
            writeOff:
              type: number
              format: double
              example: 215
        sixtyDays:
          type: number
          format: double
          description: 61-90 days balance
          example: 215
        sixtyDaysPortion:
          type: object
          description: Breakdown of the sixty days balance into portions
          properties:
            guarantorPortion:
              type: number
              format: double
              example: 25
            insurancePortion:
              type: number
              format: double
              example: 190
            writeOff:
              type: number
              format: double
              example: 215
        ninetyDays:
          type: number
          format: double
          description: 90+ days balance
          example: 215
        ninetyDaysPortion:
          type: object
          description: Breakdown of the ninety days balance into portions
          properties:
            guarantorPortion:
              type: number
              format: double
              example: 25
            insurancePortion:
              type: number
              format: double
              example: 190
            writeOff:
              type: number
              format: double
              example: 215
        balance:
          type: number
          format: double
          example: 215
        guarantorPortionBalance:
          type: number
          format: double
          example: 25
        insurancePortionBalance:
          type: number
          format: double
          example: 190
        writeOffBalance:
          type: number
          format: double
          example: 215
        unAppliedCredits:
          type: number
          format: double
          example: 0
        claimsPending:
          type: number
          format: double
          example: 1
      example:
        firstName: John
        middleInitial: M
    AgingBalanceReportV1:
      type: object
      properties:
        currentAmount:
          type: number
          format: double
          description: 0-30 days balance
          example: 215
        currentPortion:
          type: object
          description: Current balance broken into portions
          properties:
            guarantorPortion:
              type: number
              format: double
              example: 25
            insurancePortion:
              type: number
              format: double
              example: 190
            writeOff:
              type: number
              format: double
              example: 215
        thirtyDaysAmount:
          type: number
          format: double
          description: 31-60 days balance
          example: 215
        thirtyDaysPortion:
          type: object
          description: Thirty days balance broken into portions
          properties:
            guarantorPortion:
              type: number
              format: double
              example: 25
            insurancePortion:
              type: number
              format: double
              example: 190
            writeOff:
              type: number
              format: double
              example: 215
        sixtyDaysAmount:
          type: number
          format: double
          description: 61-90 days balance
          example: 215
        sixtyDaysPortion:
          type: object
          description: Sixty days balance broken into portions
          properties:
            guarantorPortion:
              type: number
              format: double
              example: 25
            insurancePortion:
              type: number
              format: double
              example: 190
            writeOff:
              type: number
              format: double
              example: 215
        ninetyDaysAmount:
          type: number
          format: double
          description: 90+ days balance
          example: 215
        ninetyDaysPortion:
          type: object
          description: Ninety days balance broken into portions
          properties:
            guarantorPortion:
              type: number
              format: double
              example: 25
            insurancePortion:
              type: number
              format: double
              example: 190
            writeOff:
              type: number
              format: double
              example: 215
        total:
          type: number
          format: double
          description: Aging total
          example: 215
        totalPortions:
          type: object
          description: Total balance broken into portions
          properties:
            guarantorPortion:
              type: number
              format: double
              example: 25
            insurancePortion:
              type: number
              format: double
              example: 190
            writeOff:
              type: number
              format: double
              example: 215
        unappliedCreditsAmount:
          type: number
          format: double
          description: Amount of credits not yet applied
          example: 0
        balance:
          type: number
          format: double
          description: Total and unapplied credit combined
          example: 215
        patientReports:
          type: array
          items:
            $ref: '#/components/schemas/AgingReceivableV1'
      example:
        currentAmount: 215
        currentPortion:
          guarantorPortion: 25
          insurancePortion: 190
    PatientRecareUpdateV1:
      type: object
      properties:
        dueDate:
          type: string
          format: date
          example: '2024-05-02T00:00:00.000Z'
        intervalUnit:
          type: string
          enum:
            - WEEK
            - MONTH
            - YEAR
          example: WEEK
        interval:
          type: integer
          format: int64
          minimum: 1
          maximum: 99
          example: 99
        note:
          type: string
          example: string
      example:
        dueDate: '2024-05-02T00:00:00.000Z'
        intervalUnit: WEEK
    PatientRecareV1:
      allOf:
        - $ref: '#/components/schemas/PatientRecareUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - dueDate
            - patient
            - recareTemplate
            - intervalUnit
            - interval
            - location
          properties:
            id:
              type: integer
              format: int64
              readOnly: true
            serviceDate:
              type: string
              format: date
              example: '2024-05-02T00:00:00.000Z'
            postedDate:
              type: string
              format: date
              example: '2024-05-02T00:00:00.000Z'
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
            status:
              type: string
              enum:
                - ADDED
                - WRONG
                - UPDATED
              readOnly: true
              example: UPDATED
            note:
              type: string
              example: string
            scheduledAppointment:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            recareTemplate:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            user:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            practiceProcedures:
              type: array
              items:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
      example: {}
    PatientStatementV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
          example: 108706
        totalBalance:
          type: number
          format: double
          example: 1000
        patientPortion:
          type: number
          format: double
          example: 200
        pleasePay:
          type: number
          format: double
          example: 200
        generatedDate:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
        statementType:
          type: string
          enum:
            - GUARANTOR
            - PATIENT
          example: PATIENT
        deliveryMethod:
          type: string
          enum:
            - PRINT
            - ELECTRONIC
            - PRINT_ELECTRONIC
            - THIRD_PARTY
            - MAIL_FOR_ME
          example: ELECTRONIC
        patient:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        location:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        document:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        lastModified:
          type: string
          format: date-time
          readOnly: true
          example: '2018-07-09T19:00:00.000Z'
      example:
        id: 108706
        totalBalance: 1000
    RecareTemplateUpdateV1:
      type: object
      properties:
        recareType:
          type: string
          minLength: 1
          maxLength: 12
          example: recare type
        description:
          type: string
          maxLength: 30
        isPrimary:
          type: boolean
          example: true
        intervalUnit:
          type: string
          enum:
            - WEEK
            - MONTH
            - YEAR
          example: WEEK
        interval:
          type: integer
          format: int64
          minimum: 1
          maximum: 99
          example: 99
        practiceProcedures:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
      example:
        recareType: recare type
        description: Example description for description
    RecareTemplateV1:
      allOf:
        - $ref: '#/components/schemas/RecareTemplateUpdateV1'
        - type: object
          required:
            - intervalUnit
            - interval
            - recareType
            - isPrimary
          properties:
            id:
              type: integer
              format: int64
              example: 32324
              readOnly: true
            isDefault:
              type: boolean
              example: true
              readOnly: true
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
      example: {}
    PatientNoteUpdateV1:
      type: object
      properties:
        text:
          type: string
          minLength: 1
          maxLength: 5000
        noteDate:
          type: string
          format: date
          example: '2024-05-10T00:00:00.000Z'
      example:
        text: text
        noteDate: '2024-05-10T00:00:00.000Z'
    PatientNoteV1:
      allOf:
        - $ref: '#/components/schemas/PatientNoteUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - noteDate
            - text
            - patient
          properties:
            id:
              type: integer
              format: int64
              example: 71307
              readOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            lastModified:
              type: string
              format: date-time
              readOnly: true
              example: '2018-07-09T19:00:00.000Z'
      example: {}
    TransactionTagUpdateV1:
      type: object
      properties:
        tagText:
          type: string
          minLength: 1
          maxLength: 30
          example: tag text
        isPredefined:
          type: boolean
          example: true
        tagType:
          type: string
          enum:
            - PAYMENT_TAG
            - ADJUSTMENT_TAG
          example: PAYMENT_TAG
      example:
        tagText: tag text
        isPredefined: true
    TransactionTagV1:
      allOf:
        - $ref: '#/components/schemas/TransactionTagUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - tagText
            - isPredefined
            - tagType
          properties:
            id:
              type: integer
              format: int64
              example: 32432423
              readOnly: true
      example: {}
    MedicalAlertUpdateV1:
      type: object
      properties:
        description:
          type: string
          minLength: 1
          maxLength: 60
        visible:
          type: boolean
          example: true
        active:
          type: boolean
          example: true
        effectiveDate:
          type: string
          format: date
          example: '2024-05-10T00:00:00.000Z'
        permanentCondition:
          type: boolean
          example: true
        snomedCode:
          type: string
          minLength: 1
          maxLength: 10
          example: SNOMEDCode
        category:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        description: Example description for description
        visible: true
    MedicalAlertV1:
      allOf:
        - $ref: '#/components/schemas/MedicalAlertUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - description
            - active
            - permanentCondition
          properties:
            id:
              type: integer
              format: int64
              example: 6960404
              readOnly: true
            lastModified:
              type: string
              format: date-time
              readOnly: true
              example: '2018-07-09T19:00:00.000Z'
      example: {}
    MedicalAlertCategoryV1:
      type: object
      description: >
        This Endpoint is being rate limited. More information can be found here:
        https://portal.hs1api.com/guide
      required:
        - description
        - isCustom
        - active
      properties:
        id:
          type: integer
          format: int64
          example: 234324
        description:
          type: string
          minLength: 1
          maxLength: 60
        isCustom:
          type: boolean
          example: true
        active:
          type: boolean
          example: true
        effectiveDate:
          type: string
          format: date
          example: '2024-05-10T00:00:00.000Z'
        lastModified:
          type: string
          format: date-time
          readOnly: true
          example: '2024-05-09T13:30:00.000Z'
      example:
        description: Example description for description
        isCustom: true
        active: true
        id: 234324
        effectiveDate: '2024-05-10T00:00:00.000Z'
    MedicalAlertReactionV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 324234
        name:
          type: string
          minLength: 1
          maxLength: 25
        description:
          type: string
          minLength: 1
          maxLength: 25
        SNOMEDCode:
          type: string
          maxLength: 10
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
      example:
        id: 324234
        name: Example Name
    MedicalAlertSeverityV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 324324
        name:
          type: string
          minLength: 1
          maxLength: 25
        description:
          type: string
          minLength: 1
          maxLength: 25
        SNOMEDCode:
          type: string
          maxLength: 10
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
      example:
        id: 324324
        name: Example Name
    PatientMedicalAlertUpdateV1:
      type: object
      properties:
        visible:
          type: boolean
          example: true
        effectiveDate:
          type: string
          format: date
          example: '2024-05-10T00:00:00.000Z'
          readOnly: true
        expiredDate:
          type: string
          format: date
          example: '2024-05-10T00:00:00.000Z'
        permanentCondition:
          type: boolean
          example: true
        note:
          type: string
        reactionSeverities:
          type: array
          items:
            type: object
            properties:
              medicalAlertReaction:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
              medicalAlertSeverity:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
      example:
        visible: true
        effectiveDate: '2024-05-10T00:00:00.000Z'
    PatientMedicalAlertV1:
      allOf:
        - $ref: '#/components/schemas/PatientMedicalAlertUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - effectiveDate
            - medicalAlert
            - patient
            - permanentCondition
          properties:
            id:
              type: integer
              format: int64
              example: 34324234
              readOnly: true
            medicalAlert:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            lastModified:
              type: string
              format: date-time
              readOnly: true
              example: '2018-07-09T19:00:00.000Z'
      example: {}
    ToothV1:
      type: object
      properties:
        id:
          type: string
          example: 108756
        dentalAnatomy:
          type: string
          example: dental anatomy
        toothType:
          type: string
          enum:
            - PERMANENT
            - PRIMARY
            - SUPERNUMERARY_PERMANENT
            - SUPERNUMERARY_PRIMARY
          example: PRIMARY
        toothIndex:
          type: integer
          format: int32
          example: 2
        isMixed:
          type: string
          example: ismixed
        universalCode:
          type: string
          example: universal code
        fdiCode:
          type: string
          example: fdi code
        palmerCode:
          type: string
          example: palmer code
      example:
        id: 108756
        dentalAnatomy: dental anatomy
    PatientToothV1:
      type: object
      properties:
        toothId:
          type: string
          example: '16'
          readOnly: true
        toothIndex:
          type: integer
          format: int32
          minimum: 1
          maximum: 32
          example: 32
        toothType:
          type: string
          enum:
            - PERMANENT
            - PRIMARY
            - SUPERNUMERARY_PERMANENT
            - SUPERNUMERARY_PRIMARY
          example: PRIMARY
        visible:
          type: boolean
          example: true
          readOnly: true
        chartings:
          type: array
          readOnly: true
          items:
            type: object
            properties:
              symbol:
                type: string
              surface:
                type: string
              color:
                type: array
                items:
                  type: number
                  example: 2
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
      example:
        toothId: '16'
        toothIndex: 32
    PatientConditionUpdateV1:
      type: object
      properties:
        status:
          type: string
          enum:
            - ACTIVE
            - TREATED
          example: ACTIVE
        state:
          type: string
          enum:
            - ACTIVE
            - CANCELLED
            - INVALIDATED
          example: CANCELLED
        note:
          type: string
          minLength: 0
          maxLength: 255
        serviceDate:
          type: string
          format: date
          example: '2021-09-29'
        chartedDate:
          type: string
          format: date
          example: '2021-09-29'
        oralCavityType:
          type: string
          enum:
            - UL
            - UR
            - LL
            - LR
            - UA
            - LA
          example: UL
        conditionTooth:
          type: object
          required:
            - toothId
          properties:
            toothId:
              type: string
              example: '16'
            mesial:
              type: boolean
              example: true
            incisal:
              type: boolean
              example: true
            occlusal:
              type: boolean
              example: true
            distal:
              type: boolean
              example: true
            facial:
              type: boolean
              example: true
            buccal:
              type: boolean
              example: true
        provider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        chartedProvider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        organizationCondition:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        status: ACTIVE
        state: CANCELLED
    PatientConditionV1:
      allOf:
        - $ref: '#/components/schemas/PatientConditionUpdateV1'
        - type: object
          required:
            - status
            - state
            - patient
            - provider
            - organizationCondition
          properties:
            id:
              type: integer
              format: int64
              example: 108756
              readOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    PatientPrescriptionV1:
      type: object
      description: >
        This Endpoint is being rate limited. More information can be found here:
        https://portal.hs1api.com/guide
      required:
        - dispense
        - drug
        - drugCategoryName
        - drugUnit
        - sig
        - patient
        - provider
        - consumingType
        - custom
        - refills
        - controlledSubstance
      properties:
        id:
          type: integer
          format: int64
          example: 32432
          readOnly: true
        datePrescribed:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
        drugCategoryName:
          type: string
          minLength: 1
          maxLength: 50
          example: name
        drug:
          type: string
          minLength: 1
          maxLength: 70
        sig:
          type: string
          minLength: 1
          maxLength: 150
        refills:
          type: number
          minimum: 0
          maximum: 99
          example: 99
        dispense:
          type: string
          minLength: 0
          maxLength: 999999
          example: '999999'
        note:
          type: string
          maxLength: 1000
        drugUnit:
          type: string
          minLength: 1
          maxLength: 20
          example: 500 mg
        consumingType:
          type: string
          enum:
            - DISPENSE_AS_WRITTEN
            - GENERIC_SUBSTITUTION_PERMITTED
          example: DISPENSE_AS_WRITTEN
        custom:
          type: boolean
          example: true
        controlledSubstance:
          type: boolean
          example: true
        provider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        patient:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        voidStatus:
          type: object
          required:
            - user
            - voidReason
          properties:
            user:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            dateVoided:
              type: string
              format: date
              example: '2024-05-10T00:00:00.000Z'
              readOnly: true
            voidReason:
              type: string
              enum:
                - MISTAKE
                - OTHER
                - ALLERGIC_REACTION
                - OTHER_REACTION
                - INEFFECTIVE
                - MISTAKE_NOT_PRESCRIBED
              example: OTHER
            note:
              type: string
              maxLength: 250
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
      example:
        drugCategoryName: name
        drug: drug
        sig: sig
        refills: 99
        dispense: '999999'
        drugUnit: 500 mg
        consumingType: DISPENSE_AS_WRITTEN
        custom: true
        controlledSubstance: true
        provider:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        patient:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        id: 32432
        datePrescribed: '2018-07-09T19:00:00.000Z'
    PrescriptionDrugCategoryUpdateV1:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 50
      example:
        name: Example Name
    PrescriptionDrugCategoryV1:
      allOf:
        - $ref: '#/components/schemas/PrescriptionDrugCategoryUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - name
          properties:
            id:
              type: integer
              format: int64
              example: 108756
              readOnly: true
            lastModified:
              type: string
              format: date-time
              readOnly: true
              example: '2018-07-09T20:30:00.000Z'
      example: {}
    PrescriptionDrugUnitV1:
      type: object
      required:
        - name
      properties:
        id:
          type: integer
          format: int64
          example: 324
        name:
          type: string
          minLength: 1
          maxLength: 20
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
      example:
        name: Example Name
        id: 324
        lastModified: '2018-07-09T19:00:00.000Z'
    PrescriptionTemplateUpdateV1:
      type: object
      properties:
        drug:
          type: string
          minLength: 1
          maxLength: 70
        sig:
          type: string
          minLength: 1
          maxLength: 150
        refills:
          type: number
          minimum: 0
          maximum: 99
          example: 99
        dispense:
          type: number
          format: double
          minimum: 0
          maximum: 999999.99
          example: 999999.99
        note:
          type: string
          maxLength: 1000
        drugUnit:
          type: string
          minLength: 1
          maxLength: 20
          example: 250 mg
        consumingType:
          type: string
          enum:
            - DISPENSE_AS_WRITTEN
            - GENERIC_SUBSTITUTION_PERMITTED
          example: DISPENSE_AS_WRITTEN
        controlledSubstance:
          type: boolean
          example: true
        drugCategory:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        drug: drug
        sig: sig
    PrescriptionTemplateV1:
      allOf:
        - $ref: '#/components/schemas/PrescriptionTemplateUpdateV1'
        - type: object
          required:
            - dispense
            - drug
            - drugCategory
            - drugUnit
            - sig
            - consumingType
            - refills
            - controlledSubstance
          properties:
            id:
              type: integer
              format: int64
              example: 23424
              readOnly: true
            lastModified:
              type: string
              format: date-time
              readOnly: true
              example: '2018-07-09T20:30:00.000Z'
      example: {}
    SubscriberInsurancePlanV1:
      type: object
      description: >
        This Endpoint is being rate limited. More information can be found here:
        https://portal.hs1api.com/guide
      required:
        - releaseOfInformation
        - assignmentOfBenefits
        - carrierInsurancePlan
        - planSubscriberId
        - patient
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        releaseOfInformation:
          type: boolean
          example: true
        assignmentOfBenefits:
          type: boolean
          example: true
        planSubscriberId:
          type: string
          maxLength: 50
          example: string
        previous_benefitYear:
          type: integer
          format: int16
          example: 2024
        previous_basicFamilyAnnualDeductibleMet:
          type: number
          format: double
          example: 1500
        previous_preventiveFamilyAnnualDeductibleMet:
          type: number
          format: double
          example: 1500
        previous_majorFamilyAnnualDeductibleMet:
          type: number
          format: double
          example: 1500
        previous_maximumFamilyAnnualBenefitUsed:
          type: number
          format: double
          example: 1500
        current_benefitYear:
          type: integer
          format: int16
          example: 2024
        current_basicFamilyAnnualDeductibleMet:
          type: number
          format: double
          example: 1500
        current_preventiveFamilyAnnualDeductibleMet:
          type: number
          format: double
          example: 1500
        current_majorFamilyAnnualDeductibleMet:
          type: number
          format: double
          example: 1500
        current_maximumFamilyAnnualBenefitUsed:
          type: number
          format: double
          example: 1500
        carrierInsurancePlan:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        patient:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
      example:
        releaseOfInformation: true
        assignmentOfBenefits: true
        planSubscriberId: string
        carrierInsurancePlan:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        patient:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        id: 12445
        previous_benefitYear: 2024
    CarrierInsurancePlanUpdateV1:
      type: object
      properties:
        planName:
          type: string
          maxLength: 50
        renewalMonth:
          type: string
          enum:
            - January
            - February
            - March
            - April
            - May
            - June
            - July
            - August
            - September
            - October
            - November
            - December
          example: January
        sourceOfPayment:
          type: string
          enum:
            - BLUE_CROSS_BLUE_SHIELD
            - CHAMPUS
            - COMMERCIAL
            - MEDICARE_B
            - MEDICAID
          example: BLUE_CROSS_BLUE_SHIELD
        contactName:
          type: string
          maxLength: 127
          example: name
        contactEmail:
          type: string
          maxLength: 60
          example: email
        groupNumber:
          type: string
          maxLength: 30
          example: group number
        phone:
          type: string
          maxLength: 10
          example: 6353459876
        phoneExt:
          type: string
          maxLength: 10
          example: 1234567890
        planType:
          type: string
          enum:
            - DENTAL
            - MEDICAL
          example: DENTAL
        faxNumber:
          type: string
          maxLength: 10
          example: 987654321
        planNote:
          type: string
          maxLength: 5000
          example: notes
        address1:
          type: string
          maxLength: 50
          example: 123 example st
        address2:
          type: string
          maxLength: 50
          example: 456 example st
        city:
          type: string
          maxLength: 30
        postalCode:
          type: string
          minLength: 5
          maxLength: 10
          example: '67865'
        state:
          type: string
          enum:
            - AA
            - AE
            - AP
            - AL
            - AK
            - AS
            - AZ
            - AR
            - CA
            - CO
            - CNMI
            - CT
            - DE
            - DC
            - FM
            - FL
            - FSM
            - GA
            - GU
            - HI
            - ID
            - IL
            - IN
            - IA
            - KS
            - KY
            - LA
            - ME
            - MD
            - MH
            - MA
            - MI
            - MN
            - MS
            - MO
            - MT
            - NE
            - NV
            - NH
            - NJ
            - NM
            - NY
            - NC
            - ND
            - MP
            - OH
            - OK
            - OR
            - PW
            - PA
            - PR
            - RI
            - SC
            - SD
            - TN
            - TX
            - UT
            - VT
            - VI
            - VA
            - WA
            - WV
            - WI
            - WY
          example: AA
        locationPlans:
          type: object
          properties:
            (locationId):
              type: object
              properties:
                ppoFeeSchedule:
                  type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
      example:
        planName: Example Name
        renewalMonth: January
    CarrierInsurancePlanV1:
      allOf:
        - $ref: '#/components/schemas/CarrierInsurancePlanUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - planName
            - planType
            - renewalMonth
            - sourceOfPayment
            - insuranceCarrier
            - address1
            - city
            - postalCode
            - state
          properties:
            id:
              type: integer
              format: int64
              example: 34532
              readOnly: true
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
            insuranceCarrier:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            carrierPlanDeductible:
              type: object
              readOnly: true
              description: >-
                A reference to a linked model. Includes the id, the type and url
                at which the model can be accessed.
              properties:
                id:
                  type: integer
                  format: int64
                  example: 2134
                type:
                  type: string
                url:
                  type: string
                  format: uri
                  example: example.com/resource
      example: {}
    CarrierInsurPlanCoordinationOfBenefitsV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 3244246
        blue_cross_blue_shield:
          type: string
          enum:
            - TRADITIONAL
            - MAINTENANCE_OF_BENEFITS
            - CARVE_OUT
          example: TRADITIONAL
        champus:
          type: string
          enum:
            - TRADITIONAL
            - MAINTENANCE_OF_BENEFITS
            - CARVE_OUT
          example: TRADITIONAL
        commercial:
          type: string
          enum:
            - TRADITIONAL
            - MAINTENANCE_OF_BENEFITS
            - CARVE_OUT
          example: MAINTENANCE_OF_BENEFITS
        medicare_b:
          type: string
          enum:
            - TRADITIONAL
            - MAINTENANCE_OF_BENEFITS
            - CARVE_OUT
          example: CRAVE_OUT
        medicaid:
          type: string
          enum:
            - TRADITIONAL
            - MAINTENANCE_OF_BENEFITS
            - CARVE_OUT
          example: CRAVE_OUT
        commercial_ppo:
          type: string
          enum:
            - TRADITIONAL
            - MAINTENANCE_OF_BENEFITS
            - CARVE_OUT
          example: MAINTENCE_OF_BENFITS
        commercial_dhmo:
          type: string
          enum:
            - TRADITIONAL
            - MAINTENANCE_OF_BENEFITS
            - CARVE_OUT
          example: MAINTENANCE_OF_BENEFITS
        carrierInsurancePlan:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        id: 3244246
        blue_cross_blue_shield: TRADITIONAL
    PatientInsurancePlanUpdateV1:
      allOf:
        - $ref: '#/components/schemas/PatientInsurancePlanUpdateV1'
      type: object
      properties:
        startDate:
          type: string
          format: date
          example: '2024-05-10'
        endDate:
          type: string
          format: date
          example: '2024-05-11'
        relationshipToSubscriber:
          type: string
          enum:
            - SELF
            - SPOUSE
            - CHILD
            - OTHER
          example: SELF
        eligible:
          type: string
          maxLength: 10
        confirmedDate:
          type: string
          format: date
          example: '2024-05-10'
        note:
          type: string
          maxLength: 1000
        eligibilityCheckType:
          type: string
          enum:
            - MANUAL
            - AUTOMATIC
          example: AUTOMATIC
        responsibilities:
          type: array
          items:
            type: object
            properties:
              startDate:
                type: string
                format: date
                example: '2024-05-10'
              endDate:
                type: string
                format: date
                example: '2024-05-11'
              paymentResponsibilityOrder:
                type: integer
                format: int16
                example: 50
        benefitDetails:
          type: object
          properties:
            previous:
              type: object
              properties:
                benefitYear:
                  type: integer
                  format: int16
                  example: 2023
                basicIndividualLifetimeDeductibleMet:
                  type: number
                  format: double
                  example: 1500
                basicIndividualAnnualDeductibleMet:
                  type: number
                  format: double
                  example: 1500
                preventiveIndividualLifetimeDeductibleMet:
                  type: number
                  format: double
                  example: 1500
                preventiveIndividualAnnualDeductibleMet:
                  type: number
                  format: double
                  example: 1500
                majorIndividualLifetimeDeductibleMet:
                  type: number
                  format: double
                  example: 1500
                majorIndividualAnnualDeductibleMet:
                  type: number
                  format: double
                  example: 1500
                orthoIndividualLifetimeDeductibleMet:
                  type: number
                  format: double
                  example: 1500
                orthoIndividualAnnualDeductibleMet:
                  type: number
                  format: double
                  example: 1500
                maximumIndividualAnnualBenefitUsed:
                  type: number
                  format: double
                  example: 1500
                maximumOrthoLifetimeBenefitUsed:
                  type: number
                  format: double
                  example: 1500
            current:
              type: object
              properties:
                benefitYear:
                  type: integer
                  format: int16
                  example: 2024
                basicIndividualLifetimeDeductibleMet:
                  type: number
                  format: double
                  example: 1500
                basicIndividualAnnualDeductibleMet:
                  type: number
                  format: double
                  example: 1500
                preventiveIndividualLifetimeDeductibleMet:
                  type: number
                  format: double
                  example: 1500
                preventiveIndividualAnnualDeductibleMet:
                  type: number
                  format: double
                  example: 1500
                majorIndividualLifetimeDeductibleMet:
                  type: number
                  format: double
                  example: 1500
                majorIndividualAnnualDeductibleMet:
                  type: number
                  format: double
                  example: 1500
                orthoIndividualLifetimeDeductibleMet:
                  type: number
                  format: double
                  example: 1500
                orthoIndividualAnnualDeductibleMet:
                  type: number
                  format: double
                  example: 1500
                maximumIndividualAnnualBenefitUsed:
                  type: number
                  format: double
                  example: 1500
                maximumOrthoLifetimeBenefitUsed:
                  type: number
                  format: double
                  example: 1500
      example: {}
    PatientInsurancePlanV1:
      type: object
      description: >
        This Endpoint is being rate limited. More information can be found here:
        https://portal.hs1api.com/guide
      properties:
        id:
          type: integer
          format: int64
          example: 32432432
        startDate:
          type: string
          format: date
          example: '2024-05-10'
        endDate:
          type: string
          format: date
          example: '2024-05-11'
        relationshipToSubscriber:
          type: string
          enum:
            - SELF
            - SPOUSE
            - CHILD
            - OTHER
          example: SELF
        eligible:
          type: string
          maxLength: 10
          example: 'Yes'
        confirmedDate:
          type: string
          format: date
          example: '2024-05-10'
        note:
          type: string
          maxLength: 1000
          example: This is a detailed note about the eligibility status.
        eligibilityCheckType:
          type: string
          enum:
            - MANUAL
            - AUTOMATIC
          example: AUTOMATIC
        responsibilities:
          type: array
          items:
            type: object
            properties:
              startDate:
                type: string
                format: date
                example: '2024-05-10'
              endDate:
                type: string
                format: date
                example: '2024-05-11'
              paymentResponsibilityOrder:
                type: integer
                format: int16
                example: 1
        previous_benefitYear:
          type: integer
          format: int16
          example: 2023
        previous_basicIndividualLifetimeDeductibleMet:
          type: number
          format: double
          example: 1500
        current_benefitYear:
          type: integer
          format: int16
          example: 2024
        current_basicIndividualLifetimeDeductibleMet:
          type: number
          format: double
          example: 200
        subscriberInsurancePlan:
          type: object
          properties:
            id:
              type: string
              example: '1'
            type:
              type: string
              example: ModelExampleV1
            url:
              type: string
              example: example.com/resource
      example:
        id: 32432432
        startDate: '2024-05-10'
    OrganizationConditionUpdateV1:
      type: object
      properties:
        favorite:
          type: boolean
          example: true
        isActive:
          type: boolean
          example: true
        description:
          type: string
          minLength: 1
      example:
        favorite: true
        isActive: true
    OrganizationConditionV1:
      allOf:
        - $ref: '#/components/schemas/OrganizationConditionUpdateV1'
        - type: object
          properties:
            id:
              readOnly: true
              type: integer
              format: int64
              example: 108756
            condition:
              type: object
              readOnly: true
              properties:
                id:
                  type: integer
                  format: int64
                  example: 4535
                snomedCode:
                  type: string
                  maxLength: 20
                  example: SNOMEDCode
                snodent:
                  type: object
                  properties:
                    id:
                      type: integer
                      format: int64
                      example: 116386
                      readOnly: true
                    code:
                      type: string
                    description:
                      type: string
                abbreviatedDescription:
                  type: string
                  maxLength: 50
                  example: abbreviated description
                treatmentArea:
                  type: string
                  enum:
                    - TOOTH
                    - MOUTH
                    - SURFACE
                    - QUADRANT
                    - ROOT
                    - MULTICODES
                    - ARCH
                    - RANGE
                  example: MOUTH
                favorite:
                  type: boolean
                  example: true
                icd10:
                  type: object
                  properties:
                    id:
                      type: integer
                      format: int64
                      example: 108756
                      readOnly: true
                    code:
                      type: string
                    description:
                      type: string
                restriction:
                  type: object
                  properties:
                    id:
                      type: integer
                      format: int32
                      example: 2845
                    maxSelectedSurfacesCount:
                      type: integer
                      format: int32
                      example: 50
                    mesial:
                      type: boolean
                      example: true
                    incisal:
                      type: boolean
                      example: true
                    occlusal:
                      type: boolean
                      example: true
                    distal:
                      type: boolean
                      example: true
                    lingual:
                      type: boolean
                      example: true
                    facial:
                      type: boolean
                      example: true
                    buccal:
                      type: boolean
                      example: true
      example: {}
    GlobalProcedureMappingRuleV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 23424
        adaCodeSource:
          type: string
          minLength: 1
          maxLength: 255
        adaCodeTarget:
          type: string
          maxLength: 255
        mappingFlag:
          type: string
          enum:
            - SURFACE_ONE
            - SURFACE_TWO
            - SURFACE_THREE
            - SURFACE_FOUR
            - TOOTH_ANTERIOR
            - TOOTH_BICUSPID
            - TOOTH_MOLAR
            - DENTITION_PRIMARY
            - DENTITION_PERMANENT
            - POSITION_ANTERIOR
            - POSITION_POSTERIOR
            - ARCH_MAXILLARY
            - ARCH_MANDI_BULAR
            - PRIMARY
            - ADDITIONAL
            - SURFACE_FIVE
            - SURFACE_OCCLUSAL
            - INCISAL_ANGLE
          example: SURFACE_TWO
      example:
        id: 23424
        adaCodeSource: ERR101
    ProcedureCategoryV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 32432
        description:
          type: string
          maxLength: 50
        name:
          type: string
          maxLength: 50
        sequence:
          type: integer
          format: int32
          example: 123456
      example:
        id: 32432
        description: Example description for description
    DocumentUpdateV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1234
          readOnly: true
        name:
          type: string
          minLength: 1
          maxLength: 100
        tags:
          type: array
          items:
            type: string
            example: items
      example:
        id: 1234
        name: Example Name
    DocumentV1:
      allOf:
        - $ref: '#/components/schemas/DocumentUpdateV1'
        - type: object
          required:
            - name
            - mimeType
            - file
          properties:
            thumbNailId:
              type: string
              maxLength: 100
              example: thumbNailId Number
              readOnly: true
            mimeType:
              type: string
              enum:
                - PDF
                - JPEG
                - PNG
                - GIF
                - DOC
                - DOCX
                - PPT
                - PPTX
                - XLS
                - XLSX
                - MSG
                - HTML
              example: PDF
            guidName:
              type: string
              example: name
              readOnly: true
            ownerType:
              type: string
              enum:
                - Organization
                - PerioExam
                - Patient
              example: Organization
              readOnly: true
            storage:
              readOnly: true
              type: object
              properties:
                thumbnail:
                  type: string
                original:
                  type: string
                resized:
                  type: string
                cropped:
                  type: string
            userDefinedDate:
              type: string
              format: date
              example: '2021-09-29'
            ownerPatient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            ownerPerioExam:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            ownerOrganization:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            file:
              type: object
              writeOnly: true
              required:
                - content
              properties:
                content:
                  type: string
                  format: byte
                  maxLength: 10485760
                  example: U29tZSBiYXNlNjQgY29udGVudCBoZXJl
                fromX:
                  description: If mimeType in [JPEG, PNG, GIF] then field is required
                  type: integer
                  format: int32
                  example: 2048
                fromY:
                  description: If mimeType in [JPEG, PNG, GIF] then field is required
                  type: integer
                  format: int32
                  example: 2048
                width:
                  description: If mimeType in [JPEG, PNG, GIF] then field is required
                  type: integer
                  format: int32
                  example: 2048
                height:
                  description: If mimeType in [JPEG, PNG, GIF] then field is required
                  type: integer
                  format: int32
                  example: 2048
                ratio:
                  type: number
                  format: float
                  description: If mimeType in [JPEG, PNG, GIF] then field is required
                  example: 2048
      example: {}
    DocumentTagV1:
      type: object
      description: >
        This Endpoint is being rate limited. More information can be found here:
        https://portal.hs1api.com/guide
      required:
        - name
      properties:
        id:
          type: integer
          format: int64
          example: 9087823
        name:
          type: string
          minLength: 1
          maxLength: 50
        isDefault:
          type: boolean
          example: true
          readOnly: true
        lastModified:
          type: string
          format: date-time
          readOnly: true
          example: '2024-05-09T13:30:00.000Z'
      example:
        name: Example Name
        id: 9087823
        isDefault: true
    ClinicalNoteUpdate:
      type: object
      properties:
        datedAs:
          type: string
          format: date
          example: '2024-05-10T00:00:00.000Z'
        signedDate:
          type: string
          format: date
          example: '2024-05-10T00:00:00.000Z'
        signedAdditionalDate:
          type: string
          format: date
          example: '2024-05-10T00:00:00.000Z'
        text:
          type: string
          minLength: 1
        assignedTeeth:
          type: array
          items:
            type: object
            properties:
              toothId:
                type: string
                example: '16'
              isToothGrown:
                type: boolean
                example: true
        draftTemplateOptions:
          type: object
          properties:
            clinicalNoteTemplate:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            promptOptions:
              type: array
              items:
                type: object
                properties:
                  clinicalNotePrompt:
                    type: object
                    description: >-
                      A reference to a linked model. Includes the id, the type,
                      and URL at which the model can be accessed.
                    required:
                      - id
                      - url
                    properties:
                      id:
                        type: integer
                        format: int64
                        description: The unique identifier for the linked model.
                        example: 12345
                      type:
                        type: string
                        description: The type of the linked model. This field is read-only.
                        example: ExampleModelType
                        readOnly: true
                      url:
                        type: string
                        format: uri
                        description: >-
                          The URL at which the linked model can be accessed.
                          This field is read-only.
                        example: https://api.example.com/models/12345
                        readOnly: true
                  choice:
                    type: string
                    example: string
        addendums:
          type: array
          items:
            type: object
            required:
              - text
              - provider
            properties:
              id:
                type: integer
                format: int64
                readOnly: true
                example: '32423432'
              text:
                type: string
                minLength: 1
              posted:
                type: string
                format: date-time
                example: '2024-05-09T12:00:00.000Z'
                readOnly: true
              provider:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
        additionalProvider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        primarySignature:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        additionalSignature:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        datedAs: '2024-05-10T00:00:00.000Z'
        signedDate: '2024-05-10T00:00:00.000Z'
    ClinicalNote:
      allOf:
        - $ref: '#/components/schemas/ClinicalNoteUpdate'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - datedAs
            - text
            - patient
            - provider
          properties:
            id:
              type: integer
              format: int64
              example: '3242424'
              readOnly: true
            lastModified:
              type: string
              format: date-time
              example: '2019-09-09T19:00:00.000Z'
              readOnly: true
            provider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    ClinicalNoteUpdateV1:
      type: object
      properties:
        datedAs:
          type: string
          format: date
          example: '2020-04-09T00:00:00.000Z'
        signedDate:
          type: string
          format: date
          example: '2020-04-09T00:00:00.000Z'
        signedAdditionalDate:
          type: string
          format: date
          example: '2020-04-09T00:00:00.000Z'
        text:
          type: string
          minLength: 1
        assignedTeeth:
          type: array
          items:
            type: object
            properties:
              toothId:
                type: string
                example: '2'
              isToothGrown:
                type: boolean
                example: true
        draftTemplateOptions:
          type: object
          properties:
            clinicalNoteTemplate:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            promptOptions:
              type: array
              items:
                type: object
                properties:
                  clinicalNotePrompt:
                    type: object
                    description: >-
                      A reference to a linked model. Includes the id, the type,
                      and URL at which the model can be accessed.
                    required:
                      - id
                      - url
                    properties:
                      id:
                        type: integer
                        format: int64
                        description: The unique identifier for the linked model.
                        example: 12345
                      type:
                        type: string
                        description: The type of the linked model. This field is read-only.
                        example: ExampleModelType
                        readOnly: true
                      url:
                        type: string
                        format: uri
                        description: >-
                          The URL at which the linked model can be accessed.
                          This field is read-only.
                        example: https://api.example.com/models/12345
                        readOnly: true
                  choice:
                    type: string
                    example: string
        addendums:
          type: array
          items:
            type: object
            required:
              - text
              - provider
            properties:
              id:
                type: integer
                format: int64
                example: 3324234
                readOnly: true
              text:
                type: string
                minLength: 1
              posted:
                type: string
                format: date-time
                readOnly: true
                example: '2020-04-09T19:00:00.000Z'
              provider:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
        additionalProvider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        primarySignature:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        additionalSignature:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        datedAs: '2020-04-09T00:00:00.000Z'
        signedDate: '2020-04-09T00:00:00.000Z'
    ClinicalNoteV1:
      allOf:
        - $ref: '#/components/schemas/ClinicalNoteUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - datedAs
            - text
            - patient
            - provider
          properties:
            id:
              type: integer
              format: int64
              example: 657575
              readOnly: true
            lastModified:
              type: string
              format: date-time
              example: '2019-09-09T19:00:00.000Z'
              readOnly: true
            provider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    UserUpdateV1:
      type: object
      properties:
        email:
          type: string
          format: email
          maxLength: 60
          example: example@email.com
        firstName:
          type: string
          minLength: 1
          maxLength: 25
          example: first
        middleInitial:
          type: string
          maxLength: 1
          example: m
        lastName:
          type: string
          minLength: 1
          maxLength: 50
          example: last
        phone1:
          type: string
          minLength: 10
          maxLength: 10
          example: '3248765643'
        phone2:
          type: string
          minLength: 10
          maxLength: 10
          example: '2345675434'
        username:
          type: string
          minLength: 1
          maxLength: 60
        timeout:
          type: integer
          enum:
            - 10
            - 30
            - 60
            - 120
            - 240
            - 480
          example: 120
      example:
        email: example@email.com
        firstName: first
    UserV1:
      allOf:
        - $ref: '#/components/schemas/UserUpdateV1'
        - type: object
          required:
            - username
            - email
            - firstName
            - lastName
            - phone1
            - timeout
            - roles
            - currentLocation
          properties:
            id:
              type: string
              example: '324324'
              readOnly: true
            username:
              type: string
              minLength: 1
              maxLength: 60
            enabled:
              type: boolean
              example: true
            isProvider:
              type: boolean
              example: true
              readOnly: true
            roles:
              type: array
              items:
                type: object
                properties:
                  role:
                    type: string
                  location:
                    type: object
                    description: >-
                      A reference to a linked model. Includes the id, the type,
                      and URL at which the model can be accessed.
                    required:
                      - id
                      - url
                    properties:
                      id:
                        type: integer
                        format: int64
                        description: The unique identifier for the linked model.
                        example: 12345
                      type:
                        type: string
                        description: The type of the linked model. This field is read-only.
                        example: ExampleModelType
                        readOnly: true
                      url:
                        type: string
                        format: uri
                        description: >-
                          The URL at which the linked model can be accessed.
                          This field is read-only.
                        example: https://api.example.com/models/12345
                        readOnly: true
            currentLocation:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            lastModified:
              type: string
              format: date-time
              readOnly: true
              example: '2018-07-09T19:00:00.000Z'
      example: {}
    ClinicalNoteTemplateUserFavoriteV1:
      type: object
      required:
        - user
        - clinicalNoteTemplate
      properties:
        user:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        clinicalNoteTemplate:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        user:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        clinicalNoteTemplate:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
    OrganizationLedgerTypeV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 56435
        description:
          type: string
          maxLength: 255
        ledgerType:
          type: string
          enum:
            - PROCEDURE
            - CHARGE_ADJUSTMENT
            - CREDIT_ADJUSTMENT
            - PAYMENT
            - INSURANCE_PAYMENT
            - INSURANCE_CLAIM
          example: PROCEDURE
        constantDescription:
          type: string
          enum:
            - UNDEFINED
            - OFFSETTING_ADJUSTMENT
            - WRITEOFF_ADJUSTMENT
            - CREDIT_CARD_REFUND
            - CREDIT_CARD_PAYMENT
            - CREDIT_CARD_VOID
            - INSURANCE_CHECK_PAYMENT
            - INSURANCE_ELECTRONIC_PAYMENT
            - INSURANCE_CREDIT_CARD_PAYMENT
            - CHECK_PAYMENT
            - CASH_PAYMENT
            - DISCOUNT
            - INSURANCE_ADJUSTMENT
            - PATIENT_FINANCING_PAYMENT
            - ELECTRONIC_TRANSFER_PAYMENT
          example: DISCOUNT
        active:
          type: boolean
          example: true
        allocation:
          type: string
          enum:
            - COLLECTION
            - PRODUCTION
          example: COLLECTION
        isTagRestrictionEnabled:
          type: boolean
          example: true
        isTagCreationEnabled:
          type: boolean
          example: true
        optionalTags:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
        mandatoryTags:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
          example: 0
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
      example:
        id: 56435
        description: Example description for description
    CoverageProcedureRangeUpdateV1:
      type: object
      properties:
        rangeStart:
          type: string
          minLength: 1
          maxLength: 10
          example: string
        rangeStartExtension:
          type: string
          maxLength: 5
          example: string
        rangeEnd:
          type: string
          minLength: 1
          maxLength: 10
          example: string
        rangeEndExtension:
          type: string
          maxLength: 5
          example: string
        category:
          type: string
          minLength: 1
          maxLength: 255
          example: string
        coveragePercentage:
          type: number
          format: double
          example: 40
        deductibleType:
          type: string
          enum:
            - NONE
            - BASIC
            - PREVENTIVE
            - MAJOR
            - ORTHODONTIC
          example: BASIC
      example:
        rangeStart: string
        rangeStartExtension: string
    CoverageProcedureRangeV1:
      allOf:
        - $ref: '#/components/schemas/CoverageProcedureRangeUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - rangeStart
            - rangeEnd
            - category
            - coveragePercentage
            - deductibleType
          properties:
            id:
              type: integer
              format: int64
              example: 32490
              readOnly: true
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
            carrierInsurancePlan:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    CoverageProcedureRangeTemplateV1:
      type: object
      required:
        - rangeStart
        - rangeEnd
        - category
        - deductibleType
      properties:
        id:
          type: integer
          format: int64
          example: 768990
        rangeStart:
          type: string
          minLength: 5
          maxLength: 15
          example: string
        rangeEnd:
          type: string
          minLength: 5
          maxLength: 15
          example: string
        category:
          type: string
          minLength: 1
          maxLength: 60
          example: string
        coveragePercentage:
          type: number
          format: double
          example: 40
        deductibleType:
          type: string
          enum:
            - NONE
            - BASIC
            - PREVENTIVE
            - MAJOR
            - ORTHODONTIC
          example: NONE
      example:
        rangeStart: string
        rangeEnd: string
        category: string
        deductibleType: NONE
        id: 768990
        coveragePercentage: 40
    CoverageProcedureCopayUpdateV1:
      type: object
      properties:
        copay:
          type: number
          format: double
          maxLength: 10
          maximum: 9999999.99
          minimum: 0
          example: 9999999.99
        deductibleType:
          type: string
          enum:
            - NONE
            - BASIC
            - PREVENTIVE
            - MAJOR
            - ORTHODONTIC
          example: BASIC
      example:
        copay: 9999999.99
        deductibleType: BASIC
    CoverageProcedureCopayV1:
      allOf:
        - $ref: '#/components/schemas/CoverageProcedureCopayUpdateV1'
        - type: object
          required:
            - practiceProcedure
            - copay
            - deductibleType
            - carrierInsurancePlan
          properties:
            id:
              type: integer
              format: int64
              example: 376576
              readOnly: true
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
            carrierInsurancePlan:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            practiceProcedure:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    CarrierPlanDeductibleV1:
      type: object
      description: >
        This Endpoint is being rate limited. More information can be found here:
        https://portal.hs1api.com/guide
      required:
        - coverageType
        - noDuplicationOfBenefitsClause
      properties:
        id:
          type: integer
          format: int64
        coverageType:
          type: string
          enum:
            - PERCENTAGE
            - COPAY
          example: PERCENTAGE
        noDuplicationOfBenefitsClause:
          type: boolean
          example: true
        previous_benefitYear:
          type: integer
          format: int16
          example: 2023
        previous_basicIndividualLifetimeDeductible:
          type: number
          format: double
          example: 1000
        previous_basicIndividualAnnualDeductible:
          type: number
          format: double
          example: 2000
        previous_basicFamilyAnnualDeductible:
          type: number
          format: double
          example: 1000
        previous_preventiveIndividualLifetimeDeductible:
          type: number
          format: double
          example: 2500
        previous_preventiveIndividualAnnualDeductible:
          type: number
          format: double
          example: 2500
        previous_preventiveFamilyAnnualDeductible:
          type: number
          format: double
          example: 2500
        previous_majorIndividualLifetimeDeductible:
          type: number
          format: double
          example: 2500
        previous_majorIndividualAnnualDeductible:
          type: number
          format: double
          example: 2500
        previous_majorFamilyAnnualDeductible:
          type: number
          format: double
          example: 2500
        previous_orthoIndividualLifetimeDeductible:
          type: number
          format: double
          example: 2500
        previous_orthoIndividualAnnualDeductible:
          type: number
          format: double
          example: 2500
        previous_maximumIndividualAnnualBenefit:
          type: number
          format: double
          example: 2500
        previous_maximumFamilyAnnualBenefit:
          type: number
          format: double
          example: 2500
        previous_maximumOrthoLifetimeBenefit:
          type: number
          format: double
          example: 2500
        current_benefitYear:
          type: integer
          format: int16
          example: 2024
        current_basicIndividualLifetimeDeductible:
          type: number
          format: double
          example: 2500
        current_basicIndividualAnnualDeductible:
          type: number
          format: double
          example: 2500
        current_basicFamilyAnnualDeductible:
          type: number
          format: double
          example: 2500
        current_preventiveIndividualLifetimeDeductible:
          type: number
          format: double
          example: 2500
        current_preventiveIndividualAnnualDeductible:
          type: number
          format: double
          example: 2500
        current_preventiveFamilyAnnualDeductible:
          type: number
          format: double
          example: 2500
        current_majorIndividualLifetimeDeductible:
          type: number
          format: double
          example: 2500
        current_majorIndividualAnnualDeductible:
          type: number
          format: double
          example: 2500
        current_majorFamilyAnnualDeductible:
          type: number
          format: double
          example: 2500
        current_orthoIndividualLifetimeDeductible:
          type: number
          format: double
          example: 2500
        current_orthoIndividualAnnualDeductible:
          type: number
          format: double
          example: 2500
        current_maximumIndividualAnnualBenefit:
          type: number
          format: double
          example: 2500
        current_maximumFamilyAnnualBenefit:
          type: number
          format: double
          example: 2500
        current_maximumOrthoLifetimeBenefit:
          type: number
          format: double
          example: 2500
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
      example:
        coverageType: PERCENTAGE
        noDuplicationOfBenefitsClause: true
        id: 12445
        previous_benefitYear: 2023
    CarrierPlanCoverageExceptionV1:
      type: object
      description: >
        This Endpoint is being rate limited. More information can be found here:
        https://portal.hs1api.com/guide
      required:
        - exceptionProcedureCode
        - exceptionType
        - maxAgeLimit
        - minAgeLimit
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        deductibleType:
          type: string
          enum:
            - NONE
            - BASIC
            - PREVENTIVE
            - MAJOR
            - ORTHODONTIC
          example: BASIC
        reason:
          type: string
          maxLength: 255
          example: string
        coveragePercentage:
          type: number
          format: double
          example: 50
        maxAgeLimit:
          type: integer
          format: int32
          example: 0
        minAgeLimit:
          type: integer
          format: int32
          example: 0
        maxAgeUnlimited:
          type: boolean
          example: true
        exceptionType:
          type: string
          enum:
            - AGE_LIMIT
            - NON_COVERED
            - DOWNGRADE
            - FREQUENCY_LIMIT
          example: NON_COVERED
        frequencyLimitFields:
          type: object
          description: fields required with exceptionType of FREQUENCY_LIMIT
          properties:
            times:
              type: number
              format: int32
            amount:
              type: number
              format: int32
            chronoUnit:
              type: string
              enum:
                - DAYS
                - MONTHS
                - YEARS
              example: DAYS
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
        exceptionProcedureCode:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        downgradeProcedureCode:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        carrierInsurancePlan:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        maxAgeLimit: 0
        minAgeLimit: 0
        exceptionType: NON_COVERED
        exceptionProcedureCode:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        id: 12445
        deductibleType: BASIC
    CarrierPlanCopayExceptionUpdateV1:
      type: object
      properties:
        deductibleType:
          type: string
          enum:
            - NONE
            - BASIC
            - PREVENTIVE
            - MAJOR
            - ORTHODONTIC
          example: BASIC
        reason:
          type: string
          maxLength: 255
        copay:
          type: number
          format: double
          example: 50
        maxAgeLimit:
          type: integer
          format: int32
          example: 65
        minAgeLimit:
          type: integer
          format: int32
          example: 0
        maxAgeUnlimited:
          type: boolean
          example: false
        exceptionType:
          type: string
          enum:
            - AGE_LIMIT
            - NON_COVERED
            - DOWNGRADE
            - FREQUENCY_LIMIT
          example: AGE_LIMIT
        frequencyLimitFields:
          type: object
          description: fields required with exceptionType of FREQUENCY_LIMIT
          properties:
            times:
              type: number
              format: int32
              example: 60
            amount:
              type: number
              format: int32
              example: 5
            chronoUnit:
              type: string
              enum:
                - DAYS
                - MONTHS
                - YEARS
              example: DAYS
      example:
        deductibleType: BASIC
        reason: reason
    CarrierPlanCopayExceptionV1:
      allOf:
        - $ref: '#/components/schemas/CarrierPlanCopayExceptionUpdateV1'
        - type: object
          required:
            - carrierInsurancePlan
            - exceptionProcedureCode
            - exceptionType
          properties:
            id:
              type: integer
              format: int64
              readOnly: true
              example: 2432424
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
            exceptionProcedureCode:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            downgradeProcedureCode:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            carrierInsurancePlan:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    PerioExamUpdateV1:
      type: object
      properties:
        serviceDate:
          type: string
          format: date
          example: '2024-05-10'
        script:
          type: string
          enum:
            - FIRST
            - SECOND
            - THIRD
            - FOURTH
            - FIFTH
            - SIXTH
          example: FIRST
        finished:
          type: boolean
          example: true
        toothNavigationScript:
          type: string
          enum:
            - PD
            - GM
            - PD_GM
          example: PD
        lagging:
          type: integer
          format: int32
          example: 0
        hardPalate:
          type: boolean
          example: true
        skipOptions:
          type: array
          items:
            type: string
            enum:
              - CROWN
              - IMPACTED_DISTAL
              - IMPACTED_MESIAL
              - IMPLANT
              - IMPLANT_AND_CROWN
              - MISSING
              - PONTIC
              - UNERUPTED
            example:
              - CROWN
              - IMPLANT
              - IMPLANT_AND_CROWN
        voidStatus:
          type: object
          properties:
            id:
              type: integer
              format: int64
              example: 13596
              readOnly: true
            user:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            dateVoided:
              type: string
              format: date
              example: '2018-07-09'
            voidReason:
              type: string
              enum:
                - MISTAKE
                - OTHER
                - ALLERGIC_REACTION
                - OTHER_REACTION
                - INEFFECTIVE
                - MISTAKE_NOT_PRESCRIBED
              example: MISTAKE
            note:
              type: string
        examCopy:
          allOf:
            - type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
          readOnly: true
        lastEditedPerioProbe:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        serviceDate: '2024-05-10'
        script: FIRST
    PerioExamV1:
      allOf:
        - $ref: '#/components/schemas/PerioExamUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - createdByUser
            - serviceDate
            - toothNavigationScript
            - script
            - provider
            - patient
            - finished
          properties:
            id:
              type: integer
              format: int64
              example: 100002
              readOnly: true
            created:
              type: string
              format: date
              example: '2024-05-10T00:00:00.000Z'
              readOnly: true
            lastModified:
              type: string
              format: date-time
              readOnly: true
              example: '2018-07-09T20:30:00.000Z'
            createdByUser:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            provider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    PerioProbeUpdateV1:
      type: object
      properties:
        toothSide:
          type: string
          enum:
            - FACIAL
            - LINGUAL
          example: FACIAL
        tooth:
          type: integer
          format: int32
          example: 2
        toothIndex:
          type: integer
          format: int32
          example: 2
        centralPocketDepth:
          type: integer
          format: int32
          example: 2
        mesialPocketDepth:
          type: integer
          format: int32
          example: 2
        distalPocketDepth:
          type: integer
          format: int32
          example: 2
        centralGingivalMargin:
          type: integer
          format: int32
          example: 2
        mesialGingivalMargin:
          type: integer
          format: int32
          example: 2
        distalGingivalMargin:
          type: integer
          format: int32
          example: 2
        centralBleeding:
          type: boolean
          example: false
        mesialBleeding:
          type: boolean
          example: false
        distalBleeding:
          type: boolean
          example: false
        centralSuppuration:
          type: boolean
          example: false
        mesialSuppuration:
          type: boolean
          example: false
        distalSuppuration:
          type: boolean
          example: false
        centralFurcationGrade:
          type: integer
          format: int32
          example: 5
        mesialFurcationGrade:
          type: integer
          format: int32
          example: 5
        distalFurcationGrade:
          type: integer
          format: int32
          example: 5
        boneLoss:
          type: integer
          format: int32
          minimum: 1
          example: 1,2,3...
        mobility:
          type: integer
          format: int32
          minimum: 1
          example: 1,2,3...
        distalMucogingivalJunction:
          type: integer
          format: int32
          example: 5
        centralMucogingivalJunction:
          type: integer
          format: int32
          example: 5
        mesialMucogingivalJunction:
          type: integer
          format: int32
          example: 5
        skipped:
          type: string
          enum:
            - SKIPPED
            - NOT_SKIPPED
            - DEFAULT
          example: SKIPPED
      example:
        toothSide: FACIAL
        tooth: 2
    PerioProbeV1:
      allOf:
        - $ref: '#/components/schemas/PerioProbeUpdateV1'
        - type: object
          required:
            - toothSide
            - tooth
            - centralBleeding
            - mesialBleeding
            - distalBleeding
            - centralSuppuration
            - mesialSuppuration
            - distalSuppuration
          properties:
            id:
              type: integer
              format: int64
              example: 1700
              readOnly: true
            centralCAL:
              type: integer
              format: int32
              example: 0
              readOnly: true
            mesialCAL:
              type: integer
              format: int32
              example: 0
              readOnly: true
            distalCAL:
              type: integer
              format: int32
              example: 0
              readOnly: true
            perioExam:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    DefaultPlanCoverageUpdateV1:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 30
        coverageProcedureRanges:
          type: array
          items:
            type: object
            properties:
              deductibleType:
                type: string
                enum:
                  - NONE
                  - BASIC
                  - PREVENTIVE
                  - MAJOR
                  - ORTHODONTIC
                example: BASIC
              category:
                type: string
                minLength: 1
                maxLength: 255
                example: catergory
              rangeStart:
                type: string
                minLength: 1
                maxLength: 10
                example: string
              rangeStartExtension:
                type: string
                maxLength: 5
                example: strin
              rangeEnd:
                type: string
                minLength: 1
                maxLength: 10
                example: string
              rangeEndExtension:
                type: string
                maxLength: 5
                example: strin
              coveragePercentage:
                type: number
                format: double
                example: 40
        exceptions:
          type: array
          items:
            type: object
            properties:
              exceptionProcedureCode:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
              downgradeProcedureCode:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
              exceptionType:
                type: string
                enum:
                  - AGE_LIMIT
                  - NON_COVERED
                  - DOWNGRADE
                example: DOWNGRADE
              deductibleType:
                type: string
                enum:
                  - NONE
                  - BASIC
                  - PREVENTIVE
                  - MAJOR
                  - ORTHODONTIC
                example: BASIC
              reason:
                type: string
                minLength: 0
                maxLength: 255
              coveragePercentage:
                type: integer
                format: int16
                example: 40
              maxAgeLimit:
                type: integer
                format: int32
                example: 65
              minAgeLimit:
                type: integer
                format: int32
                example: 0
              maxAgeUnlimited:
                type: boolean
                example: false
        coverageProcedureCopay:
          type: array
          items:
            type: object
            properties:
              practiceProcedure:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
              deductibleType:
                type: string
                enum:
                  - NONE
                  - BASIC
                  - PREVENTIVE
                  - MAJOR
                  - ORTHODONTIC
                example: BASIC
              copay:
                type: number
                format: double
                example: 50
        planCopayExceptions:
          type: array
          items:
            type: object
            properties:
              reason:
                type: string
                minLength: 0
                maxLength: 255
              copay:
                type: number
                format: double
                example: 50
              maxAgeLimit:
                type: integer
                format: int32
                example: 65
              minAgeLimit:
                type: integer
                format: int32
                example: 0
              maxAgeUnlimited:
                type: boolean
                example: false
              exceptionType:
                type: string
                enum:
                  - AGE_LIMIT
                  - NON_COVERED
                  - DOWNGRADE
                example: NON_COVERED
              deductibleType:
                type: string
                enum:
                  - NONE
                  - BASIC
                  - PREVENTIVE
                  - MAJOR
                  - ORTHODONTIC
                example: BASIC
              exceptionProcedureCode:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
              downgradeProcedureCode:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
      example:
        name: Example Name
        coverageProcedureRanges:
          - deductibleType: BASIC
            category: catergory
    DefaultPlanCoverageV1:
      allOf:
        - $ref: '#/components/schemas/DefaultPlanCoverageUpdateV1'
        - type: object
      type: object
      required:
        - name
      properties:
        id:
          type: integer
          format: int64
          example: 343242432
          readOnly: true
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
      example: {}
    ClinicalNotePromptUpdateV1:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 45
        promptType:
          type: string
          enum:
            - ONE_FROM_LIST
            - TEXT
            - CHECKBOX
            - SELECT_TOOTH
            - SELECT_MULTI_TEETH
            - NUMBER_AMOUNT
            - SELECT_QUADRANT
            - SELECT_MULTI_QUADRANTS
          example: SELECT_QUADRANT
        title:
          type: string
          minLength: 1
          maxLength: 250
        options:
          type: array
          items:
            type: string
            example: string
      example:
        name: Example Name
        promptType: SELECT_QUADRANT
    ClinicalNotePromptV1:
      allOf:
        - $ref: '#/components/schemas/ClinicalNotePromptUpdateV1'
        - type: object
          required:
            - name
            - title
            - promptType
            - options
            - location
          properties:
            id:
              type: integer
              format: int64
              example: 2342432
              readOnly: true
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    ClinicalNoteTemplateUpdateV1:
      type: object
      properties:
        category:
          type: string
          enum:
            - ADMINISTRATIVE
            - ANESTHETICS
            - CLINICAL_EXAMS
            - ENDODONTICS
            - FIXED_PROSTHETICS
            - HYGIENE
            - MEDICAL_ALERTS
            - ORTHODONTICS
            - 'PATIENT_COMPLAINT '
            - PEDODONTICS
            - PERIODONTICS
            - PRESCRIPTIONS
            - RECOMMENDATIONS
            - REMOVABLE_PROSTHETICS
            - RESTORATIVE
            - TREATMENT
            - X_RAYS
          example: ADMINISTRATIVE
        name:
          type: string
          minLength: 1
          maxLength: 80
        text:
          type: string
          minLength: 1
          example: note
      example:
        category: ADMINISTRATIVE
        name: Example Name
    ClinicalNoteTemplateV1:
      allOf:
        - $ref: '#/components/schemas/ClinicalNoteTemplateUpdateV1'
        - type: object
          required:
            - name
            - category
            - text
            - location
          properties:
            id:
              type: integer
              format: int64
              example: 1234
              readOnly: true
            lastModified:
              type: string
              format: date-time
              example: '2020-04-09T19:00:00.000Z'
              readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    GlobalClinicalNoteTemplate:
      type: object
      required:
        - name
        - category
        - text
      properties:
        category:
          type: string
          enum:
            - ADMINISTRATIVE
            - ANESTHETICS
            - CLINICAL_EXAMS
            - ENDODONTICS
            - FIXED_PROSTHETICS
            - HYGIENE
            - MEDICAL_ALERTS
            - ORTHODONTICS
            - 'PATIENT_COMPLAINT '
            - PEDODONTICS
            - PERIODONTICS
            - PRESCRIPTIONS
            - RECOMMENDATIONS
            - REMOVABLE_PROSTHETICS
            - RESTORATIVE
            - TREATMENT
            - X_RAYS
          example: ADMINISTRATIVE
        name:
          type: string
          minLength: 1
          maxLength: 80
        text:
          type: string
          minLength: 1
      example:
        category: ADMINISTRATIVE
        name: Example Name
        text: text
    GlobalClinicalNotePromptV1:
      type: object
      required:
        - name
        - text
        - promptType
      properties:
        id:
          type: integer
          format: int64
          example: 324324
        name:
          type: string
          minLength: 1
          maxLength: 45
        promptType:
          type: string
          enum:
            - ONE_FROM_LIST
            - TEXT
            - CHECKBOX
            - SELECT_TOOTH
            - SELECT_MULTI_TEETH
            - NUMBER_AMOUNT
            - SELECT_QUADRANT
            - SELECT_MULTI_QUADRANTS
          example: TEXT
        text:
          type: string
          minLength: 1
          maxLength: 250
        options:
          type: array
          items:
            type: string
            example: items
      example:
        name: Example Name
        promptType: TEXT
        text: text
        id: 324324
        options:
          - items
    DentalLabUpdateV1:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 52
        phone:
          type: string
          maxLength: 10
          minLength: 10
          example: '3245672323'
      example:
        name: Example Name
        phone: '3245672323'
    DentalLabV1:
      allOf:
        - $ref: '#/components/schemas/DentalLabUpdateV1'
        - type: object
          required:
            - name
          properties:
            id:
              type: integer
              format: int64
              example: 797987
              readOnly: true
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
      example: {}
    DayNoteUpdateV1:
      type: object
      properties:
        note:
          type: string
        date:
          type: string
          format: date
          example: '2024-05-10T00:00:00.000Z'
      example:
        note: note
        date: '2024-05-10T00:00:00.000Z'
    DayNoteV1:
      allOf:
        - $ref: '#/components/schemas/DayNoteUpdateV1'
        - type: object
          required:
            - date
            - note
            - location
          properties:
            id:
              type: integer
              format: int64
              example: 39423
              readOnly: true
            version:
              type: string
              example: string
              readOnly: true
            lastModified:
              type: string
              format: date-time
              readOnly: true
              example: '2018-07-09T19:00:00.000Z'
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    SignatureV1:
      type: object
      required:
        - user
        - data
      properties:
        id:
          type: integer
          format: int64
          example: 32432432
        data:
          type: string
          format: byte
          example: U29tZSBiYXNlNjQgc3RyaW5n
        user:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        data: U29tZSBiYXNlNjQgc3RyaW5n
        user:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        id: 32432432
    PatientBookingAvailabilityUpdateV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 234234
        title:
          type: string
          maxLength: 32
          example: A sample title
        color:
          type: string
          maxLength: 6
          example: FFCA00
        start:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
        end:
          type: string
          format: date-time
          example: '2018-07-09T20:00:00.000Z'
        bookOnline:
          type: boolean
          example: true
        dayOfWeek:
          type: string
          enum:
            - SUNDAY
            - MONDAY
            - TUESDAY
            - WEDNESDAY
            - THURSDAY
            - FRIDAY
            - SATURDAY
          example: MONDAY
        bookingTypes:
          type: array
          items:
            type: string
            enum:
              - TREATMENT
              - RECARE
              - NEW_PATIENT
              - EXISTING_PATIENT
          example:
            - TREATMENT
            - NEW_PATIENT
        location:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        operatory:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        providers:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
        appointmentReasons:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
      example:
        id: 234234
        title: A sample title
    PatientBookingAvailabilityV1:
      allOf:
        - $ref: '#/components/schemas/PatientBookingAvailabilityUpdateV1'
        - type: object
          required:
            - operatory
            - location
            - start
            - end
            - dayOfWeek
            - color
            - bookOnline
            - providers
          properties:
            id:
              type: integer
              format: int64
              example: 108756
      example: {}
    ScheduleTemplateUpdateV1:
      type: object
      properties:
        title:
          type: string
          maxLength: 32
        color:
          type: string
          example: FFCA00
          maxLength: 6
        start:
          type: string
          example: '09:00'
        end:
          type: string
          example: '14:00'
        bookOnline:
          type: boolean
          example: true
        dayOfWeek:
          type: string
          enum:
            - SUNDAY
            - MONDAY
            - TUESDAY
            - WEDNESDAY
            - THURSDAY
            - FRIDAY
            - SATURDAY
          example: MONDAY
        bookingTypes:
          type: array
          items:
            type: string
            enum:
              - TREATMENT
              - RECARE
              - NEW_PATIENT
              - EXISTING_PATIENT
          example:
            - TREATMENT
            - EXISTING_PATIENT
        reasons:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
      example:
        title: Example Title
        color: FFCA00
    ScheduleTemplateV1:
      allOf:
        - $ref: '#/components/schemas/ScheduleTemplateUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - operatory
            - location
            - start
            - end
            - dayOfWeek
            - color
            - bookOnline
            - title
            - providers
          properties:
            id:
              type: integer
              format: int64
              example: 324324234
              readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            operatory:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            providers:
              type: array
              items:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
      example: {}
    ScheduleTemplateApptReasonUpdateV1:
      type: object
      description: >
        This Endpoint is being rate limited. More information can be found here:
        https://portal.hs1api.com/guide
      properties:
        id:
          type: integer
          format: int64
        reason:
          type: string
          minLength: 3
          maxLength: 50
          example: string
        durationMinutes:
          type: integer
          format: int32
          minimum: 5
          maximum: 600
          example: 600
        location:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        id: 12445
        reason: string
    ScheduleTemplateApptReasonV1:
      allOf:
        - $ref: '#/components/schemas/ScheduleTemplateApptReasonUpdateV1'
        - type: object
          required:
            - reason
            - location
            - durationMinutes
          properties:
            id:
              type: integer
              format: int64
      example: {}
    ScheduleTemplateReasonV1:
      type: object
      required:
        - reason
        - location
        - durationMinutes
      properties:
        id:
          type: integer
          format: int64
          example: 3243243
          readOnly: true
        reason:
          type: string
          minLength: 3
          maxLength: 50
        durationMinutes:
          type: integer
          format: int32
          minimum: 5
          maximum: 600
          example: 600
        location:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        reason: reason
        durationMinutes: 600
        location:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        id: 3243243
    InsuranceClaimUpdateV1:
      type: object
      properties:
        placeOfTreatment:
          type: string
          enum:
            - OFFICE
            - HOSPITAL
            - SCHOOL
            - HOMELESSSHELTER
            - CORRECTIONAL
            - HOME
            - ASSISTEDLIVING
            - GROUPHOME
            - MOBILEUNIT
            - WALKINRETAIL
            - WORKSITE
            - INPATIENTHOSPITAL
            - EMERGENCYROOM
            - MILITARYFACILITY
            - SKILLEDNURSING
            - NURSINGFACILITY
            - INDEPENDENTCLINIC
            - FEDERALLYQUALIFIED
            - PUBLICHEALTHCLINIC
            - RURALHEALTHCLINIC
            - OTHER
            - AMBULATORYSURGICAL
            - TELEHEALTH
          example: OFFICE
        unusualServicesRemarks:
          type: string
          maxLength: 400
          example: Remarks
        accidentType:
          type: string
          enum:
            - OCCUPATIONAL
            - AUTOMOTIVE
            - OTHER
          example: AUTOMOTIVE
        accidentState:
          type: string
          enum:
            - AA
            - AE
            - AP
            - AL
            - AK
            - AS
            - AZ
            - AR
            - CA
            - CO
            - CNMI
            - CT
            - DE
            - DC
            - FM
            - FL
            - FSM
            - GA
            - GU
            - HI
            - ID
            - IL
            - IN
            - IA
            - KS
            - KY
            - LA
            - ME
            - MD
            - MH
            - MA
            - MI
            - MN
            - MS
            - MO
            - MT
            - NE
            - NV
            - NH
            - NJ
            - NM
            - NY
            - NC
            - ND
            - MP
            - OH
            - OK
            - OR
            - PW
            - PA
            - PR
            - RI
            - SC
            - SD
            - TN
            - TX
            - UT
            - VT
            - VI
            - VA
            - WA
            - WV
            - WI
            - WY
          example: MA
        accidentDate:
          type: string
          format: date
          example: '2024-05-10T00:00:00.000Z'
        priorAuthorizationNumber:
          type: string
          maxLength: 50
          example: '234324042'
        procedures:
          type: array
          items:
            type: object
            description: A reference to a linked estimation model.
            properties:
              id:
                type: integer
                format: int64
                example: 1234
              type:
                type: string
                readOnly: true
              url:
                type: string
                format: uri
                readOnly: true
                example: https://example.com/resource
              writeOff:
                type: number
                readOnly: true
                example: 150
              primaryInsurancePortion:
                type: number
                readOnly: true
                example: 200
              secondaryInsurancePortion:
                type: number
                readOnly: true
                example: 100
              patientPortion:
                type: number
                readOnly: true
                example: 50
              originalPrimaryInsurancePortion:
                type: number
                readOnly: true
                example: 120
              originalSecondaryInsurancePortion:
                type: number
                readOnly: true
                example: 40
              originalPatientPortion:
                type: number
                readOnly: true
                example: 75
        referral:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        billingProvider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        renderingProvider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        placeOfTreatment: OFFICE
        unusualServicesRemarks: Remarks
    InsuranceClaimV1:
      allOf:
        - $ref: '#/components/schemas/InsuranceClaimUpdateV1'
        - type: object
          required:
            - location
            - patient
            - isPredetermination
            - procedures
            - placeOfTreatment
          properties:
            totalCharges:
              readOnly: true
              type: number
              format: double
              example: 100
            patientAmountPaid:
              readOnly: true
              type: number
              format: double
              example: 50
            amountPaid:
              readOnly: true
              type: number
              format: double
              example: 50
            appliancePlacementDate:
              type: string
              format: date
              example: '2024-05-10T00:00:00.000Z'
            serviceDate:
              type: string
              format: date
              example: '2024-05-10T00:00:00.000Z'
            originalReferenceNumber:
              type: string
              maxLength: 50
              example: '3243244'
            referralNumber:
              type: string
              maxLength: 50
              example: '2345464353'
            payorName:
              type: string
              maxLength: 127
              example: name
            payorId:
              type: string
              maxLength: 30
              example: '344'
            groupPlanName:
              type: string
              maxLength: 50
              example: name
            groupNumber:
              type: string
              maxLength: 30
              example: '675765'
            subscriberNumber:
              type: string
              maxLength: 50
              example: 978098
            releaseOfInformation:
              type: boolean
              example: true
            assignmentOfBenefits:
              type: boolean
              example: true
            isPredetermination:
              type: boolean
              example: true
            paymentResponsibilityOrder:
              type: integer
              format: int32
              example: 50
              readOnly: true
            relationshipToSubscriber:
              type: string
              enum:
                - SELF
                - SPOUSE
                - CHILD
                - OTHER
              example: SELF
              readOnly: true
            claimState:
              type: string
              enum:
                - UNSENT
                - SENT
                - PAID
                - ZEROPAY
                - REJECTSV
                - REJECTED
                - UNPROCESS
                - ACCEPTED
                - ADDINFO
                - PENDING
                - DELETED
                - QUEUED
                - PRINTED
                - VOID
                - RESUB
                - PAYRECVD
                - EXTRACTED
                - SETTLED
                - ATTACHMENTHOLD
                - ATTACHMENTERROR
                - FAKE
                - TX_CASE
              example: SENT
            lastUpdateDate:
              type: string
              format: date
              example: '2024-05-10T00:00:00.000Z'
              readOnly: true
            statusSource:
              type: string
              example: status source
              readOnly: true
            messageTxt:
              type: string
              example: text
              readOnly: true
            payerRequestedResubmit:
              type: boolean
              example: true
            payerRequestedVoid:
              type: boolean
              example: true
            created:
              readOnly: true
              type: string
              format: date
              example: true
            resubmitDate:
              type: string
              format: date
              example: '2024-05-10T00:00:00.000Z'
            voidedDate:
              type: string
              format: date
              example: '2024-05-10T00:00:00.000Z'
            sentDate:
              type: string
              format: date
              example: '2024-05-10T00:00:00.000Z'
            orthoMonthsRemaining:
              type: integer
              format: int32
              example: 6
            orthoTotalMonths:
              type: integer
              format: int32
              example: 24
            followupDueDate:
              type: string
              format: date
              example: '2024-05-10T00:00:00.000Z'
            claimFollowupAction:
              type: string
              enum:
                - CONTACT_CARRIER
                - CONTACT_PATIENT
              example: CONTACT_CARRIER
            attachmentReferenceNumber:
              type: string
              maxLength: 25
              example: '00324342'
            isActive:
              type: boolean
              example: true
              readOnly: true
            eTransClaimId:
              type: string
              maxLength: 20
              example: '000234324'
            payTo_address1:
              type: string
              example: 123 example st
              readOnly: true
            payTo_address2:
              type: string
              example: 456 example st
              readOnly: true
            payTo_city:
              type: string
              example: city
              readOnly: true
            payTo_state:
              type: string
              example: state
              readOnly: true
            payTo_postalCode:
              type: string
              example: '32452'
              readOnly: true
            rendering_address1:
              type: string
              example: 123 example st
              readOnly: true
            rendering_address2:
              type: string
              example: 456 example st
              readOnly: true
            rendering_city:
              type: string
              example: city
              readOnly: true
            rendering_state:
              type: string
              example: state
              readOnly: true
            rendering_postalCode:
              type: string
              example: '32421'
              readOnly: true
            payTo_phoneType:
              type: string
              enum:
                - HOME
                - WORK
                - MOBILE
                - OTHER
              example: HOME
              readOnly: true
            payTo_phoneNumber:
              type: string
              example: '2344325656'
              readOnly: true
            payTo_phoneExtension:
              type: string
              example: '4566542323'
              readOnly: true
            claimStatusHistory:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: integer
                    format: int64
                    example: 1234
                  claimState:
                    type: string
                    example: claim
                  claimHistoryMessageTxt:
                    type: string
                    maxLength: 3000
                    example: message history
                  statusDate:
                    type: string
                    format: date
                    example: '2023-05-10T00:00:00.000Z'
                  amountPaid:
                    type: number
                    format: double
                    example: 1000
                  payerReferenceNumber:
                    type: string
                    maxLength: 30
                    example: '123456789009876543215432167890'
                  payerContactMethod:
                    type: string
                    maxLength: 2
                    example: EM
                  payerContact:
                    type: string
                    maxLength: 80
                    example: John Doe
                  payerContactNumber:
                    type: string
                    maxLength: 80
                    example: 123-456-7890
                  paymentDate:
                    type: string
                    format: date
                    example: '2024-05-10'
                  paymentSentDate:
                    type: string
                    format: date
                    example: '2024-05-11'
                  paymentTraceNumber:
                    type: string
                    maxLength: 16
                    example: TR1234567890
                  statusSource:
                    type: string
                    maxLength: 60
                    example: Insurance Company
                  totalCharge:
                    type: number
                    format: double
                    example: 150.75
            id:
              type: integer
              format: int64
              example: 1252
              readOnly: true
            type:
              type: string
              example: InsuranceClaim
              readOnly: true
            insurancePayments:
              type: array
              items:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            subscriber:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            payToProvider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            insuranceCarrier:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            carrierInsurancePlan:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            patientInsurancePlan:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            claimDiagnosisCode:
              type: object
              properties:
                codeA:
                  type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
                codeB:
                  type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
                codeC:
                  type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
                codeD:
                  type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
      example: {}
    ClaimAttachmentV1:
      type: object
      required:
        - insuranceClaim
        - attachmentType
      properties:
        id:
          type: integer
          format: int64
          example: 234324
        attachmentType:
          type: string
          enum:
            - RADIOLOGY_FILMS
            - PERIODONTAL_CHART
            - EXPLANATION_OF_BENEFITS
            - RADIOLOGY_REPORTS
            - STUDENT_VERIFICATION
            - NARRATIVE
            - REPORT
            - DIAGNOSTIC_REPORT
            - FULL_MOUTH_SERIES
            - PANORAMIC_FILM
            - X_RAY_CREATION_DATE
          example: RADIOLOGY_FILMS
        attachedDate:
          type: string
          format: date
          example: '2024-05-09T00:00:00.000Z'
        dateCreated:
          type: string
          format: date
          example: '2024-05-09T00:00:00.000Z'
        neaNumber:
          type: string
          maxLength: 50
          example: '435432'
        document:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        insuranceClaim:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        attachmentType: RADIOLOGY_FILMS
        insuranceClaim:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        id: 234324
        attachedDate: '2024-05-09T00:00:00.000Z'
    ImageAttachmentV1:
      type: object
      required:
        - insuranceClaim
        - attachmentType
        - examImageId
        - examName
        - examDate
        - examImageOutputFormat
        - examImageSizeInBytes
      properties:
        id:
          type: integer
          format: int64
          example: 3246546
        examId:
          type: integer
          format: int64
          example: 654
        examImageId:
          type: integer
          format: int64
          example: 23
        examName:
          type: string
          maxLength: 50
          example: exam name
        examDate:
          type: string
          format: date
          example: '2024-05-10T00:00:00.000Z'
        examImageOutputFormat:
          type: string
          maxLength: 10
          example: format
        examImageSizeInBytes:
          type: integer
          format: int32
          example: 2048
        examImageTreatments:
          type: string
          maxLength: 500
          example: image treatments
        attachmentType:
          type: string
          enum:
            - RADIOLOGY_FILMS
            - PERIODONTAL_CHART
            - EXPLANATION_OF_BENEFITS
            - RADIOLOGY_REPORTS
            - STUDENT_VERIFICATION
            - NARRATIVE
            - REPORT
            - DIAGNOSTIC_REPORT
            - FULL_MOUTH_SERIES
            - PANORAMIC_FILM
            - X_RAY_CREATION_DATE
          example: RADIOLOGY_FILMS
        attachedDate:
          type: string
          format: date
          example: '2024-05-10T00:00:00.000Z'
        dateCreated:
          type: string
          format: date
          example: '2024-05-10T00:00:00.000Z'
        neaNumber:
          type: string
          maxLength: 50
          example: '324'
        insuranceClaim:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        examImageId: 23
        examName: exam name
        examDate: '2024-05-10T00:00:00.000Z'
        examImageOutputFormat: format
        examImageSizeInBytes: 2048
        attachmentType: RADIOLOGY_FILMS
        insuranceClaim:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        id: 3246546
        examId: 654
    ICD10V1:
      type: object
      properties:
        id:
          type: integer
          format: int32
          example: 324324
        code:
          type: string
        description:
          type: string
      example:
        id: 324324
        code: ERR101
    SMSNumberV1:
      type: object
      required:
        - number
        - smsAuthorizationStatus
        - infoSent
        - location
      properties:
        id:
          type: integer
          format: int64
          example: 23424
        number:
          type: string
          maxLength: 30
          example: max length 30
        smsAuthorizationStatus:
          type: string
          enum:
            - OPT_IN
            - OPT_OUT
            - INVALID
            - ERROR
          example: INVALID
        statusChangedDate:
          type: string
          format: date
          example: '2024-05-10T00:00:00.000Z'
        infoSent:
          type: boolean
          example: true
        location:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        number: max length 30
        smsAuthorizationStatus: INVALID
        infoSent: true
        location:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        id: 23424
        statusChangedDate: '2024-05-10T00:00:00.000Z'
    ScheduleOpeningsV1:
      type: object
      description: >
        This Endpoint is being rate limited. More information can be found here:
        https://portal.hs1api.com/guide
      properties:
        provider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        operatory:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        day:
          type: string
          format: date
          example: '2018-07-09T00:00:00.000Z'
        slots:
          type: array
          items:
            type: object
            properties:
              start:
                type: string
                format: date-time
                example: '2018-07-09T19:00:00.000Z'
              end:
                type: string
                format: date-time
                example: '2018-07-09T20:00:00.000Z'
              scheduleTemplateBookingType:
                type: array
                items:
                  type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
              scheduleTemplateReason:
                type: array
                items:
                  type: object
                  description: >-
                    A reference to a linked model. Includes the id, the type,
                    and URL at which the model can be accessed.
                  required:
                    - id
                    - url
                  properties:
                    id:
                      type: integer
                      format: int64
                      description: The unique identifier for the linked model.
                      example: 12345
                    type:
                      type: string
                      description: The type of the linked model. This field is read-only.
                      example: ExampleModelType
                      readOnly: true
                    url:
                      type: string
                      format: uri
                      description: >-
                        The URL at which the linked model can be accessed. This
                        field is read-only.
                      example: https://api.example.com/models/12345
                      readOnly: true
      example:
        provider:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        operatory:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
    ColorCategoryV1:
      type: object
      description: >
        This Endpoint is being rate limited. More information can be found here:
        https://portal.hs1api.com/guide
      required:
        - name
        - color
        - sequence
        - location
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        name:
          type: string
          minLength: 1
          maxLength: 52
          example: string
        sequence:
          type: number
          example: 0
        color:
          type: string
          example: 24802E
          maxLength: 6
        isDefault:
          type: boolean
          readOnly: true
          example: true
        location:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        practiceProcedures:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
      example:
        name: string
        sequence: 0
        color: 24802E
        location:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        id: 12445
        isDefault: true
    AppointmentColorV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
        mainArea:
          type: string
          enum:
            - PROVIDER_COLOR
            - PROCEDURE_COLOR
          example: PROVIDER_COLOR
        additionalArea:
          type: string
          enum:
            - PROVIDER_COLOR
            - ADDITIONAL_PROVIDER_COLOR
            - PROCEDURE_COLOR
          example: ADDITIONAL_PROVIDER_COLOR
        location:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
      example:
        id: 12445
        mainArea: PROVIDER_COLOR
    OrganizationLedgerRulesV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 324324
        transactionLockTime:
          type: number
          maximum: 999
          minimum: 1
          example: 999
        transactionLockDate:
          type: string
          format: date
          example: '2018-07-09T00:00:00.000Z'
        writeOffAutoPostEnabled:
          type: boolean
          example: true
        reasonForCorrectionRequired:
          type: boolean
          example: true
        expirationDateForDiscountPlansRequired:
          type: boolean
          example: true
        transactionLockType:
          type: string
          enum:
            - SLIDING_LOCK
            - USER_INITIATED
          example: SLIDING_LOCK
      example:
        id: 324324
        transactionLockTime: 999
    LocationPovertyLevelV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1234
        onePerson:
          type: integer
          format: int32
          maximum: 99999
          minimum: 0
          example: 99999
        twoPersons:
          type: integer
          format: int32
          maximum: 99999
          minimum: 0
          example: 99999
        threePersons:
          type: integer
          format: int32
          maximum: 99999
          minimum: 0
          example: 99999
        fourPersons:
          type: integer
          format: int32
          maximum: 99999
          minimum: 0
          example: 99999
        fivePersons:
          type: integer
          format: int32
          maximum: 99999
          minimum: 0
          example: 99999
        sixPersons:
          type: integer
          format: int32
          maximum: 99999
          minimum: 0
          example: 99999
        sevenPersons:
          type: integer
          format: int32
          maximum: 99999
          minimum: 0
          example: 99999
        eightPersons:
          type: integer
          format: int32
          maximum: 99999
          minimum: 0
          example: 99999
        eachAdditional:
          type: integer
          format: int32
          maximum: 99999
          minimum: 0
          example: 99999
        patientAmounts:
          type: array
          items:
            type: object
            properties:
              paymentUnit:
                type: string
                enum:
                  - PERCENT
                  - CURRENCY
                  - CURRENCY_PER_VISIT
                example: PERCENT
              patientAmount:
                type: number
                format: double
                minimum: 0
                example: 50
              povertyLevel:
                type: integer
                format: int32
                minimum: 100
                maximum: 201
                example: 201
        location:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        practiceProcedure:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        id: 1234
        onePerson: 99999
    LocationWithExcludedProcedureV1:
      type: object
      properties:
        location:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        practiceProcedures:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
      example:
        location:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        practiceProcedures:
          - id: 12345
            url: https://api.example.com/models/12345
            type: ExampleModelType
    LocationClaimDefaultsV1:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 123213
        useNonContractedProviderWarning:
          type: boolean
          example: true
        usePatientRenderingProvider:
          type: boolean
          example: true
        defaultReleaseOfInformation:
          type: boolean
          example: true
        defaultAssignmentOfBenefits:
          type: boolean
          example: true
        defaultBillingProviderType:
          type: string
          example: Billing Provider Type
          readOnly: true
        defaultRenderingProviderType:
          type: string
          example: Rendering Provider Type
          readOnly: true
        defaultPayToAddressType:
          type: string
          enum:
            - LOCATION
            - ORGANIZATION
            - OTHER
          example: LOCATION
        address1:
          type: string
          maxLength: 50
          example: 123 example st
        address2:
          type: string
          maxLength: 50
          example: 456 example st
        city:
          type: string
          maxLength: 30
        state:
          type: string
          enum:
            - AA
            - AE
            - AP
            - AL
            - AK
            - AS
            - AZ
            - AR
            - CA
            - CO
            - CNMI
            - CT
            - DE
            - DC
            - FM
            - FL
            - FSM
            - GA
            - GU
            - HI
            - ID
            - IL
            - IN
            - IA
            - KS
            - KY
            - LA
            - ME
            - MD
            - MH
            - MA
            - MI
            - MN
            - MS
            - MO
            - MT
            - NE
            - NV
            - NH
            - NJ
            - NM
            - NY
            - NC
            - ND
            - MP
            - OH
            - OK
            - OR
            - PW
            - PA
            - PR
            - RI
            - SC
            - SD
            - TN
            - TX
            - UT
            - VT
            - VI
            - VA
            - WA
            - WV
            - WI
            - WY
          example: AA
        postalCode:
          type: string
          minLength: 5
          maxLength: 10
          example: '2343389878'
        location:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        defaultBillingProvider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        alternateBillingProvider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        alternateRenderingProvider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        defaultRenderingProvider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        id: 123213
        useNonContractedProviderWarning: true
    InsuranceCarrierWithExcludedProcedureV1:
      type: object
      properties:
        insuranceCarrier:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        practiceProcedures:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
      example:
        insuranceCarrier:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        practiceProcedures:
          - id: 12345
            url: https://api.example.com/models/12345
            type: ExampleModelType
    StreamAPIUsageV1:
      type: object
      properties:
        name:
          type: string
        auto_delete:
          type: boolean
          example: true
        exclusive:
          type: boolean
          example: true
        memory:
          type: integer
          format: int64
          example: 2048
        message_ram:
          type: integer
          format: int64
          example: 2048
        message_bytes:
          type: integer
          format: int64
          example: 2
        messages:
          type: integer
          format: int64
          example: 5
        node:
          type: string
        state:
          type: string
        consumers:
          type: integer
          format: int64
      example:
        name: Example Name
        auto_delete: true
    StreamAPIUsageQueueV1:
      type: object
      properties:
        source:
          type: string
        vhost:
          type: string
        destination:
          type: string
        destination_type:
          type: string
          example: string
        routing_key:
          type: string
          example: routing key
        arguments:
          type: string
        properties_key:
          type: string
          example: properties key
      example:
        source: source
        vhost: vhost
    BulkInsurancePaymentV1:
      type: object
      required:
        - insuranceCarrier
        - transactionDate
        - amount
        - organizationLedgerType
        - location
      properties:
        id:
          type: integer
          format: int64
        transactionDate:
          type: string
          format: date
          example: '2018-07-09'
        amount:
          type: number
          format: double
          example: 100
        checkNumber:
          type: string
          maxLength: 20
          example: '1232131335'
        bankNumber:
          type: string
          maxLength: 20
          example: '34324242432'
        referenceNumber:
          type: string
          maxLength: 20
          example: '567676'
        lastModified:
          type: string
          format: date-time
          readOnly: true
          example: '2018-07-09T19:00:00.000Z'
        insuranceCarrier:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        organizationLedgerType:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        location:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        insuranceClaims:
          readOnly: true
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
        insurancePayments:
          readOnly: true
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
        creditCardTransaction:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        transactionDate: '2018-07-09'
        amount: 100
        insuranceCarrier:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        organizationLedgerType:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        location:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        id: 12445
        checkNumber: '1232131335'
    ExamV1:
      type: object
      required:
        - procedures
        - exam
      properties:
        id:
          type: string
          readOnly: true
          example: '213'
        isProcedureNotEditable:
          type: boolean
          example: true
          readOnly: true
        imagesAttached:
          type: boolean
          example: true
          readOnly: true
        version:
          type: string
          example: V1
        type:
          type: string
          example: ExampleModelType
        procedures:
          type: array
          items:
            type: object
            description: >-
              A reference to a linked model. Includes the id, the type, and URL
              at which the model can be accessed.
            required:
              - id
              - url
            properties:
              id:
                type: integer
                format: int64
                description: The unique identifier for the linked model.
                example: 12345
              type:
                type: string
                description: The type of the linked model. This field is read-only.
                example: ExampleModelType
                readOnly: true
              url:
                type: string
                format: uri
                description: >-
                  The URL at which the linked model can be accessed. This field
                  is read-only.
                example: https://api.example.com/models/12345
                readOnly: true
        patient:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        procedures:
          - id: 12345
            url: https://api.example.com/models/12345
            type: ExampleModelType
        id: '213'
        isProcedureNotEditable: true
    ProductionCollectionV1:
      type: object
      description: >
        This Endpoint is being rate limited. More information can be found here:
        https://portal.hs1api.com/guide
      properties:
        locationId:
          type: integer
          format: int64
          example: 3243242
        locationName:
          type: string
          example: name
        serviceLocationId:
          type: integer
          format: int64
          example: 3423
        serviceLocationName:
          type: string
          example: name
        providerId:
          type: integer
          format: int64
          example: 2342442
        providerName:
          type: string
          example: name
        patientLedgerId:
          type: integer
          format: int64
          example: 32424324
        transactionId:
          type: integer
          format: int64
          example: 323532523
        transactionDate:
          type: string
          format: date
          example: '2018-07-09'
        serviceDate:
          type: string
          format: date
          example: '2018-07-09'
        modifiedDate:
          type: string
          format: date
          example: '2024-05-10'
        patientId:
          type: integer
          format: int64
          example: 343243242
        patientName:
          type: string
          example: name
        primaryGuarantorId:
          type: integer
          format: int64
          example: 3523524242
        primaryGuarantorName:
          type: string
          example: name
        chartNumber:
          type: string
          example: '5'
        primaryProvider:
          type: string
          example: primary provider
        transactionCategory:
          type: string
          example: transaction category
        transactionSubCategory:
          type: string
          example: transaction subcategory
        collection_production:
          type: string
          example: collection production
        procedureCategory:
          type: string
          example: procedure category
        procedureCode:
          type: string
          example: procedure code
        amount:
          type: number
          format: float
          example: 100
        tags:
          type: string
        insuranceCarrier:
          type: string
          example: insurance carrier
        insurancePlan:
          type: string
          example: insurance plan
      example:
        locationId: 3243242
        locationName: name
    ProductionGrossV1:
      type: object
      properties:
        scheduledAmount:
          type: integer
          format: int64
          example: 10000
        actualAmount:
          type: integer
          format: int64
          example: 1000
        date:
          type: string
          format: datetime
          example: '2022-02-26T00:00:00.000Z'
      example:
        scheduledAmount: 10000
        actualAmount: 1000
    ProductionNetActualV1:
      type: object
      properties:
        actualAmount:
          type: integer
          format: int64
          example: 1000
        date:
          type: string
          format: datetime
          example: '2022-02-26T00:00:00.000Z'
      example:
        actualAmount: 1000
        date: '2022-02-26T00:00:00.000Z'
    ProductionNetScheduledV1:
      type: object
      properties:
        scheduledAmount:
          type: integer
          format: int64
          example: 10000
        date:
          type: string
          format: datetime
          example: '2022-02-26T00:00:00.000Z'
      example:
        scheduledAmount: 10000
        date: '2022-02-26T00:00:00.000Z'
    PatientPaymentPlanUpdateV1:
      type: object
      properties:
        date:
          type: string
          format: date
          example: '2018-12-31T00:00:00.000Z'
        totalAmount:
          type: number
          format: double
          example: 750
        interestRate:
          type: number
          format: double
          example: 1.5
        numberOfPayments:
          type: number
          format: double
          example: 10
        paymentAmount:
          type: number
          format: double
          example: 500
        interestAmount:
          type: number
          format: double
          example: 250
        appliedAmount:
          type: number
          format: double
          example: 0
        paymentIntervalType:
          type: string
          enum:
            - BIWEEKLY
            - MONTHLY
            - QUARTERLY
          example: BIWEEKLY
        note:
          type: string
        active:
          type: boolean
          example: true
          readOnly: true
        patientPaymentPlanStatus:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
            - DELETED
          example: ACTIVE
        pendingForReviewResolved:
          type: boolean
          example: true
        charges:
          type: object
          properties:
            charge:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            appliedAmount:
              type: number
              format: double
              example: 500
            guarantorPortion:
              type: number
              format: double
              example: 250
            balance:
              type: number
              format: double
              example: 250
      example:
        date: '2018-12-31T00:00:00.000Z'
        totalAmount: 750
    PatientPaymentPlanV1:
      allOf:
        - $ref: '#/components/schemas/PatientPaymentPlanUpdateV1'
        - type: object
          required:
            - patient
            - location
            - provider
            - numberOfPayments
            - paymentIntervalType
            - charges
            - date
          properties:
            id:
              type: integer
              format: int64
              example: 13587
              readOnly: true
            currentBalance:
              type: number
              format: double
              example: 750
              readOnly: true
            lastPayment:
              type: number
              format: double
              example: 100
              readOnly: true
            lastPaymentDate:
              type: string
              format: date-time
              example: '2019-09-09T19:00:00.000Z'
              readOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            provider:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    TransferReasonV1:
      type: object
      required:
        - tagText
      properties:
        id:
          type: integer
          format: int64
          example: 324324
          readOnly: true
        tagText:
          type: string
          minLength: 1
          maxLength: 30
          example: tag text
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
      example:
        tagText: tag text
        id: 324324
        lastModified: '2018-07-09T19:00:00.000Z'
    TimeClockUpdateV1:
      type: object
      properties:
        punchDateTime:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
        lastEditedBy:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        punchDateTime: '2018-07-09T19:00:00.000Z'
        lastEditedBy:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
    TimeClockV1:
      allOf:
        - $ref: '#/components/schemas/TimeClockUpdateV1'
        - type: object
          required:
            - punchDateTime
            - user
            - location
          properties:
            id:
              type: integer
              format: int64
              example: 2342342
              readOnly: true
            version:
              type: string
              readOnly: true
              example: V1
            localPunchDateTime:
              type: object
              readOnly: true
              properties:
                timeZone:
                  type: string
                  example: timezone
                punchDate:
                  type: string
                  example: Aug 12
                dayOfWeek:
                  type: string
                  enum:
                    - SUN
                    - MON
                    - TUE
                    - WED
                    - THU
                    - FRI
                    - SAT
                  example: MON
                punchHour:
                  type: integer
                  maximum: 12
                  minimum: 0
                  example: 12
                punchMinute:
                  type: integer
                  maximum: 59
                  minimum: 0
                  example: 59
                amPM:
                  type: string
                  enum:
                    - AM
                    - PM
                  example: AM
            user:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            addedBy:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            lastModified:
              type: string
              format: date-time
              readOnly: true
              example: '2018-07-09T19:00:00.000Z'
      example: {}
    UsageReportItemV1:
      type: object
      properties:
        endpoint:
          type: string
        requestCount:
          type: number
          example: 12345
      example:
        endpoint: endpoint
        requestCount: 12345
    DeletedResult:
      type: object
      description: >-
        Result of deleting the particular resource. Includes the id of deleted
        resource.
      properties:
        data:
          type: object
          properties:
            id:
              type: integer
              format: int64
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          id: 12545
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    Token:
      type: object
      properties:
        access_token:
          type: string
          example: access token
        expires_in:
          type: string
          example: 60 days
        token_type:
          type: string
          example: token type
      example:
        access_token: access token
        expires_in: 60 days
    PatientResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatientV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          id: '1000000020701'
          type: PatientV1
          firstName: John
          lastName: Smith
          preferredName: John
          gender: M
          dateOfBirth: '1990-05-07'
          patientStatus: NEW
          contactMethod: CALL ME
          languageType: English
          address1: Fake street 1
          city: Fake City
          state: UT
          postalCode: '84062'
          chartNumber: A99999
          title: Title
          middleInitial: M
          nameSuffix: Sr
          preferredLocation:
            id: 1000000001027
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientUpdateResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatientUpdateV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - id: '1000000020701'
            type: PatientV1
            firstName: John
            lastName: Smith
            preferredName: John
            gender: M
            dateOfBirth: '1990-05-07'
            patientStatus: NEW
            contactMethod: CALL ME
            languageType: English
            address1: Fake street 1
            city: Fake City
            state: UT
            postalCode: '84062'
            chartNumber: A99999
            title: Title
            middleInitial: M
            nameSuffix: Sr
            preferredLocation:
              id: 1000000001027
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientCalcBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientCalcV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    AppointmentResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AppointmentV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          id: '1000012109742'
          type: AppointmentV1
          title: Appointment
          start: '2025-10-04T07:00:00.000Z'
          end: '2025-10-04T08:00:00.000Z'
          duration: 60
          status: HERE
          statusId: 2
          note: ~ 2025-10-04 ~   Test Notes !! heheh JEST TEST NOTE!!
          other: My Other Test Note
          needsFollowUp: true
          needsPremedicate: true
          bookedOnline: true
          asap: false
          created: '2025-10-03T16:56:56.510Z'
          lastModified: '2025-10-03T16:56:56.510Z'
          confirmed: '2025-10-03T16:56:56.420Z'
          followedUpOn: '2025-10-04T00:00:00.000Z'
          patient:
            id: '1000000020701'
            type: PatientV1
          location:
            id: '1000000001027'
            type: LocationV1
          provider:
            id: '1000000002089'
            type: ProviderV1
          operatory:
            id: '1000000002103'
            type: OperatoryV1
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    AppointmentBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AppointmentV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - id: '1000012109742'
            type: AppointmentV1
            title: Appointment
            start: '2025-10-04T07:00:00.000Z'
            end: '2025-10-04T08:00:00.000Z'
            duration: 60
            status: HERE
            statusId: 2
            note: ~ 2025-10-04 ~   Test Notes !! heheh JEST TEST NOTE!!
            other: My Other Test Note
            needsFollowUp: true
            needsPremedicate: true
            bookedOnline: true
            asap: false
            created: '2025-10-03T16:56:56.510Z'
            lastModified: '2025-10-03T16:56:56.510Z'
            confirmed: '2025-10-03T16:56:56.420Z'
            followedUpOn: '2025-10-04T00:00:00.000Z'
            patient:
              id: '1000000020701'
              type: PatientV1
            location:
              id: '1000000001027'
              type: LocationV1
            provider:
              id: '1000000002089'
              type: ProviderV1
            operatory:
              id: '1000000002103'
              type: OperatoryV1
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    AppointmentResponseWrapperV2:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AppointmentV2'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          id: 9000000903582
          version: 5
          created: 1730733795640
          startDateTime: 1730910600000
          endDateTime: 1730915100000
          status: READY
          title: Appointment
          reason: ArthrSDsc, PerMaint
          duration: 75
          needsFollowup: true
          ASAP: true
          needsPremedicate: true
          note: this is a test note
          other: null
          bookedOnline: false
          patient:
            id: 9000000082518
          patientLite:
            id: 9000000082518
          location:
            id: 9000000000010
          provider:
            id: 9000000000393
          operatory:
            id: 9000000000333
          secondaryProvider:
            id: 9000000000398
          confirmed: 1730733785665
          followedUp: null
          reminded: null
          insuranceEligibilityVerified: null
          productionAmount: 144
          leftMessage: null
          visits: []
          patientProcedures: []
          procedures:
            - id: 9000000050597
              procedure:
                id: 9000000005520
                adaCode: D7876
                description: Arthroscopy Discectomy
                abbreviatedDescription: ArthrSDsc
            - id: 9000000050598
              procedure:
                id: 9000000005807
                adaCode: D4910
                description: Periodontal Maintenance
                abbreviatedDescription: PerMaint
          communications: []
          dueDates: []
          missedAppointments: []
          labCase:
            id: 9000000000002
            dentalLab:
              id: 9000000000001
              name: asdf
              phone: '1112223333'
            status: OUTSTANDING
            dueDate: 1730959199000
            note: this is a test lab note
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    AppointmentBulkResponseWrapperV2:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AppointmentV2'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - id: 9000000903582
            version: 5
            created: 1730733795640
            startDateTime: 1730910600000
            endDateTime: 1730915100000
            status: READY
            title: Appointment
            reason: ArthrSDsc, PerMaint
            duration: 75
            needsFollowup: true
            ASAP: true
            needsPremedicate: true
            note: this is a test note
            other: null
            bookedOnline: false
            patient:
              id: 9000000082518
            patientLite:
              id: 9000000082518
            location:
              id: 9000000000010
            provider:
              id: 9000000000393
            operatory:
              id: 9000000000333
            secondaryProvider:
              id: 9000000000398
            confirmed: 1730733785665
            followedUp: null
            reminded: null
            insuranceEligibilityVerified: null
            productionAmount: 144
            leftMessage: null
            visits: []
            patientProcedures: []
            procedures:
              - id: 9000000050597
                procedure:
                  id: 9000000005520
                  adaCode: D7876
                  description: Arthroscopy Discectomy
                  abbreviatedDescription: ArthrSDsc
              - id: 9000000050598
                procedure:
                  id: 9000000005807
                  adaCode: D4910
                  description: Periodontal Maintenance
                  abbreviatedDescription: PerMaint
            communications: []
            dueDates: []
            missedAppointments: []
            labCase:
              id: 9000000000002
              dentalLab:
                id: 9000000000001
                name: asdf
                phone: '1112223333'
              status: OUTSTANDING
              dueDate: 1730959199000
              note: this is a test lab note
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    AppointmentHistoryResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AppointmentHistoryV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    AppointmentHistoryBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AppointmentHistoryV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    AppointmentSHResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AppointmentStatusHistoryV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    AppointmentSHBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AppointmentStatusHistoryV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    AppointmentTaskResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AppointmentTaskV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    AppointmentTaskBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AppointmentTaskV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ProviderResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ProviderV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          id: '1000000002089'
          type: ProviderV1
          firstName: John
          lastName: Doe
          shortName: Short
          specialty: DENTIST
          isPrimaryProvider: true
          isNonPersonEntity: false
          color: ffffff
          dea: AA1234567
          npi: '1234567893'
          active: true
          stateId: license number
          tin: '123456789'
          signatureOnFile: false
          address1: addr 1
          address2: addr 2
          city: city 1
          state: CA
          postalCode: 11111-2222
          title: Dr
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ProviderBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProviderV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - id: '1000000002089'
            type: ProviderV1
            firstName: John
            lastName: Doe
            shortName: Short
            specialty: DENTIST
            isPrimaryProvider: true
            isNonPersonEntity: false
            color: ffffff
            dea: AA1234567
            npi: '1234567893'
            active: true
            stateId: license number
            tin: '123456789'
            signatureOnFile: false
            address1: addr 1
            address2: addr 2
            city: city 1
            state: CA
            postalCode: 11111-2222
            title: Dr
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ProviderHourBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProviderHourV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ProviderHourResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ProviderHourV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    FeeScheduleResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/FeeScheduleV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    FeeScheduleBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/FeeScheduleV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    FeeScheduleRangeResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/FeeScheduleRangeV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    FeeScheduleRangeBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/FeeScheduleRangeV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    FeeScheduleAssociationsV1:
      type: object
      properties:
        locations:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                format: int64
                example: 1234
              name:
                type: string
        patients:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                format: int64
                example: 1234
              name:
                type: string
        providers:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                format: int64
                example: 1234
              name:
                type: string
        carrierInsurancePlans:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                format: int64
                example: 1234
              name:
                type: string
      example:
        locations:
          - id: 1234
            name: Example Name
        patients:
          - id: 1234
            name: Example Name
    ReferralSourceResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ReferralSourceV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ReferralSourceBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ReferralSourceV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    LocationResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/LocationV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          id: '1000000001027'
          type: LocationV1
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    LocationBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/LocationV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - id: '1000000001027'
            type: LocationV1
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    OperatoryResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OperatoryV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          id: '1000000002103'
          type: OperatoryV1
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    OperatoryBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OperatoryV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - id: '1000000002103'
            type: OperatoryV1
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    OrganizationResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OrganizationV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PracticeProcedureResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PracticeProcedureV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PracticeProcedureBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PracticeProcedureV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientProcedureResponseWrapper:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatientProcedure'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientProcedureBulkResponseWrapper:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientProcedure'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientProcedureCalcBulkResponseWrapper:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientProcedureCalc'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ProcedureMappingResponseWrapper:
      type: object
      properties:
        amount:
          type: number
          format: float
        practiceProcedure:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        amount: 1
        practiceProcedure:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
    ProcedureMapping:
      type: object
      required:
        - practiceProcedure
        - renderingProvider
        - patient
        - location
      properties:
        serviceDate:
          type: string
          format: date
          example: '2018-07-09'
        procedureTeeth:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                example: abc123
              procedureId:
                type: integer
                format: int64
                example: 987654321
              mesial:
                type: boolean
                example: true
              incisal:
                type: boolean
                example: false
              occlusal:
                type: boolean
                example: true
              distal:
                type: boolean
                example: false
              lingual:
                type: boolean
                example: true
              facial:
                type: boolean
                example: true
              buccal:
                type: boolean
                example: false
              classFive:
                type: boolean
                example: true
              toothId:
                type: string
                example: T123
              incisalOcclusal:
                type: boolean
                example: false
              facialBuccal:
                type: boolean
                example: true
        patient:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        updatedProcedure:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        practiceProcedure:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        renderingProvider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        location:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        patient:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        practiceProcedure:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        renderingProvider:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        location:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        serviceDate: '2018-07-09'
        procedureTeeth:
          - id: abc123
            procedureId: 987654321
    PatientProcedureCreateV1:
      allOf:
        - $ref: '#/components/schemas/PatientProcedureUpdateV1'
        - type: object
          description: >
            This Endpoint is being rate limited. More information can be found
            here: https://portal.hs1api.com/guide
          required:
            - practiceProcedure
            - renderingProvider
            - amount
            - state
            - status
            - patient
            - location
            - billToInsurance
          properties:
            id:
              type: integer
              format: int64
              readOnly: true
            unlock:
              type: boolean
              readOnly: true
              example: true
            lastModified:
              type: string
              format: date-time
              example: '2018-07-09T19:00:00.000Z'
              readOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            location:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
      example: {}
    PatientProcedureGraphResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatientProcedureGraphV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    VoidPatientProcedureResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatientProcedureVoidV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientProcedureResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatientProcedureV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          id: '9000003725942'
          type: PatientProcedureV1
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientProcedureBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientProcedureV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - id: '9000003725942'
            type: PatientProcedureV1
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientProcedureGraphBulkResponseV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientProcedureGraphV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientProcedureCalcResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatientProcedureCalcV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientProcedureCalcBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientProcedureCalcV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ProcedureMappingResponseWrapperV1:
      type: object
      properties:
        amount:
          type: number
          format: float
        practiceProcedure:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        amount: 1
        practiceProcedure:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
    ProcedureMappingV1:
      type: object
      required:
        - practiceProcedure
        - renderingProvider
        - patient
        - location
      properties:
        serviceDate:
          type: string
          format: date
          example: '2018-07-09'
        procedureTeeth:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                example: abc123
              procedureId:
                type: integer
                format: int64
                example: 987654321
              mesial:
                type: boolean
                example: true
              incisal:
                type: boolean
                example: false
              occlusal:
                type: boolean
                example: true
              distal:
                type: boolean
                example: false
              lingual:
                type: boolean
                example: true
              facial:
                type: boolean
                example: true
              buccal:
                type: boolean
                example: false
              classFive:
                type: boolean
                example: true
              toothId:
                type: string
                example: T123
              incisalOcclusal:
                type: boolean
                example: false
              facialBuccal:
                type: boolean
                example: true
        patient:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        updatedProcedure:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        practiceProcedure:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        renderingProvider:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        location:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        patient:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        practiceProcedure:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        renderingProvider:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        location:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        serviceDate: '2018-07-09'
        procedureTeeth:
          - id: abc123
            procedureId: 987654321
    PatientProcedureApptResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientProcedureApptV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientProcedureBulkResponseWrapperV2:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientProcedureV2'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TxCaseResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TxCaseV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          id: '9000000035908'
          type: TxCaseV1
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TxCaseBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TxCaseV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - id: '9000000035908'
            type: TxCaseV1
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TxCaseCreateV1:
      allOf:
        - $ref: '#/components/schemas/TxCaseUpdateV1'
        - type: object
          required:
            - user
            - name
            - patient
            - procedures
          properties:
            user:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            patient:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            procedures:
              type: array
              description: >
                These procedures will be added to the automatically created
                Visit after creation of TxCase and won't be returned back as a
                part of TxCase
              items:
                type: object
                description: >-
                  A reference to a linked model. Includes the id, the type, and
                  URL at which the model can be accessed.
                required:
                  - id
                  - url
                properties:
                  id:
                    type: integer
                    format: int64
                    description: The unique identifier for the linked model.
                    example: 12345
                  type:
                    type: string
                    description: The type of the linked model. This field is read-only.
                    example: ExampleModelType
                    readOnly: true
                  url:
                    type: string
                    format: uri
                    description: >-
                      The URL at which the linked model can be accessed. This
                      field is read-only.
                    example: https://api.example.com/models/12345
                    readOnly: true
      example: {}
    TxCaseCalcResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TxCaseCalcV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TxCaseCalcBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TxCaseCalcV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TxCaseAmountResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TxCaseAmountV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    VisitResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/VisitV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          id: '9000000038237'
          type: VisitV1
          lastModified: '2024-01-12T15:58:19.443Z'
          sequence: 0
          duration: 60
          visitProceduresOrderType: TEETH
          descProceduresOrder: false
          txCase:
            id: '9000000035908'
            type: TxCaseV1
          procedures:
            - id: '9000003725942'
              type: PatientProcedureV1
            - id: '9000003725946'
              type: PatientProcedureV1
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    VisitBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/VisitV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - id: '9000000038237'
            type: VisitV1
            lastModified: '2024-01-12T15:58:19.443Z'
            sequence: 0
            duration: 60
            visitProceduresOrderType: TEETH
            descProceduresOrder: false
            txCase:
              id: '9000000035908'
              type: TxCaseV1
            procedures:
              - id: '9000003725942'
                type: PatientProcedureV1
              - id: '9000003725946'
                type: PatientProcedureV1
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    EventResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EventV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    EventBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EventV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TransactionResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TransactionFullV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TransactionBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TransactionFullV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TransactionPatientPaymentResWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TransactionPatientPaymentV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TransactionPatientPaymentBulkResWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TransactionPatientPaymentV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TransactionInsurancePaymentResWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TransactionInsurancePaymentV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TransactionInsurPaymentBulkResWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TransactionInsurancePaymentV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TransactionProcedureResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TransactionProcedureV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TransactionProcedureBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TransactionProcedureV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TransactionAdjustmentResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TransactionAdjustmentV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TransactionAdjustmentBulkResWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TransactionAdjustmentV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TotalCountResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TotalCountV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    GlobalProcedureResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/GlobalProcedureV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    GlobalProcedureBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GlobalProcedureV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    GlobalInsuranceCarrierResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/GlobalInsuranceCarrierV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    GlobalInsuranceCarrierBulkResponWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GlobalInsuranceCarrierV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    InsuranceCarrierResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/InsuranceCarrierV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    InsuranceCarrierBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/InsuranceCarrierV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    AuditBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AuditV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    LocationHourBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/LocationHourV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    LocationHourResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/LocationHourV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    MissedAppointmentResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/MissedAppointmentV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    MissedAppointmentBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/MissedAppointmentV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    AgingBalanceResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AgingBalanceV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    AgingBalanceRptResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AgingBalanceReportV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientRecareResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatientRecareV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientRecareBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientRecareV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientRecareCreateWrapperV1:
      type: object
      required:
        - dueDate
        - patient
        - recareTemplate
        - status
        - intervalUnit
        - interval
        - location
      properties:
        id:
          type: integer
          format: int64
        dueDate:
          type: string
          format: date
          example: '2024-05-02'
        serviceDate:
          type: string
          format: date
          example: '2024-05-02'
        postedDate:
          type: string
          format: date
          example: '2024-05-02'
        lastModified:
          type: string
          format: date-time
          example: '2018-07-09T19:00:00.000Z'
          readOnly: true
        status:
          type: string
          enum:
            - ADDED
            - WRONG
            - UPDATED
          example: UPDATED
        intervalUnit:
          type: string
          enum:
            - WEEK
            - MONTH
            - YEAR
          example: WEEK
        interval:
          type: integer
          format: int64
          minimum: 1
          maximum: 99
          example: 99
        scheduledAppointment:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        patient:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        location:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        recareTemplate:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
        user:
          type: object
          description: >-
            A reference to a linked model. Includes the id, the type, and URL at
            which the model can be accessed.
          required:
            - id
            - url
          properties:
            id:
              type: integer
              format: int64
              description: The unique identifier for the linked model.
              example: 12345
            type:
              type: string
              description: The type of the linked model. This field is read-only.
              example: ExampleModelType
              readOnly: true
            url:
              type: string
              format: uri
              description: >-
                The URL at which the linked model can be accessed. This field is
                read-only.
              example: https://api.example.com/models/12345
              readOnly: true
      example:
        dueDate: '2024-05-02'
        status: UPDATED
        intervalUnit: WEEK
        interval: 99
        patient:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        location:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        recareTemplate:
          id: 12345
          url: https://api.example.com/models/12345
          type: ExampleModelType
        id: 12445
        serviceDate: '2024-05-02'
    PatientStatementResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatientStatementV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientStatementBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientStatementV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    RecareTemplateResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/RecareTemplateV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    RecareTemplateBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RecareTemplateV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientNoteResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatientNoteV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientNoteBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientNoteV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TransactionTagResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TransactionTagV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TransactionTagBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TransactionTagV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    MedicalAlertBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/MedicalAlertV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    MedicalAlertResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/MedicalAlertV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    MedicalAlertCategoryResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/MedicalAlertCategoryV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    MedicalAlertCategoryBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/MedicalAlertCategoryV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    MedicalAlertReactionResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/MedicalAlertReactionV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    MedicalAlertReactionBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/MedicalAlertReactionV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    MedicalAlertSeverityResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/MedicalAlertSeverityV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    MedicalAlertSeverityBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/MedicalAlertSeverityV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientMedicalAlertBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientMedicalAlertV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientMedicalAlertResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatientMedicalAlertV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TeethBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ToothV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientTeethWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientToothV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientConditionBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientConditionV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientConditionResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatientConditionV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientPrescriptionBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientPrescriptionV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientPrescriptionResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatientPrescriptionV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientPrescriptionUpdateWrapperV1:
      type: object
      required:
        - voidStatus
      properties:
        id:
          type: integer
          format: int64
        voidStatus:
          type: object
          required:
            - user
            - voidReason
          properties:
            user:
              type: object
              description: >-
                A reference to a linked model. Includes the id, the type, and
                URL at which the model can be accessed.
              required:
                - id
                - url
              properties:
                id:
                  type: integer
                  format: int64
                  description: The unique identifier for the linked model.
                  example: 12345
                type:
                  type: string
                  description: The type of the linked model. This field is read-only.
                  example: ExampleModelType
                  readOnly: true
                url:
                  type: string
                  format: uri
                  description: >-
                    The URL at which the linked model can be accessed. This
                    field is read-only.
                  example: https://api.example.com/models/12345
                  readOnly: true
            dateVoided:
              type: string
              format: date
              example: '2024-05-10T00:00:00.000Z'
              readOnly: true
            voidReason:
              type: string
              enum:
                - MISTAKE
                - OTHER
                - ALLERGIC_REACTION
                - OTHER_REACTION
                - INEFFECTIVE
                - MISTAKE_NOT_PRESCRIBED
              example: OTHER
            note:
              type: string
              maxLength: 250
      example:
        voidStatus:
          user:
            id: 12345
            url: https://api.example.com/models/12345
            type: ExampleModelType
          voidReason: OTHER
          dateVoided: '2024-05-10T00:00:00.000Z'
          note: note
        id: 12445
    DrugCategoryBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PrescriptionDrugCategoryV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PrescriptionDrugCategoryResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PrescriptionDrugCategoryV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PrescriptionDrugUnitBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PrescriptionDrugUnitV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PrescriptionDrugUnitResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PrescriptionDrugUnitV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PrescriptionTemplateBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PrescriptionTemplateV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PrescriptionTemplateResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PrescriptionTemplateV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    SubscriberInsurancePlanBulkResWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SubscriberInsurancePlanV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    SubscriberInsurancePlanResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SubscriberInsurancePlanV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    CarrierInsurancePlanBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CarrierInsurancePlanV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    CarrierInsurancePlanResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CarrierInsurancePlanV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    CarrierInsurPlanCoordOfBenefBulkResWrapV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CarrierInsurPlanCoordinationOfBenefitsV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    CarrierInsurPlanCoordOfBenefResWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CarrierInsurPlanCoordinationOfBenefitsV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientInsurancePlanBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientInsurancePlanV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientInsurancePlanResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatientInsurancePlanV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    OrgConditionBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationConditionV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    OrganizationConditionResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OrganizationConditionV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    GlobalProcMappingRuleBulkResWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GlobalProcedureMappingRuleV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    GlobalProcMappingRuleResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/GlobalProcedureMappingRuleV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ProcedureCategoryBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProcedureCategoryV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    DocumentResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DocumentV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    DocumentBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/DocumentV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    DocumentResponseUpdateWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DocumentUpdateV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    DocumentTagBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/DocumentTagV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ClinicalNoteResponseWrapper:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ClinicalNote'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ClinicalNoteBulkResponseWrapper:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ClinicalNote'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ClinicalNoteResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ClinicalNoteV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          datedAs: '2019-07-18'
          text: Tester provider note
          patient:
            id: 1000000020701
          provider:
            id: 1000000002089
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ClinicalNoteBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ClinicalNoteV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - datedAs: '2019-07-18'
            text: Tester provider note
            patient:
              id: 1000000020701
            provider:
              id: 1000000002089
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    UserResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UserV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    UserBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/UserV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    UserFavoriteResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ClinicalNoteTemplateUserFavoriteV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    UserFavoriteBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ClinicalNoteTemplateUserFavoriteV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    OrganizationLedgerTypeResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OrganizationLedgerTypeV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          id: 9000000000001
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    OrganizationLedgerTypeBulkRespWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationLedgerTypeV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - id: 9000000000001
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    CoverageProcedureRangeResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CoverageProcedureRangeV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    CoverageProcedureRangeBulkRespWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CoverageProcedureRangeV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    CoverageProcedRangeTemplateRespWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CoverageProcedureRangeTemplateV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    CoverageProcedRangeTemplBulkRespWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CoverageProcedureRangeTemplateV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    CoverageProcedureCopayResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CoverageProcedureCopayV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    CoverageProcedureCopayBulkRespWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CoverageProcedureCopayV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    CarrierPlanDeductibleResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CarrierPlanDeductibleV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    CarrierPlanDeductBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CarrierPlanDeductibleV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    CarrierPlanCovExceptionRespWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CarrierPlanCoverageExceptionV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    CarrierPlanCovExceptBulkRespWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CarrierPlanCoverageExceptionV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    CarrierPlanCopayExceptionRespWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CarrierPlanCopayExceptionV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    CarrierPlanCopayExceptBulkRespWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CarrierPlanCopayExceptionV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PerioExamResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PerioExamV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PerioExamBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PerioExamV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PerioProbeResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PerioProbeV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PerioProbeBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PerioProbeV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    DefaultPlanCoverageResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DefaultPlanCoverageV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    DefaultPlanCoverageBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/DefaultPlanCoverageV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ClinicalNotePromptResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ClinicalNotePromptV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ClinicalNotePromptBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ClinicalNotePromptV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ClinicalNoteTemplateResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ClinicalNoteTemplateV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ClinicalNoteTemplateBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ClinicalNoteTemplateV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    GlobalCNTemplateBulkResponseWrapper:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GlobalClinicalNoteTemplate'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    GlobalCNPromptBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GlobalClinicalNotePromptV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    DentalLabResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DentalLabV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          id: 9000000000001
          name: asdf
          phone: '1112223333'
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    DentalLabBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/DentalLabV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - id: 9000000000001
            name: asdf
            phone: '1112223333'
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    DayNoteResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DayNoteV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    DayNoteBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/DayNoteV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    SignatureResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SignatureV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          data: c2lnbmVkdGVzdGRhdGE=
          organizationId: 9007
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    SignatureBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SignatureV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - data: c2lnbmVkdGVzdGRhdGE=
            organizationId: 9007
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientBookingAvailabilityResWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatientBookingAvailabilityV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientBookingAvailabilityBlkResWrapV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientBookingAvailabilityV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ScheduleTemplateResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ScheduleTemplateV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ScheduleTemplateBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ScheduleTemplateV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ScheduleTemplateApptReasonResWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ScheduleTemplateApptReasonV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ScheduleTemplateApptReasonBlkResWrapV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ScheduleTemplateApptReasonV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ScheduleTemplateReasonResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ScheduleTemplateReasonV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ScheduleTemplateReasonBulkResWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ScheduleTemplateReasonV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    InsuranceClaimResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/InsuranceClaimV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    InsuranceClaimBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/InsuranceClaimV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ClaimAttachmentResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ClaimAttachmentV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ClaimAttachmentBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ClaimAttachmentV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ImageAttachmentResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ImageAttachmentV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ImageAttachmentBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ImageAttachmentV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ICD10BulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ICD10V1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ICD10ResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ICD10V1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    SMSNumberResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SMSNumberV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    SMSNumberBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SMSNumberV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ScheduleOpeningResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ScheduleOpeningsV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ColorCategoryResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ColorCategoryV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ColorCategoryBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ColorCategoryV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    AppointmentColorResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AppointmentColorV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          id: 1000000001027
          mainArea: PROVIDER_COLOR
          additionalArea: ADDITIONAL_PROVIDER_COLOR
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    AppointmentColorBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AppointmentColorV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - id: 1000000001027
            mainArea: PROVIDER_COLOR
            additionalArea: ADDITIONAL_PROVIDER_COLOR
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    OrganizationLedgerRulesResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OrganizationLedgerRulesV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    OrganizationLedgerRulesBulkResWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationLedgerRulesV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    LocationPovertyLevelBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/LocationPovertyLevelV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    LocationPovertyLevelResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/LocationPovertyLevelV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    LocationExcludedProcedureResWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/LocationWithExcludedProcedureV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    LocationExcludedProcedureBulkResWrapV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/LocationWithExcludedProcedureV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    LocationClaimDefaultsResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/LocationClaimDefaultsV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    LocationClaimDefaultBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/LocationClaimDefaultsV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    InsCarrierExcludedProcBulkResWrapV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/InsuranceCarrierWithExcludedProcedureV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    InsCarrierExcludedProcResWrapV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/InsuranceCarrierWithExcludedProcedureV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    StreamAPIUsageBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/StreamAPIUsageV1'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        meta: {}
    StreamAPIUsageQueueResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/StreamAPIUsageQueueV1'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        meta: {}
    BulkInsurancePaymentResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BulkInsurancePaymentV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    BulkInsurancePaymentBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/BulkInsurancePaymentV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ExamResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ExamV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ExamBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ExamV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ProductionCollectionBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProductionCollectionV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ProductionCollectionResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ProductionCollectionV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ProductionGrossBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProductionGrossV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ProductionNetActualBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProductionNetActualV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ProductionNetScheduleBulkResWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProductionNetScheduledV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    ProductionNetScheduleAsyncResponseV1:
      type: object
      description: >
        Async data retrieval response for Production Net Schedule reports.


        This response is returned immediately when an async request is
        submitted. The actual report data

        will be delivered via the StreamingAPI using the provided routing key
        when processing completes.
      required:
        - data
        - statusCode
      properties:
        data:
          type: object
          description: Contains the async processing information
          required:
            - correlationId
            - routingKey
            - message
          properties:
            correlationId:
              type: string
              description: >-
                Unique identifier to correlate this async request with the
                results delivered via StreamingAPI
              example: 550e8400-e29b-41d4-a716-446655440000
            routingKey:
              type: string
              description: >-
                StreamingAPI routing key where the final results will be
                published
              example: org123.456.ProductionNetSchedule.ASYNC-GET
              pattern: ^[a-zA-Z0-9]+\.[0-9-]+\.ProductionNetSchedule\.ASYNC-GET$
            message:
              type: string
              description: Confirmation message indicating the request status
              example: >-
                Request received, once it has finished processing the requested
                data will be sent to the StreamingAPI
        statusCode:
          type: integer
          description: HTTP status code
          example: 200
          enum:
            - 200
        warnings:
          type: array
          description: Array of warning messages (optional)
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          description: Array of error messages (optional)
          items:
            $ref: '#/components/schemas/Error'
      example:
        data:
          correlationId: 550e8400-e29b-41d4-a716-446655440000
          routingKey: org123.456.ProductionNetSchedule.ASYNC-GET
          message: >-
            Request received, once it has finished processing the requested data
            will be sent to the StreamingAPI
        statusCode: 200
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
        errors:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientPaymentPlanResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PatientPaymentPlanV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    PatientPaymentPlanBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatientPaymentPlanV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TransferReasonResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TransferReasonV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TransferReasonBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TransferReasonV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TimeClockResponseWrapperV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TimeClockV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      example:
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    TimeClockBulkResponseWrapperV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TimeClockV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        meta:
          type: object
          properties:
            pagination:
              $ref: '#/components/schemas/Pagination'
      example:
        data:
          - {}
        warnings:
          - code: VALIDATION_ERROR
            title: Validation Failed
            description: The provided data does not meet the required validation rules.
            source: request.body
    UsageReportResponseV1:
      type: object
      properties:
        statusCode:
          type: number
          example: 200
        data:
          type: object
          properties:
            usagePerEndpoint:
              type: array
              items:
                $ref: '#/components/schemas/UsageReportItemV1'
      example:
        statusCode: 200
        data:
          usagePerEndpoint:
            - {}
  responses: {}
  requestBodies: {}
  parameters:
    OrganizationId:
      name: Organization-ID
      in: header
      required: true
      schema:
        type: string
        example: '1006'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    oAuthSandbox:
      type: oauth2
      description: OAuth 2.0 client credentials (Sandbox)
      flows:
        clientCredentials:
          tokenUrl: https://test.hs1api.com/oauth/client_credential/accesstoken
          scopes: {}
