openapi: 3.1.0
info:
  title: Air Doctor
  description: Public API for Air Doctor backend
  version: v2.0
servers:
  - url: https://dev.air-dr.com
    description: DEV server
  - url: https://test.air-dr.com
    description: TEST server
  - url: https://prod.air-dr.com
    description: PROD server
  - url: https://demo.air-dr.com
    description: DEMO server
  - url: http://127.0.0.1:5000
    description: LOCAL server
paths:
  /api/v2/token:
    post:
      tags:
        - Account Management
      summary: Creates or updates the user and returns user's access token
      operationId: tokenUpdate
      parameters:
        - name: X-Token
          in: header
          description: Access Token
          schema:
            type: string
          example: >-
            351c6476ca9d7d3efb72eb4595d7ce2f4f3d39de52c98ccdb2ef2a87e357aaea4777a3feafe1b32e6a1dbf20374337f7fefc
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUpdateDto'
        required: true
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TokenStatusDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/token/update:
    post:
      tags:
        - Account Management
      summary: Updates user details, returning minimum information (fast call)
      operationId: tokenUpdateQuiet
      parameters:
        - name: X-Token
          in: header
          description: Access Token
          schema:
            type: string
          example: >-
            351c6476ca9d7d3efb72eb4595d7ce2f4f3d39de52c98ccdb2ef2a87e357aaea4777a3feafe1b32e6a1dbf20374337f7fefc
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUpdateDto'
        required: true
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MinTokenStatusDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/token/reset-password:
    post:
      tags:
        - Account Management
      summary: >-
        Requests a reset password email (the email is sent automatically and
        immediately by the system)
      operationId: userResetPassword
      parameters:
        - name: email
          in: query
          description: Email Address
          required: true
          schema:
            type: string
          example: test@air-dr.com
      responses:
        '200':
          description: Call successful
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/token/policies:
    post:
      tags:
        - User's Insurance
      summary: Requests an addition of a policy to the user's account
      operationId: tokenPolicyAdd
      parameters:
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MapInsuranceIdFieldsEnumString'
        required: true
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TokenStatusDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/token/policies/{id}/cancel:
    post:
      tags:
        - User's Insurance
      summary: Requests policy removal from the user's account
      operationId: tokenPolicyCancel
      parameters:
        - name: id
          in: path
          description: Policy ID
          required: true
          schema:
            type: integer
            format: int32
          example: 123
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TokenStatusDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/token/policies/update:
    post:
      tags:
        - User's Insurance
      summary: >-
        Requests an addition of a policy to the user's account (fast call, not
        returning updated user)
      operationId: tokenPolicyQuietAdd
      parameters:
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MapInsuranceIdFieldsEnumString'
        required: true
      responses:
        '200':
          description: Call successful
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/token/policies/contact:
    post:
      tags:
        - User's Insurance
      summary: >-
        Request contact (callback) from insurance company (for supporting
        companies)
      operationId: tokenContactInsurance
      parameters:
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactInsuranceDto'
        required: true
      responses:
        '200':
          description: Call successful
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/token/people:
    post:
      tags:
        - Account Management
      summary: >-
        Adds or updates a person under the policy or for the user outside of
        policy
      operationId: tokenPolicyPatient
      parameters:
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonAdditionDto'
        required: true
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TokenStatusDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/token/invalidate:
    post:
      tags:
        - Account Management
      summary: Invalidates the token (effectively - log out)
      operationId: tokenInvalidate
      parameters:
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      responses:
        '200':
          description: Call successful
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/token/delete-user:
    post:
      tags:
        - Account Management
      summary: Deletes the specified user from Air-Doctor database
      operationId: deleteUser
      parameters:
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      requestBody:
        content:
          application/json:
            schema:
              type: string
              description: User's password (used to confirm the request)
        required: true
      responses:
        '200':
          description: Call successful
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/promo-codes/verify:
    post:
      tags:
        - Promo code Management
      summary: >-
        Checks if a provided promo code is valid for a specific location and
        patient
      operationId: verifyPromoCode
      parameters:
        - name: promoCodeKey
          in: query
          description: The unique identifier of the promo code to be verified
          required: true
          schema:
            type: string
        - name: patientId
          in: query
          description: The ID of the patient who wants to use the promo code
          required: true
          schema:
            type: integer
            format: int32
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      requestBody:
        content:
          application/json:
            schema:
              type: array
              description: The location types where the promo code is intended to be used
              items:
                type: string
                enum:
                  - HOME_VISIT
                  - CLINIC_VISIT
                  - VIDEO_VISIT
        required: true
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PromoCodeDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/policies:
    get:
      tags:
        - Policies Management
      summary: >-
        Wildcard query of insurance policies (insurance carrier use only;
        returns up to 1000 records)
      operationId: getPolicies
      parameters:
        - name: search
          in: query
          description: >-
            Query (% and _ wildcards are accepted; policy numbers exclude
            leading zeros and any non-alphanumeric characters)
          required: true
          schema:
            type: string
          example: '%123456789%'
        - name: fromDate
          in: query
          description: >-
            Filter by: from creation date. Requires both dates(from/to), if
            uses.
          required: false
          schema:
            type: string
            format: date-time
          example: 2022-03-07T00:00
        - name: toDate
          in: query
          description: 'Filter by: to creation date. Requires both dates(from/to), if uses.'
          required: false
          schema:
            type: string
            format: date-time
          example: 2022-04-07T00:00
        - name: scopeType
          in: query
          description: >-
            Filter by: the scope type for policies. Not required. Defaults to
            'ALL' if not provided.
          required: false
          schema:
            type: string
            default: ALL
            enum:
              - ALL
              - ASSISTANCE
              - API
          example: ALL
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InsurancePolicyWithPeopleDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
    post:
      tags:
        - Policies Management
      summary: Upload or update policies (insurance carrier use only)
      operationId: savePolicies
      parameters:
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      requestBody:
        content:
          application/json:
            schema:
              type: array
              description: Insurance Policies to Ingest
              items:
                $ref: '#/components/schemas/InsurancePolicyWithPeopleDto'
        required: true
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InsurancePolicyWithPeopleDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/policies/{policyId}/travel-dates:
    post:
      tags:
        - Policies Management
      summary: Upload or update policy travel-dates (insurance carrier use only)
      operationId: saveTravelDates
      parameters:
        - name: policyId
          in: path
          required: true
          schema:
            type: integer
            format: int32
        - name: subscriber
          in: query
          required: true
          schema:
            type: integer
            format: int32
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/TravelDatesDto'
        required: true
      responses:
        '200':
          description: Call successful
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/policies/{policyId}/overrides:
    get:
      tags:
        - Policies Management
      summary: Get policy overrides
      operationId: getPolicyOverrideByPolicyId
      parameters:
        - name: policyId
          in: path
          required: true
          schema:
            type: integer
            format: int32
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OverriddenPolicyRulesGetDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
    post:
      tags:
        - Policies Management
      summary: Create policy override
      operationId: savePolicyOverrides
      parameters:
        - name: policyId
          in: path
          required: true
          schema:
            type: integer
            format: int32
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OverriddenPolicyRulesDto'
        required: true
      responses:
        '200':
          description: Call successful
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/policies/{policyId}/next-visit:
    post:
      tags:
        - Policies Management
      summary: Returns patient's or policy's status for next appointment
      operationId: getActiveStatus
      parameters:
        - name: policyId
          in: path
          required: true
          schema:
            type: integer
            format: int32
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsurerStateDto'
        required: true
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/InsurerStateResponseDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/policies/{policyId}/next-visit-client:
    post:
      tags:
        - Policies Management
      summary: Returns patient's or policy's status for next appointment
      operationId: getClientActiveStatus
      parameters:
        - name: policyId
          in: path
          required: true
          schema:
            type: integer
            format: int32
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsurerStateDto'
        required: true
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CommonInsurerStateResponseDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/policies/web-hook:
    post:
      tags:
        - Policies Management
      summary: >-
        Policy request webhook — this is a sample function definition intended
        to describe the webhook call format (in AirDoctor server this is a NOP
        call)
      operationId: policyWebHookSpec
      parameters:
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MapInsuranceIdFieldsEnumString'
        required: true
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/InsurancePolicyWithPeopleDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/appointments:
    get:
      tags:
        - Appointments Management
      summary: Returns the list of appointments for the user
      operationId: getAppointments
      parameters:
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AppointmentGetDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
    post:
      tags:
        - Appointments Management
      summary: Creates or updates an appointments
      operationId: saveAppointments
      parameters:
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AppointmentPostDto'
        required: true
      responses:
        '200':
          description: Call successful
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/appointments/{id}/video-token:
    post:
      tags:
        - Appointments Management
      summary: Returns a token for the video appointment
      operationId: getVideoAppointmentToken
      parameters:
        - name: id
          in: path
          description: Appointment ID
          required: true
          schema:
            type: integer
            format: int32
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/VideoVisitTokenDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/appointments/{id}/video-token/dispatch:
    post:
      tags:
        - Appointments Management
      summary: Returns a token for the video appointment
      operationId: getVideoAppointmentToken_1
      parameters:
        - name: id
          in: path
          description: Appointment ID
          required: true
          schema:
            type: integer
            format: int32
        - name: dispatch
          in: query
          required: true
          schema:
            type: string
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/VideoVisitTokenDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/appointments/web-hook:
    post:
      tags:
        - Appointments Management
      summary: >-
        Appointment webhook — this is a sample function definition intended to
        describe the webhook call format (in AirDoctor server this is a NOP
        call)
      operationId: appointmentWebHookSpec
      parameters:
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppointmentHookDto'
        required: true
      responses:
        '200':
          description: Call successful
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/appointments/suggest-video:
    post:
      tags:
        - Appointments Management
      summary: >-
        Creates a set of video appointment requests, based on an automated
        algorithm
      operationId: suggestAppointment
      parameters:
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppointmentPostDto'
        required: true
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TokenStatusDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/appointments/suggest-offline:
    post:
      tags:
        - Appointments Management
      summary: >-
        Creates a face to face appointment requests, based on an automated
        algorithm
      operationId: suggestOfflineAppointment
      parameters:
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppointmentPostDto'
        required: true
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TokenStatusDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/appointments/asap-price-range:
    post:
      tags:
        - Appointments Management
      summary: >-
        Get profiles price range by available location type for offline asap
        visits
      operationId: getOfflineAsapPriceRange
      parameters:
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OfflineAsapRequestParamDto'
        required: true
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProfilePriceRangeDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/appointment:
    post:
      tags:
        - Appointments Management
      summary: Creates or updates an appointment
      operationId: saveAppointment
      parameters:
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppointmentPostDto'
        required: true
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TokenStatusDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/token/verify:
    get:
      tags:
        - Account Management
      summary: Checks whether a user with the specified email is already registered
      operationId: validateEmail
      parameters:
        - name: email
          in: query
          description: Email Address
          required: true
          schema:
            type: string
          example: test@air-dr.com
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PasswordHintDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/token/user-data.zip:
    get:
      tags:
        - Account Management
      summary: >-
        Downloads all the data, stored by Air-Doctor about the user (as a single
        ZIP file)
      operationId: downloadAccountData
      parameters:
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      responses:
        '200':
          description: Call successful
          content:
            multipart/mixed:
              schema:
                type: string
                format: byte
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/reports/report.xlsx:
    get:
      tags:
        - Report Management
      operationId: downloadReport
      parameters:
        - name: companyId
          in: query
          description: ID of the company for which the report is requested
          required: true
          schema:
            type: integer
            format: int32
          example: 16
        - name: reportId
          in: query
          description: ID of the report which is requested
          required: true
          schema:
            type: integer
            format: int32
          example: 1
        - name: fromDate
          in: query
          description: Start date of the period for which the report is requested
          required: false
          schema:
            type: string
            format: date
          example: '2022-01-01'
        - name: toDate
          in: query
          description: End date of the period for which the report is requested
          required: false
          schema:
            type: string
            format: date
          example: '2022-01-01'
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      responses:
        '200':
          description: Call successful
          content:
            multipart/mixed:
              schema:
                type: string
                format: byte
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/profiles/{id}/reviews:
    get:
      tags:
        - Appointments Management
      summary: Returns previously left and confirmed reviews for the profile
      operationId: getProfileReviews
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            format: int32
        - name: startAt
          in: query
          required: true
          schema:
            type: integer
            format: int32
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReviewDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/profiles/by-profile-ids:
    get:
      tags:
        - Appointments Management
      summary: Returns profiles, based on list of Profile IDs
      operationId: getProfilesForApp
      parameters:
        - name: ids
          in: query
          description: List of profile Ids to retrieve
          required: true
          schema:
            type: array
            items:
              type: integer
              format: int32
        - name: policy-id
          in: query
          description: Policy Id associated with the request.
          required: true
          schema:
            type: integer
            format: int32
        - name: patient-id
          in: query
          description: Patient Id for whom the profiles are being requested.
          required: true
          schema:
            type: integer
            format: int32
        - name: excluded-appointment-id
          in: query
          description: Appointment Id to be excluded from the results.
          required: false
          schema:
            type: integer
            format: int32
        - name: country
          in: query
          description: Country associated with the request. Optional.
          required: false
          schema:
            type: string
            enum:
              - AD
              - AE
              - AF
              - AG
              - AI
              - AL
              - AM
              - AO
              - AR
              - AS
              - AT
              - AU
              - AW
              - AX
              - AZ
              - BA
              - BB
              - BD
              - BE
              - BF
              - BG
              - BH
              - BI
              - BJ
              - BL
              - BM
              - BN
              - BO
              - BQ
              - BR
              - BS
              - BT
              - BV
              - BW
              - BY
              - BZ
              - CA
              - CC
              - CD
              - CF
              - CG
              - CH
              - CI
              - CK
              - CL
              - CM
              - CN
              - CO
              - CR
              - CU
              - CV
              - CW
              - CX
              - CY
              - CZ
              - DE
              - DJ
              - DK
              - DM
              - DO
              - DZ
              - EC
              - EE
              - EG
              - EH
              - ER
              - ES
              - ET
              - FI
              - FJ
              - FK
              - FM
              - FO
              - FR
              - GA
              - GB
              - GD
              - GE
              - GF
              - GG
              - GH
              - GI
              - GL
              - GM
              - GN
              - GP
              - GQ
              - GR
              - GS
              - GT
              - GU
              - GW
              - GY
              - HK
              - HN
              - HR
              - HT
              - HU
              - ID
              - IE
              - IL
              - IM
              - IN
              - IO
              - IQ
              - IR
              - IS
              - IT
              - JE
              - JM
              - JO
              - JP
              - KE
              - KG
              - KH
              - KI
              - KM
              - KN
              - KP
              - KR
              - KW
              - KY
              - KZ
              - LA
              - LB
              - LC
              - LI
              - LK
              - LR
              - LS
              - LT
              - LU
              - LV
              - LY
              - MA
              - MC
              - MD
              - ME
              - MF
              - MG
              - MH
              - MK
              - ML
              - MM
              - MN
              - MO
              - MQ
              - MR
              - MS
              - MT
              - MU
              - MV
              - MW
              - MX
              - MY
              - MZ
              - NA
              - NC
              - NE
              - NF
              - NG
              - NI
              - NL
              - 'NO'
              - NP
              - NR
              - NU
              - NZ
              - OM
              - PA
              - PE
              - PF
              - PG
              - PH
              - PK
              - PL
              - PM
              - PN
              - PR
              - PS
              - PT
              - PW
              - PY
              - QA
              - RE
              - RO
              - RS
              - RU
              - RW
              - SA
              - SB
              - SC
              - SD
              - SE
              - SG
              - SH
              - SI
              - SJ
              - SK
              - SL
              - SM
              - SN
              - SO
              - SR
              - SS
              - ST
              - SV
              - SX
              - SY
              - SZ
              - TC
              - TD
              - TF
              - TG
              - TH
              - TJ
              - TK
              - TL
              - TM
              - TN
              - TO
              - TR
              - TT
              - TV
              - TW
              - TZ
              - UA
              - UG
              - UM
              - US
              - UY
              - UZ
              - VA
              - VC
              - VE
              - VG
              - VI
              - VN
              - VU
              - WF
              - WS
              - YE
              - YT
              - ZA
              - ZM
              - ZW
              - XK
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProfileDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/profiles/by-profile-ids-and-location:
    get:
      tags:
        - Appointments Management
      summary: Returns profiles, based on list of Profile IDs and given coordinates
      operationId: getProfilesForApp_1
      parameters:
        - name: ids
          in: query
          description: List of profile Ids to retrieve
          required: true
          schema:
            type: array
            items:
              type: integer
              format: int32
        - name: policy-id
          in: query
          description: Policy Id associated with the request.
          required: true
          schema:
            type: integer
            format: int32
        - name: patient-id
          in: query
          description: Patient Id for whom the profiles are being requested.
          required: true
          schema:
            type: integer
            format: int32
        - name: excluded-appointment-id
          in: query
          description: Appointment Id to be excluded from the results.
          required: false
          schema:
            type: integer
            format: int32
        - name: latitude
          in: query
          description: Latitude of the location for filtering profiles.
          required: true
          schema:
            type: number
            format: double
        - name: longitude
          in: query
          description: Longitude of the location for filtering profiles.
          required: true
          schema:
            type: number
            format: double
        - name: check-home-distance
          in: query
          description: >-
            Flag to indicate whether to check the distance from the home
            location.
          required: false
          schema:
            type: boolean
            default: false
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProfileDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/profiles/by-location:
    get:
      tags:
        - Appointments Management
      summary: Returns profiles, based on user Latitude and Longitude
      operationId: getProfilesForApp_2
      parameters:
        - name: latitude
          in: query
          description: Latitude of the location for filtering profiles.
          required: true
          schema:
            type: number
            format: double
        - name: longitude
          in: query
          description: Longitude of the location for filtering profiles.
          required: true
          schema:
            type: number
            format: double
        - name: policy-id
          in: query
          description: Policy Id associated with the request.
          required: true
          schema:
            type: integer
            format: int32
        - name: patient-id
          in: query
          description: Patient Id for whom the profiles are being requested.
          required: true
          schema:
            type: integer
            format: int32
        - name: check-home-distance
          in: query
          description: >-
            Flag to indicate whether to check the distance from the home
            location.
          required: false
          schema:
            type: boolean
            default: false
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProfilesListDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/policies/profiles-availability:
    get:
      tags:
        - Insurer Management
      summary: >-
        Returns information about the availability of profiles according to the
        specified parameters
      operationId: getProfilesAvailability
      parameters:
        - name: latitude
          in: query
          required: true
          schema:
            type: number
            format: double
        - name: longitude
          in: query
          required: true
          schema:
            type: number
            format: double
        - name: companyId
          in: query
          required: true
          schema:
            type: integer
            format: int32
        - name: specialty
          in: query
          required: true
          schema:
            type: string
            enum:
              - GENERAL
              - DENTIST
              - ORTHOPEDIST
              - PEDIATRICIAN
              - GYNECOLOGIST
              - PULMONOLOGIST
              - GASTROENTEROLOGIST
              - OPHTALMOLOGIST
              - DERMATOLOGIST
              - NEUROLOGIST
              - ENT
              - PSYCHIATRIST
              - CARDIOLOGIST
              - UROLOGIST
              - ALTERNATIVE
              - OTHER
              - EMERGENCY
              - MORE
              - MASSEUSE
              - ONCOLOGIST
              - SURGEON
              - INTERNIST
              - HEMATOLOGIST
              - NEPHROLOGIST
              - RHEUMATOLOGIST
              - GERIATRICIAN
              - ALLERGOLOGIST
              - ONLINE_DOCTOR
              - IMAGING
              - LABS
        - name: language
          in: query
          required: true
          schema:
            type: string
            enum:
              - AA
              - AB
              - AE
              - AF
              - AK
              - AM
              - AN
              - AR
              - AS
              - AV
              - AY
              - AZ
              - BA
              - BE
              - BG
              - BH
              - BI
              - BM
              - BN
              - BO
              - BR
              - BS
              - CA
              - CE
              - CH
              - CO
              - CR
              - CS
              - CU
              - CV
              - CY
              - DA
              - DE
              - DV
              - DZ
              - EE
              - EL
              - EN
              - EO
              - ES
              - ET
              - EU
              - FA
              - FF
              - FI
              - FJ
              - FO
              - FR
              - FY
              - GA
              - GD
              - GL
              - GN
              - GU
              - GV
              - HA
              - HE
              - HI
              - HO
              - HR
              - HT
              - HU
              - HY
              - HZ
              - IA
              - ID
              - IE
              - IG
              - II
              - IK
              - IO
              - IS
              - IT
              - IU
              - JA
              - JV
              - KA
              - KG
              - KI
              - KJ
              - KK
              - KL
              - KM
              - KN
              - KO
              - KR
              - KS
              - KU
              - KV
              - KW
              - KY
              - LA
              - LB
              - LG
              - LI
              - LN
              - LO
              - LT
              - LU
              - LV
              - MG
              - MH
              - MI
              - MK
              - ML
              - MN
              - MR
              - MS
              - MT
              - MY
              - NA
              - NB
              - ND
              - NE
              - NG
              - NL
              - NN
              - 'NO'
              - NR
              - NV
              - NY
              - OC
              - OJ
              - OM
              - OR
              - OS
              - PA
              - PI
              - PL
              - PS
              - PT
              - QU
              - RM
              - RN
              - RO
              - RU
              - RW
              - SA
              - SC
              - SD
              - SE
              - SG
              - SI
              - SK
              - SL
              - SM
              - SN
              - SO
              - SQ
              - SR
              - SS
              - ST
              - SU
              - SV
              - SW
              - TA
              - TE
              - TG
              - TH
              - TI
              - TK
              - TL
              - TN
              - TO
              - TR
              - TS
              - TT
              - TW
              - TY
              - UG
              - UK
              - UR
              - UZ
              - VE
              - VI
              - VO
              - WA
              - WO
              - XH
              - YI
              - YO
              - ZA
              - ZH
              - YUE
              - ZU
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProfilesAvailabilityDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/policies/download.xlsx:
    get:
      tags:
        - Policies Management
      summary: >-
        Downloads policies as user-readable Excel file (insurance carrier use
        only; returns up to 1000 records)
      operationId: downloadPoliciesHistoryReport
      parameters:
        - name: search
          in: query
          description: >-
            Query (% and _ wildcards are accepted; policy numbers exclude
            leading zeros and any non-alphanumeric characters)
          required: true
          schema:
            type: string
          example: '%123456789%'
        - name: fromDate
          in: query
          description: >-
            Filter by: from creation date. Requires both dates(from/to), if
            uses.
          required: false
          schema:
            type: string
            format: date-time
          example: 2022-03-07T00:00
        - name: toDate
          in: query
          description: 'Filter by: to creation date. Requires both dates(from/to), if uses.'
          required: false
          schema:
            type: string
            format: date-time
          example: 2022-04-07T00:00
        - name: scopeType
          in: query
          description: >-
            Filter by: the scope type for policies. Not required. Defaults to
            'ALL' if not provided.
          required: false
          schema:
            type: string
            default: ALL
            enum:
              - ALL
              - ASSISTANCE
              - API
          example: ALL
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      responses:
        '200':
          description: Call successful
          content:
            multipart/mixed:
              schema:
                type: string
                format: byte
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/messages/user-chat:
    get:
      tags:
        - Messages
      summary: Loading new or previous messages for a user's chat
      operationId: getChatMessages
      parameters:
        - name: message-id
          in: query
          required: true
          schema:
            type: integer
            format: int32
        - name: new-messages
          in: query
          required: false
          schema:
            type: boolean
            default: false
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MessageDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/file/{name}:
    get:
      tags:
        - Utilities
      summary: Downloads the specified file from the file data store
      operationId: downloadFile
      parameters:
        - name: name
          in: path
          description: File name
          required: true
          schema:
            type: string
          example: >-
            42dde57da2832ba84b50f9ae0637069a9770aa8e9fb65195141fb5145a5841527012aea6115a07015d3f24f1ab8fdcb9f0e76c3c760ef0b98f5e786db0fa9e0c.png
        - name: Accept
          in: header
          schema:
            type: string
            enum:
              - image/*,application/pdf
      responses:
        '200':
          description: Call successful
          content:
            application/pdf:
              schema:
                type: string
                format: byte
            multipart/mixed:
              schema:
                type: string
                format: byte
            image/*:
              schema:
                type: string
                format: byte
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/asset/{name}:
    get:
      tags:
        - Utilities
      summary: Downloads the specified file from the file data store
      operationId: downloadResource
      parameters:
        - name: name
          in: path
          description: File name
          required: true
          schema:
            type: string
          example: >-
            42dde57da2832ba84b50f9ae0637069a9770aa8e9fb65195141fb5145a5841527012aea6115a07015d3f24f1ab8fdcb9f0e76c3c760ef0b98f5e786db0fa9e0c.png
        - name: Accept
          in: header
          schema:
            type: string
            enum:
              - image/*,application/pdf
      responses:
        '200':
          description: Call successful
          content:
            application/pdf:
              schema:
                type: string
                format: byte
            multipart/mixed:
              schema:
                type: string
                format: byte
            image/*:
              schema:
                type: string
                format: byte
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/appointments/{id}:
    get:
      tags:
        - Appointments Management
      summary: Returns specific appointment by its ID
      operationId: getAppointment
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            format: int32
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AppointmentGetDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
  /api/v2/appointments/policy/{id}:
    get:
      tags:
        - Appointments Management
      summary: Returns the list of specific appointments by policy id
      operationId: getAppointmentsByPolicy
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            format: int32
        - name: X-Token
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e
      responses:
        '200':
          description: Call successful
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AppointmentGetDto'
        '204':
          description: Call successful (if no response is expected)
        '405':
          description: Server reported an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
components:
  schemas:
    UserUpdateDto:
      type: object
      description: User Details
      properties:
        firstName:
          type: string
          description: User's first name
          example: John
        lastName:
          type: string
          description: User's last name
          example: Smith
        gender:
          type: string
          description: User's gender
          enum:
            - MALE
            - FEMALE
            - BOTH
            - OTHER
          example: MALE
        birthday:
          type: string
          format: date
          description: User's date of birth
          example: '1980-04-28'
        phone:
          type: string
          description: User's phone number
          example: '+972501234567'
        affiliateId:
          type: string
          description: If the user was recruited by an affiliate, the affiliate ID
        latitude:
          type: number
          format: double
          description: Last searched latitude (can be used by Customer Support department)
          example: 48.8566
        longitude:
          type: number
          format: double
          description: Last searched longitude (can be used by Customer Support department)
          example: 2.3522
        location:
          type: string
          description: >-
            Last searched location name (can be used by Customer Support
            department)
          example: Paris
        country:
          type: string
          description: >-
            Last searched location's country (can be used by Customer Support
            department)
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
          example: FR
        state:
          type: string
          description: Last searched location's state
          enum:
            - US_AL
            - US_AK
            - US_AZ
            - US_AR
            - US_CA
            - US_CO
            - US_CT
            - US_DE
            - US_DC
            - US_FL
            - US_GA
            - US_HI
            - US_ID
            - US_IL
            - US_IN
            - US_IA
            - US_KS
            - US_KY
            - US_LA
            - US_ME
            - US_MD
            - US_MA
            - US_MI
            - US_MN
            - US_MS
            - US_MO
            - US_MT
            - US_NE
            - US_NV
            - US_NH
            - US_NJ
            - US_NM
            - US_NY
            - US_NC
            - US_ND
            - US_OH
            - US_OK
            - US_OR
            - US_PA
            - US_RI
            - US_SC
            - US_SD
            - US_TN
            - US_TX
            - US_UT
            - US_VT
            - US_VA
            - US_WA
            - US_WV
            - US_WI
            - US_WY
            - DE_BW
            - DE_BY
            - DE_BE
            - DE_BB
            - DE_HB
            - DE_HH
            - DE_HE
            - DE_MV
            - DE_NI
            - DE_NW
            - DE_RP
            - DE_SL
            - DE_SN
            - DE_ST
            - DE_SH
            - DE_TH
            - CA_AB
            - CA_BC
            - CA_MB
            - CA_NB
            - CA_NL
            - CA_NT
            - CA_NS
            - CA_NU
            - CA_ON
            - CA_PE
            - CA_QC
            - CA_SK
            - CA_YT
            - IN_AN
            - IN_AP
            - IN_AR
            - IN_AS
            - IN_BR
            - IN_CH
            - IN_CG
            - IN_DH
            - IN_DL
            - IN_GA
            - IN_GJ
            - IN_HR
            - IN_HP
            - IN_JK
            - IN_JH
            - IN_KA
            - IN_KL
            - IN_LA
            - IN_LD
            - IN_MP
            - IN_MH
            - IN_MN
            - IN_ML
            - IN_MZ
            - IN_NL
            - IN_OD
            - IN_PY
            - IN_PB
            - IN_RJ
            - IN_SK
            - IN_TN
            - IN_TS
            - IN_TR
            - IN_UP
            - IN_UK
            - IN_WB
            - AU_NSW
            - AU_QLD
            - AU_SA
            - AU_TAS
            - AU_VIC
            - AU_WA
            - AU_ACT
            - AU_NT
            - CH_ZH
            - CH_BE
            - CH_LU
            - CH_UR
            - CH_SZ
            - CH_OW
            - CH_NW
            - CH_GL
            - CH_ZG
            - CH_FR
            - CH_SO
            - CH_BS
            - CH_BL
            - CH_SH
            - CH_AR
            - CH_AI
            - CH_SG
            - CH_GR
            - CH_AG
            - CH_TG
            - CH_TI
            - CH_VD
            - CH_VS
            - CH_NE
            - CH_GE
            - CH_JU
            - BR_AC
            - BR_AL
            - BR_AM
            - BR_AP
            - BR_BA
            - BR_CE
            - BR_DF
            - BR_ES
            - BR_GO
            - BR_MA
            - BR_MG
            - BR_MS
            - BR_MT
            - BR_PA
            - BR_PB
            - BR_PE
            - BR_PI
            - BR_PR
            - BR_RJ
            - BR_RN
            - BR_RO
            - BR_RR
            - BR_RS
            - BR_SC
            - BR_SE
            - BR_SP
            - BR_TO
          example: AL
        city:
          type: string
          description: Last searched location's city
          example: London
        deviceId:
          type: string
          description: >-
            Unique ID of the device (to be able to reuse device record on log-in
            - log-out - log-back-in)
          example: 0123456789abcdef0123456789abcdef
        pushToken:
          type: string
          description: Push notifications token of the device
          example: 0123456789abcdef0123456789abcdef
        deviceOS:
          type: string
          description: >-
            Current device's operating system (for statistical and support
            purposes)
        deviceModel:
          type: string
          description: Current device's model (for statistical and support purposes)
        appVersion:
          type: string
          description: >-
            For native applications, the app version (for statistical and
            support purposes)
        language:
          type: string
          description: User app's language (used to appropriately translate system emails)
          enum:
            - ENGLISH
            - ENGLISH_UK
            - HEBREW
            - SPANISH
            - GERMAN
            - CHINESE
            - DUTCH
            - FRENCH
            - RUSSIAN
            - JAPANESE
            - ITALIAN
          example: ENGLISH
        currency:
          type: string
          description: User app's currency (used to appropriately text engine)
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
          example: USD
        sessionType:
          type: string
          description: Requested session type (implicitly controls session expiration)
          enum:
            - API
            - IOS
            - ANDROID
            - MOBILE
            - WEB
            - EMBEDDED
          example: WEB
        linkState:
          type: string
          description: Deep link (if any) for continuation support
        email:
          type: string
          description: User's email (effectively used to login and register)
          example: test@air-dr.com
        auxEmail:
          type: string
          description: Auxiliary user's email (effectively used when logged in with OAuth)
          example: test@icloud.com
        password:
          type: string
          description: User's desired password (for register or password update)
          example: Hello$
        oldPassword:
          type: string
          description: >-
            User's current (old) password (when the password is being updated,
            this value must be set)
          example: Hello?
        passwordHint:
          type: string
          description: True, if login information is provided by the Facebook Login SDK
          enum:
            - SET
            - CHANGED
            - PASSWORD_RESET_REQUESTED
            - FACEBOOK
            - GOOGLE
            - APPLE
            - OAUTH2
        resetPasswordCode:
          type: string
          description: >-
            If the change of the password was as a result of the Password Reset
            email, this is the reset code (effectively overrides the access
            token for this operation).
          example: 0123456789abcdef0123456789abcdef
        localTimestamp:
          type: string
          format: date-time
          description: User's timestamp, used to find out user's local true time zone
        localTimeZone:
          type: string
          description: >-
            A string representing the current time zone. Returns the string
            representing the current time zone based on the user's device.
          example: Europe/Paris
        spokenLanguage:
          type: string
          description: Patient's spoken language, null by default
          enum:
            - AA
            - AB
            - AE
            - AF
            - AK
            - AM
            - AN
            - AR
            - AS
            - AV
            - AY
            - AZ
            - BA
            - BE
            - BG
            - BH
            - BI
            - BM
            - BN
            - BO
            - BR
            - BS
            - CA
            - CE
            - CH
            - CO
            - CR
            - CS
            - CU
            - CV
            - CY
            - DA
            - DE
            - DV
            - DZ
            - EE
            - EL
            - EN
            - EO
            - ES
            - ET
            - EU
            - FA
            - FF
            - FI
            - FJ
            - FO
            - FR
            - FY
            - GA
            - GD
            - GL
            - GN
            - GU
            - GV
            - HA
            - HE
            - HI
            - HO
            - HR
            - HT
            - HU
            - HY
            - HZ
            - IA
            - ID
            - IE
            - IG
            - II
            - IK
            - IO
            - IS
            - IT
            - IU
            - JA
            - JV
            - KA
            - KG
            - KI
            - KJ
            - KK
            - KL
            - KM
            - KN
            - KO
            - KR
            - KS
            - KU
            - KV
            - KW
            - KY
            - LA
            - LB
            - LG
            - LI
            - LN
            - LO
            - LT
            - LU
            - LV
            - MG
            - MH
            - MI
            - MK
            - ML
            - MN
            - MR
            - MS
            - MT
            - MY
            - NA
            - NB
            - ND
            - NE
            - NG
            - NL
            - NN
            - 'NO'
            - NR
            - NV
            - NY
            - OC
            - OJ
            - OM
            - OR
            - OS
            - PA
            - PI
            - PL
            - PS
            - PT
            - QU
            - RM
            - RN
            - RO
            - RU
            - RW
            - SA
            - SC
            - SD
            - SE
            - SG
            - SI
            - SK
            - SL
            - SM
            - SN
            - SO
            - SQ
            - SR
            - SS
            - ST
            - SU
            - SV
            - SW
            - TA
            - TE
            - TG
            - TH
            - TI
            - TK
            - TL
            - TN
            - TO
            - TR
            - TS
            - TT
            - TW
            - TY
            - UG
            - UK
            - UR
            - UZ
            - VE
            - VI
            - VO
            - WA
            - WO
            - XH
            - YI
            - YO
            - ZA
            - ZH
            - YUE
            - ZU
        identifiers:
          type: object
          additionalProperties:
            type: string
          description: >-
            If the user was redirected from external application, identifier
            click ids
        userSource:
          type: string
          description: User source
          enum:
            - ORGANIC
            - CARD
            - ASSISTANCE
            - LANDING
            - MARKETING
            - PARTNER
            - ADVICE
            - CS
            - AFFILIATE
            - AD_WEBSITE
            - WEB_VIEW
            - DIRECT_CLINIC
            - WELCOME_EMAIL
          example: ORGANIC
        oneTimePassword:
          type: string
          description: One time password.
          example: 123456
        whatsAppPreference:
          type: string
          description: >-
            Indicates whether WhatsApp is selected as the preferred method for
            receiving notifications or not
          enum:
            - TURNED_OFF
            - TURNED_ON
            - DISABLED
        smsPreference:
          type: string
          description: >-
            Indicates whether SMS is selected as the preferred method for
            receiving notifications or not
          enum:
            - TURNED_OFF
            - TURNED_ON
            - DISABLED
        emailPreference:
          type: string
          description: >-
            Indicates whether email is selected as the preferred method for
            receiving notifications or not
          enum:
            - TURNED_OFF
            - TURNED_ON
            - DISABLED
      title: User data to setup
    ErrorData:
      type: object
      properties:
        error:
          type: string
          description: Error classification
          example: USERNAME
        message:
          type: string
          description: Exception thrown by the server
          example: NullPointerException
        data:
          type: object
          additionalProperties:
            type: object
          description: Additional error-related information
        trace:
          type: string
          description: Server stack-trace (technical details)
        timestamp:
          type: string
          format: date-time
          description: Server timestamp
          example: '2023-03-10T14:10:15.987'
      title: Minimum user details
    AffiliateTokenDto:
      type: object
      properties:
        id:
          type: integer
          format: int32
          description: Affiliate ID
          example: 123
        key:
          type: string
          description: Affiliate Key
          example: phoenix
        name:
          type: string
          description: Affiliate Name
          example: Phoenix
        lightLogo:
          type: string
          description: >-
            Logo - Air doctor logo by default (bright logos are assumed,
            similarly to partners)
        darkLogo:
          type: string
          description: >-
            Logo - Air doctor logo by default (dark logos are assumed, similarly
            to partners)
        greetingTitle:
          type: string
          description: >-
            Greeting title - title that a user with an affiliate sees when
            logging in
        greeting:
          type: string
          description: Greeting - text that a user with an affiliate sees when logging in
        backgroundColor:
          type: integer
          format: int32
          description: Background color - Our blue color by default
          example: C0C0C0
        contactUsTabColor:
          type: integer
          format: int32
          description: Contact us Tab color - Our green color by default
          example: C0C0C0
        borderLineColor:
          type: integer
          format: int32
          description: Border line color of the search - Transparent by default (or -1)
          example: C0C0C0
        topMenuIcon:
          type: string
          description: Top menu icon, Icons.TOP_MENU by default
          example: TOP_MENU
        topBackIcon:
          type: string
          description: Top back icon, Icons.TOP_BACK by default
          example: TOP_BACK
        titleMiddleFontColor:
          type: string
          description: Title middle font color, FFFFFF by default
          example: FFFFFF
        locationTitleFontColor:
          type: string
          description: Location title font color, FFFFFF by default
          example: FFFFFF
        locationSubtitleFontColor:
          type: string
          description: Location subtitle font color, FFFFFF by default
          example: FFFFFF
        topMenuFontColor:
          type: string
          description: Landscape menu bar font color, FFFFFF by default
          example: FFFFFF
        settingsIcon:
          type: string
          description: >-
            Settings icon for landscape menu bar, Icons.ICON_SETTINGS_WHITE by
            default
          example: ICON_SETTINGS_WHITE
        accountIcon:
          type: string
          description: >-
            Account icon for landscape menu bar, Icons.ICON_ACCOUNT_WHITE by
            default
          example: ICON_ACCOUNT_WHITE
        skipCoverageScreen:
          type: boolean
          description: >-
            Skip the add coverage screen after the registration screen, true by
            default
          example: true
      title: Basic app affiliate details
    AppointmentExtraDto:
      type: object
      properties:
        amount:
          type: number
          format: double
          description: Amount of the extra charge
          example: 15
        amountNet:
          type: number
          format: double
          description: Amount net of the extra charge
          example: 10
        notes:
          type: string
          description: Reason for the charge
          example: 10
        currency:
          type: string
          description: >-
            Currency of the charge (the default value is the appointment's
            currency)
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
          example: USD
        type:
          type: string
          default: DOCTOR_CLINIC
          description: Type of the charge
          enum:
            - SERVICE_FEE
            - DOCTOR_CLINIC
            - MEDICINE
            - OTHER
            - PRESCRIPTIONS
            - INTERNAL_NOTE
            - VISIT_SUMMARY_BY_DOCTOR
            - VISIT_SUMMARY_BY_PATIENT
            - VISIT_SUMMARY_BY_CS
            - MEDICAL_IMAGING
            - LAB_TESTS_RESULT
            - MEDICAL_REPORT
            - FINANCIAL_DOCS
            - REFERRAL
            - INTERPRETER
            - PUBLIC_OR_TAXI_TRANSPORTATION
            - PRIVATE_CAR_TRANSPORTATION
          example: MEDICINE
        photos:
          type: array
          description: Photos attached to this extra
          items:
            $ref: '#/components/schemas/PhotoDto'
        quantity:
          type: integer
          format: int32
          description: Quantity of extra
      title: Single appointment extra charge
    AppointmentGetDto:
      type: object
      properties:
        appointmentId:
          type: integer
          format: int32
          description: Unique appointment ID (leave blank when creating an appointment)
          example: 1234
        appointmentRevisionId:
          type: integer
          format: int32
          description: >-
            Unique appointment revision ID (optional, but recommended: can be
            specified to make sure the underlying appointment was not changed
            since it was retreived; leave blank when creating an appointment)
          example: 5678
        patientId:
          type: integer
          format: int32
          description: Patient ID (from the list returned for the user)
          example: 12345
        profileId:
          type: integer
          format: int32
          description: >-
            Profile ID (identifies the provider with whom the appointment is
            being made)
          example: 1234
        locationId:
          type: integer
          format: int32
          description: Location ID (location must agree with the specified profile)
          example: 1234
        speciality:
          type: string
          description: >-
            Profile specialty (optional, but becomes mandatory on creation if
            the profile has multiple allowed specialties; the specialty of the
            appointment cannot be changed)
          enum:
            - GENERAL
            - DENTIST
            - ORTHOPEDIST
            - PEDIATRICIAN
            - GYNECOLOGIST
            - PULMONOLOGIST
            - GASTROENTEROLOGIST
            - OPHTALMOLOGIST
            - DERMATOLOGIST
            - NEUROLOGIST
            - ENT
            - PSYCHIATRIST
            - CARDIOLOGIST
            - UROLOGIST
            - ALTERNATIVE
            - OTHER
            - EMERGENCY
            - MORE
            - MASSEUSE
            - ONCOLOGIST
            - SURGEON
            - INTERNIST
            - HEMATOLOGIST
            - NEPHROLOGIST
            - RHEUMATOLOGIST
            - GERIATRICIAN
            - ALLERGOLOGIST
            - ONLINE_DOCTOR
            - IMAGING
            - LABS
          example: DERMATOLOGIST
        caseId:
          type: integer
          format: int32
          description: >-
            Case ID (case associated with this appointment; created
            automatically or manually before creating the appointment)
          example: 1234
        promoCodeId:
          type: integer
          format: int32
          description: Optional; Promo code ID to be applied to the appointment
          example: 1234
        status:
          type: string
          description: Appointment status
          enum:
            - PROPOSED
            - REQUESTED
            - DOCTOR_REFUSED_REQUEST
            - REQUEST_EXPIRED
            - PATIENT_CANCELLED_REQUEST
            - ALTERNATIVE_OFFERED
            - PATIENT_REFUSED_OFFER
            - OFFER_EXPIRED
            - DOCTOR_CANCELLED_OFFER
            - APPOINTMENT_SCHEDULED
            - AUTOMATICALLY_CANCELLED
            - DOCTOR_CANCELLED_APPOINTMENT
            - PATIENT_CANCELLED_APPOINTMENT
            - VISIT_TOOK_PLACE
            - APPOINTMENT_CLOSED
            - PAYMENT_FAILED
            - NO_SHOW
            - CS_CANCELLED_REQUEST
            - CS_CANCELLED_OFFER
            - CS_CANCELLED_APPOINTMENT
            - CS_OFFER
            - LATE_CANCELLATION
            - HOLD_FEE
            - HOLD_FAILED
            - INSURER_CANCELLED_APPOINTMENT
            - CANCELLED_DUE_TO_HOLD_FAILURE
            - ADDITIONAL_ALTERNATIVE_OFFERED
            - CLAIM_OPEN
            - CLAIM_CLARIFICATION
            - CLAIM_READY_FOR_PAYMENT
            - CLAIM_INTERNALLY_PAID
            - CLAIM_SEND_TO_INSURER
            - CLAIM_SUBMITTED_TO_INSURER
            - CLAIM_CANCELED
          example: REQUESTED
        minutesToExpiration:
          type: integer
          format: int32
          description: >-
            Minutes left until the current appointment status expires (cannot be
            changed, except by customer support team)
          example: 57
        scheduledTimestamp:
          type: string
          format: date-time
          description: >-
            Scheduled time of the appointment in appointment time zone
            (profile's time zone for clinic and home visits; patient's time zone
            for patient-side video visits)
          example: 2020-07-29T16:30
        careOf:
          type: string
          description: A person responsible for the patient (useful for minors)
          example: Vivian Smith
        passportNumber:
          type: string
          description: Passport number of patient
        passportCountryEnum:
          type: string
          description: Passport country of patient
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
        passportIssueDate:
          type: string
          format: date
          description: Passport issue date of patient
        homeAddressInHomeCountry:
          type: string
          description: Patient home address in home country
        email:
          type: string
          description: Patient's email address
          example: someone@example.com
        phone:
          type: string
          description: Patient's contact phone number
          example: '+15467383892'
        notes:
          type: string
          description: Problem description to be provided by the patient
          example: Meesa don't feel so good...
        city:
          type: string
          description: For home visits, city of the visit
          example: London
        state:
          type: string
          description: For home visits, the state of the country of the visit
          enum:
            - US_AL
            - US_AK
            - US_AZ
            - US_AR
            - US_CA
            - US_CO
            - US_CT
            - US_DE
            - US_DC
            - US_FL
            - US_GA
            - US_HI
            - US_ID
            - US_IL
            - US_IN
            - US_IA
            - US_KS
            - US_KY
            - US_LA
            - US_ME
            - US_MD
            - US_MA
            - US_MI
            - US_MN
            - US_MS
            - US_MO
            - US_MT
            - US_NE
            - US_NV
            - US_NH
            - US_NJ
            - US_NM
            - US_NY
            - US_NC
            - US_ND
            - US_OH
            - US_OK
            - US_OR
            - US_PA
            - US_RI
            - US_SC
            - US_SD
            - US_TN
            - US_TX
            - US_UT
            - US_VT
            - US_VA
            - US_WA
            - US_WV
            - US_WI
            - US_WY
            - DE_BW
            - DE_BY
            - DE_BE
            - DE_BB
            - DE_HB
            - DE_HH
            - DE_HE
            - DE_MV
            - DE_NI
            - DE_NW
            - DE_RP
            - DE_SL
            - DE_SN
            - DE_ST
            - DE_SH
            - DE_TH
            - CA_AB
            - CA_BC
            - CA_MB
            - CA_NB
            - CA_NL
            - CA_NT
            - CA_NS
            - CA_NU
            - CA_ON
            - CA_PE
            - CA_QC
            - CA_SK
            - CA_YT
            - IN_AN
            - IN_AP
            - IN_AR
            - IN_AS
            - IN_BR
            - IN_CH
            - IN_CG
            - IN_DH
            - IN_DL
            - IN_GA
            - IN_GJ
            - IN_HR
            - IN_HP
            - IN_JK
            - IN_JH
            - IN_KA
            - IN_KL
            - IN_LA
            - IN_LD
            - IN_MP
            - IN_MH
            - IN_MN
            - IN_ML
            - IN_MZ
            - IN_NL
            - IN_OD
            - IN_PY
            - IN_PB
            - IN_RJ
            - IN_SK
            - IN_TN
            - IN_TS
            - IN_TR
            - IN_UP
            - IN_UK
            - IN_WB
            - AU_NSW
            - AU_QLD
            - AU_SA
            - AU_TAS
            - AU_VIC
            - AU_WA
            - AU_ACT
            - AU_NT
            - CH_ZH
            - CH_BE
            - CH_LU
            - CH_UR
            - CH_SZ
            - CH_OW
            - CH_NW
            - CH_GL
            - CH_ZG
            - CH_FR
            - CH_SO
            - CH_BS
            - CH_BL
            - CH_SH
            - CH_AR
            - CH_AI
            - CH_SG
            - CH_GR
            - CH_AG
            - CH_TG
            - CH_TI
            - CH_VD
            - CH_VS
            - CH_NE
            - CH_GE
            - CH_JU
            - BR_AC
            - BR_AL
            - BR_AM
            - BR_AP
            - BR_BA
            - BR_CE
            - BR_DF
            - BR_ES
            - BR_GO
            - BR_MA
            - BR_MG
            - BR_MS
            - BR_MT
            - BR_PA
            - BR_PB
            - BR_PE
            - BR_PI
            - BR_PR
            - BR_RJ
            - BR_RN
            - BR_RO
            - BR_RR
            - BR_RS
            - BR_SC
            - BR_SE
            - BR_SP
            - BR_TO
          example: AZ
        postalCode:
          type: string
          description: For home visits, postal code of the address for the visit
          example: W3 6RT
        street:
          type: string
          description: For home visits, street of the address for the visit
          example: Camden St
        streetNumber:
          type: string
          description: For home visits, street number of the address for the visit
          example: 11B
        buildingName:
          type: string
          description: For home visits, building name of the address for the visit
          example: The Ritz Carlton, New York
        floor:
          type: string
          description: For home visits, floor within the residence at the visit's location
          example: 3
        apartment:
          type: string
          description: For home visits, apartment or room number at the visit's location
          example: 315
        notesHomeAddress:
          type: string
          description: >-
            Patient address of accommodation or For home visits, additional
            instruction how to enter patient location
          example: Entrance is on the opposite side
        latitude:
          type: number
          format: double
          description: For home visits, latitude of visit's location
          example: 51.507351
        longitude:
          type: number
          format: double
          description: For home visits, longitude of visit's location
          example: -0.127758
        paymentStatus:
          type: string
          description: Designated appointment payment status
          enum:
            - WRITE_OFF
            - CASH_DIRECT
            - PAID_PRIVATELY
            - PREPAYMENT
            - EXCESS
            - COVERED
          example: PREPAYMENT
        chunkStatus:
          type: string
          description: Designated appointment chunk status
          enum:
            - HIDE
            - SHOW_BLOCK
            - ASSISTANCE
            - PAY
            - PREPAYMENT
            - CC_BACKUP
            - COVERED
            - PAY_UNDER_INSURER
          example: PREPAYMENT
        followUpType:
          type: string
          description: Indicates whether the appointment is a follow-up
          enum:
            - REGULAR
            - PAID_FOLLOW_UP
            - FREE_FOLLOW_UP
          example: PAID_FOLLOW_UP
        appointmentFeeNet:
          type: number
          format: double
          description: Appointment net fee (privileged)
          example: 240
        appointmentExtraFlatCommission:
          type: number
          format: double
          description: Appointment extra flat commission (privileged)
          example: 240
        photos:
          type: array
          description: Photos attached to this appointment
          items:
            $ref: '#/components/schemas/PhotoDto'
        extras:
          type: array
          description: >-
            Extra payments for this appointment. Privileged; might not be
            provided
          items:
            $ref: '#/components/schemas/AppointmentExtraDto'
        event:
          $ref: '#/components/schemas/EventDto'
          description: >-
            Event associated with this appointment; on GET only the following
            fields are filled: time stamp, type, public note and initiator ID (0
            for profile, -1 for customer support department, -2 system
            automation,  patient's Subscriber ID otherwise)
        demandNumber:
          type: string
          description: Appointment insurance demand number (if needed)
          example: F73289-G9
        voucherNumber:
          type: string
          description: Insurance visit voucher number (if needed)
          example: Q5789324841209PL
        voucherStatus:
          type: string
          description: Status of the voucher (if needed)
          enum:
            - MISSING
            - VALID
            - EXPIRED
            - CANCELLED
            - DECLINED
          example: VALID
        voucherExpirationDate:
          type: string
          format: date
          description: >-
            The day on which the voucher expires(the voucher becomes expired the
            next day)
          example: '2021-12-31'
        requestedTime:
          type: string
          description: >-
            Appointment time preference (only for manually allocated
            appointments)
        claimDetails:
          $ref: '#/components/schemas/ClaimDetailsDto'
          description: >-
            Insurance claim extra details (only present and can be specified for
            claims, not system-managed appointments)
        profileNotes:
          type: string
          description: Clinic notes about appointment
          example: Requires additional appointment
        hmoEnum:
          type: string
          description: Health Maintenance Organization
          enum:
            - CLALIT
            - MACCABI
            - MEHUHEDET
            - LEUMIT
            - OTHER
        appointmentOrigin:
          type: string
          description: Appointment origin
          enum:
            - REGULAR
            - FIRST_SERVE
            - CLINIC_DIRECT
            - VIDEO_GROUP
            - VIDEO_GROUP_ONE_CLICK
            - BOTH_OFFLINE_GROUP
            - HOME_OFFLINE_GROUP
            - CLINIC_OFFLINE_GROUP
            - BOTH_OFFLINE_GROUP_BY_SYSTEM
            - HOME_OFFLINE_GROUP_BY_SYSTEM
            - CLINIC_OFFLINE_GROUP_BY_SYSTEM
          example: CLINIC_DIRECT
        dispatchTo:
          type: string
          description: Doctor who get appointment from dispatcher
          example: Dr. Hippocrates
        medicationsInUseStatus:
          type: string
          description: Whether the patient provided a description of the medications in use
          enum:
            - STATUS_UNKNOWN
            - MEDICATIONS_TAKEN
            - NO_MEDICATIONS_TAKEN
        medicationsInUse:
          type: string
          description: Medications taken on regular basis
          example: Some pills..
        interpreterLanguage:
          type: string
          description: Language of requested interpreter
          enum:
            - AA
            - AB
            - AE
            - AF
            - AK
            - AM
            - AN
            - AR
            - AS
            - AV
            - AY
            - AZ
            - BA
            - BE
            - BG
            - BH
            - BI
            - BM
            - BN
            - BO
            - BR
            - BS
            - CA
            - CE
            - CH
            - CO
            - CR
            - CS
            - CU
            - CV
            - CY
            - DA
            - DE
            - DV
            - DZ
            - EE
            - EL
            - EN
            - EO
            - ES
            - ET
            - EU
            - FA
            - FF
            - FI
            - FJ
            - FO
            - FR
            - FY
            - GA
            - GD
            - GL
            - GN
            - GU
            - GV
            - HA
            - HE
            - HI
            - HO
            - HR
            - HT
            - HU
            - HY
            - HZ
            - IA
            - ID
            - IE
            - IG
            - II
            - IK
            - IO
            - IS
            - IT
            - IU
            - JA
            - JV
            - KA
            - KG
            - KI
            - KJ
            - KK
            - KL
            - KM
            - KN
            - KO
            - KR
            - KS
            - KU
            - KV
            - KW
            - KY
            - LA
            - LB
            - LG
            - LI
            - LN
            - LO
            - LT
            - LU
            - LV
            - MG
            - MH
            - MI
            - MK
            - ML
            - MN
            - MR
            - MS
            - MT
            - MY
            - NA
            - NB
            - ND
            - NE
            - NG
            - NL
            - NN
            - 'NO'
            - NR
            - NV
            - NY
            - OC
            - OJ
            - OM
            - OR
            - OS
            - PA
            - PI
            - PL
            - PS
            - PT
            - QU
            - RM
            - RN
            - RO
            - RU
            - RW
            - SA
            - SC
            - SD
            - SE
            - SG
            - SI
            - SK
            - SL
            - SM
            - SN
            - SO
            - SQ
            - SR
            - SS
            - ST
            - SU
            - SV
            - SW
            - TA
            - TE
            - TG
            - TH
            - TI
            - TK
            - TL
            - TN
            - TO
            - TR
            - TS
            - TT
            - TW
            - TY
            - UG
            - UK
            - UR
            - UZ
            - VE
            - VI
            - VO
            - WA
            - WO
            - XH
            - YI
            - YO
            - ZA
            - ZH
            - YUE
            - ZU
          example: EN
        pastRevisions:
          description: >-
            List of previous appointment revisions (earlier revision will be the
            last in the list; latest revision will be the first; nested records
            will not have this property set). Privileged; might not be provided
        patient:
          $ref: '#/components/schemas/PatientDto'
          description: Explicit patient details
        groupId:
          type: integer
          format: int32
          description: >-
            Group ID (the same value will be provided for all appointments in a
            group created by a suggestion all; zero for appointments not
            belonging to a group)
          example: 1234
        scheduledLocalTimestamp:
          type: string
          format: date-time
          description: >-
            Scheduled date and time of the appointment, according to the current
            user's local time
          example: 2020-07-29T18:30
        scheduledProfileTimestamp:
          type: string
          format: date-time
          description: >-
            Scheduled date and time of the appointment, always according to the
            profile's local time
          example: 2020-07-29T16:30
        scheduledPatientTimestamp:
          type: string
          format: date-time
          description: >-
            Scheduled date and time of the appointment, always according to the
            patient's local time
          example: 2020-07-29T15:30
        appointmentFee:
          type: number
          format: double
          description: >-
            Appointment basic fee (can only be changed by a profile and only in
            some circumstances) (privileged)
          example: 240
        excessAmount:
          type: number
          format: double
          description: Excess (deductible) amount of the appointment
          example: 40
        excessCurrency:
          type: string
          description: Excess currency
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
          example: EUR
        appointmentCurrency:
          type: string
          description: Appointment currency (based on the profile's currency)
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
          example: USD
        promoCode:
          $ref: '#/components/schemas/PromoCodeDto'
          description: Explicit promo code details
        appointmentType:
          type: string
          description: Appointment type (urgent equates to off hours)
          enum:
            - VIDEO_VISIT
            - REGULAR_CLINIC
            - URGENT_CLINIC
            - REGULAR_HOME
            - URGENT_HOME
          example: URGENT_HOME
        reviewRating:
          type: integer
          format: int32
          description: If the patient rated the visit, the rating given (-1 through 10)
          example: 9
        doctorReviewRating:
          type: integer
          format: int32
          description: If the patient rated the visit, the rating given (-1 through 10)
          example: 9
        reviewText:
          type: string
          description: If the patient rated the visit, the review text provided
          example: Almost perfect!
        applicationReviewRating:
          type: integer
          format: int32
          description: >-
            If the patient rated the application after visit, the given (-1
            thought 10)
          example: 9
        invoices:
          type: array
          description: >-
            List of the appointment related invoices. Privileged; may not all
            come in
          items:
            $ref: '#/components/schemas/AppointmentInvoiceDto'
        appointmentCountry:
          type: string
          description: Appointment country when appointment was created
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
        appointmentSearchedCountry:
          type: string
          description: Manually typed country while making the appointment
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
        appointmentState:
          type: string
          description: Appointment state when appointment was created
          enum:
            - US_AL
            - US_AK
            - US_AZ
            - US_AR
            - US_CA
            - US_CO
            - US_CT
            - US_DE
            - US_DC
            - US_FL
            - US_GA
            - US_HI
            - US_ID
            - US_IL
            - US_IN
            - US_IA
            - US_KS
            - US_KY
            - US_LA
            - US_ME
            - US_MD
            - US_MA
            - US_MI
            - US_MN
            - US_MS
            - US_MO
            - US_MT
            - US_NE
            - US_NV
            - US_NH
            - US_NJ
            - US_NM
            - US_NY
            - US_NC
            - US_ND
            - US_OH
            - US_OK
            - US_OR
            - US_PA
            - US_RI
            - US_SC
            - US_SD
            - US_TN
            - US_TX
            - US_UT
            - US_VT
            - US_VA
            - US_WA
            - US_WV
            - US_WI
            - US_WY
            - DE_BW
            - DE_BY
            - DE_BE
            - DE_BB
            - DE_HB
            - DE_HH
            - DE_HE
            - DE_MV
            - DE_NI
            - DE_NW
            - DE_RP
            - DE_SL
            - DE_SN
            - DE_ST
            - DE_SH
            - DE_TH
            - CA_AB
            - CA_BC
            - CA_MB
            - CA_NB
            - CA_NL
            - CA_NT
            - CA_NS
            - CA_NU
            - CA_ON
            - CA_PE
            - CA_QC
            - CA_SK
            - CA_YT
            - IN_AN
            - IN_AP
            - IN_AR
            - IN_AS
            - IN_BR
            - IN_CH
            - IN_CG
            - IN_DH
            - IN_DL
            - IN_GA
            - IN_GJ
            - IN_HR
            - IN_HP
            - IN_JK
            - IN_JH
            - IN_KA
            - IN_KL
            - IN_LA
            - IN_LD
            - IN_MP
            - IN_MH
            - IN_MN
            - IN_ML
            - IN_MZ
            - IN_NL
            - IN_OD
            - IN_PY
            - IN_PB
            - IN_RJ
            - IN_SK
            - IN_TN
            - IN_TS
            - IN_TR
            - IN_UP
            - IN_UK
            - IN_WB
            - AU_NSW
            - AU_QLD
            - AU_SA
            - AU_TAS
            - AU_VIC
            - AU_WA
            - AU_ACT
            - AU_NT
            - CH_ZH
            - CH_BE
            - CH_LU
            - CH_UR
            - CH_SZ
            - CH_OW
            - CH_NW
            - CH_GL
            - CH_ZG
            - CH_FR
            - CH_SO
            - CH_BS
            - CH_BL
            - CH_SH
            - CH_AR
            - CH_AI
            - CH_SG
            - CH_GR
            - CH_AG
            - CH_TG
            - CH_TI
            - CH_VD
            - CH_VS
            - CH_NE
            - CH_GE
            - CH_JU
            - BR_AC
            - BR_AL
            - BR_AM
            - BR_AP
            - BR_BA
            - BR_CE
            - BR_DF
            - BR_ES
            - BR_GO
            - BR_MA
            - BR_MG
            - BR_MS
            - BR_MT
            - BR_PA
            - BR_PB
            - BR_PE
            - BR_PI
            - BR_PR
            - BR_RJ
            - BR_RN
            - BR_RO
            - BR_RR
            - BR_RS
            - BR_SC
            - BR_SE
            - BR_SP
            - BR_TO
        appointmentSearchedState:
          type: string
          description: Manually typed state while making the appointment
          enum:
            - US_AL
            - US_AK
            - US_AZ
            - US_AR
            - US_CA
            - US_CO
            - US_CT
            - US_DE
            - US_DC
            - US_FL
            - US_GA
            - US_HI
            - US_ID
            - US_IL
            - US_IN
            - US_IA
            - US_KS
            - US_KY
            - US_LA
            - US_ME
            - US_MD
            - US_MA
            - US_MI
            - US_MN
            - US_MS
            - US_MO
            - US_MT
            - US_NE
            - US_NV
            - US_NH
            - US_NJ
            - US_NM
            - US_NY
            - US_NC
            - US_ND
            - US_OH
            - US_OK
            - US_OR
            - US_PA
            - US_RI
            - US_SC
            - US_SD
            - US_TN
            - US_TX
            - US_UT
            - US_VT
            - US_VA
            - US_WA
            - US_WV
            - US_WI
            - US_WY
            - DE_BW
            - DE_BY
            - DE_BE
            - DE_BB
            - DE_HB
            - DE_HH
            - DE_HE
            - DE_MV
            - DE_NI
            - DE_NW
            - DE_RP
            - DE_SL
            - DE_SN
            - DE_ST
            - DE_SH
            - DE_TH
            - CA_AB
            - CA_BC
            - CA_MB
            - CA_NB
            - CA_NL
            - CA_NT
            - CA_NS
            - CA_NU
            - CA_ON
            - CA_PE
            - CA_QC
            - CA_SK
            - CA_YT
            - IN_AN
            - IN_AP
            - IN_AR
            - IN_AS
            - IN_BR
            - IN_CH
            - IN_CG
            - IN_DH
            - IN_DL
            - IN_GA
            - IN_GJ
            - IN_HR
            - IN_HP
            - IN_JK
            - IN_JH
            - IN_KA
            - IN_KL
            - IN_LA
            - IN_LD
            - IN_MP
            - IN_MH
            - IN_MN
            - IN_ML
            - IN_MZ
            - IN_NL
            - IN_OD
            - IN_PY
            - IN_PB
            - IN_RJ
            - IN_SK
            - IN_TN
            - IN_TS
            - IN_TR
            - IN_UP
            - IN_UK
            - IN_WB
            - AU_NSW
            - AU_QLD
            - AU_SA
            - AU_TAS
            - AU_VIC
            - AU_WA
            - AU_ACT
            - AU_NT
            - CH_ZH
            - CH_BE
            - CH_LU
            - CH_UR
            - CH_SZ
            - CH_OW
            - CH_NW
            - CH_GL
            - CH_ZG
            - CH_FR
            - CH_SO
            - CH_BS
            - CH_BL
            - CH_SH
            - CH_AR
            - CH_AI
            - CH_SG
            - CH_GR
            - CH_AG
            - CH_TG
            - CH_TI
            - CH_VD
            - CH_VS
            - CH_NE
            - CH_GE
            - CH_JU
            - BR_AC
            - BR_AL
            - BR_AM
            - BR_AP
            - BR_BA
            - BR_CE
            - BR_DF
            - BR_ES
            - BR_GO
            - BR_MA
            - BR_MG
            - BR_MS
            - BR_MT
            - BR_PA
            - BR_PB
            - BR_PE
            - BR_PI
            - BR_PR
            - BR_RJ
            - BR_RN
            - BR_RO
            - BR_RR
            - BR_RS
            - BR_SC
            - BR_SE
            - BR_SP
            - BR_TO
        canPrescribe:
          type: boolean
          description: Is profile can make a prescription
        profileDetails:
          $ref: '#/components/schemas/AppointmentProfileDto'
          description: Profile's and location's details
      title: Appointment details record
    AppointmentInvoiceDto:
      type: object
      properties:
        invoiceId:
          type: integer
          format: int32
          description: Invoice ID
          example: 1234
        invoiceNumber:
          type: integer
          format: int32
          description: Invoice number
        amount:
          type: number
          format: double
          description: Amount for this invoice
          example: 40
        currency:
          type: string
          description: Currency this invoice was issued in
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
          example: EUR
        preliminary:
          type: boolean
          description: >-
            Indicates that this is a preliminary calculation of the expected
            amount
        date:
          type: string
          format: date
          description: Date of the invoice
          example: '2021-02-15'
        type:
          type: string
          description: Type of the invoice
          enum:
            - TO_PATIENT
            - FROM_PROFILE
            - FEE
            - COMMISSION
          example: TO_PATIENT
        files:
          type: array
          description: List of the invoice files
          items:
            type: string
      title: Represents an invoice linked to the appointment
    AppointmentProfileDto:
      type: object
      properties:
        name:
          type: string
          description: Clinic name or doctor's first name
          example: John
        lastName:
          type: string
          description: Doctor's last name
          example: Smith
        prefix:
          type: string
          description: The profile prefix or clinic designation
          enum:
            - DR
            - PROF
            - CLINIC
            - NONE
          example: DR
        pseudonym:
          type: string
          description: Doctor's pseudonym or clinic's short name
          example: Dr. John S.
        gender:
          type: string
          description: Gender of a doctor
          enum:
            - MALE
            - FEMALE
            - BOTH
            - OTHER
          example: MALE
        photo:
          type: string
          description: Main picture of the profile
        experience:
          type: integer
          format: int32
          description: >-
            Years of experience as a doctor or years since establishment for a
            clinic
          example: 5
        prescriptionStates:
          type: array
          description: List of states where the doctor can prescribe
          items:
            type: string
            enum:
              - US_AL
              - US_AK
              - US_AZ
              - US_AR
              - US_CA
              - US_CO
              - US_CT
              - US_DE
              - US_DC
              - US_FL
              - US_GA
              - US_HI
              - US_ID
              - US_IL
              - US_IN
              - US_IA
              - US_KS
              - US_KY
              - US_LA
              - US_ME
              - US_MD
              - US_MA
              - US_MI
              - US_MN
              - US_MS
              - US_MO
              - US_MT
              - US_NE
              - US_NV
              - US_NH
              - US_NJ
              - US_NM
              - US_NY
              - US_NC
              - US_ND
              - US_OH
              - US_OK
              - US_OR
              - US_PA
              - US_RI
              - US_SC
              - US_SD
              - US_TN
              - US_TX
              - US_UT
              - US_VT
              - US_VA
              - US_WA
              - US_WV
              - US_WI
              - US_WY
              - DE_BW
              - DE_BY
              - DE_BE
              - DE_BB
              - DE_HB
              - DE_HH
              - DE_HE
              - DE_MV
              - DE_NI
              - DE_NW
              - DE_RP
              - DE_SL
              - DE_SN
              - DE_ST
              - DE_SH
              - DE_TH
              - CA_AB
              - CA_BC
              - CA_MB
              - CA_NB
              - CA_NL
              - CA_NT
              - CA_NS
              - CA_NU
              - CA_ON
              - CA_PE
              - CA_QC
              - CA_SK
              - CA_YT
              - IN_AN
              - IN_AP
              - IN_AR
              - IN_AS
              - IN_BR
              - IN_CH
              - IN_CG
              - IN_DH
              - IN_DL
              - IN_GA
              - IN_GJ
              - IN_HR
              - IN_HP
              - IN_JK
              - IN_JH
              - IN_KA
              - IN_KL
              - IN_LA
              - IN_LD
              - IN_MP
              - IN_MH
              - IN_MN
              - IN_ML
              - IN_MZ
              - IN_NL
              - IN_OD
              - IN_PY
              - IN_PB
              - IN_RJ
              - IN_SK
              - IN_TN
              - IN_TS
              - IN_TR
              - IN_UP
              - IN_UK
              - IN_WB
              - AU_NSW
              - AU_QLD
              - AU_SA
              - AU_TAS
              - AU_VIC
              - AU_WA
              - AU_ACT
              - AU_NT
              - CH_ZH
              - CH_BE
              - CH_LU
              - CH_UR
              - CH_SZ
              - CH_OW
              - CH_NW
              - CH_GL
              - CH_ZG
              - CH_FR
              - CH_SO
              - CH_BS
              - CH_BL
              - CH_SH
              - CH_AR
              - CH_AI
              - CH_SG
              - CH_GR
              - CH_AG
              - CH_TG
              - CH_TI
              - CH_VD
              - CH_VS
              - CH_NE
              - CH_GE
              - CH_JU
              - BR_AC
              - BR_AL
              - BR_AM
              - BR_AP
              - BR_BA
              - BR_CE
              - BR_DF
              - BR_ES
              - BR_GO
              - BR_MA
              - BR_MG
              - BR_MS
              - BR_MT
              - BR_PA
              - BR_PB
              - BR_PE
              - BR_PI
              - BR_PR
              - BR_RJ
              - BR_RN
              - BR_RO
              - BR_RR
              - BR_RS
              - BR_SC
              - BR_SE
              - BR_SP
              - BR_TO
        prescriptionCountriesByMatrix:
          type: array
          description: List of countries where the doctor can prescribe by matrix
          items:
            type: string
            enum:
              - AD
              - AE
              - AF
              - AG
              - AI
              - AL
              - AM
              - AO
              - AR
              - AS
              - AT
              - AU
              - AW
              - AX
              - AZ
              - BA
              - BB
              - BD
              - BE
              - BF
              - BG
              - BH
              - BI
              - BJ
              - BL
              - BM
              - BN
              - BO
              - BQ
              - BR
              - BS
              - BT
              - BV
              - BW
              - BY
              - BZ
              - CA
              - CC
              - CD
              - CF
              - CG
              - CH
              - CI
              - CK
              - CL
              - CM
              - CN
              - CO
              - CR
              - CU
              - CV
              - CW
              - CX
              - CY
              - CZ
              - DE
              - DJ
              - DK
              - DM
              - DO
              - DZ
              - EC
              - EE
              - EG
              - EH
              - ER
              - ES
              - ET
              - FI
              - FJ
              - FK
              - FM
              - FO
              - FR
              - GA
              - GB
              - GD
              - GE
              - GF
              - GG
              - GH
              - GI
              - GL
              - GM
              - GN
              - GP
              - GQ
              - GR
              - GS
              - GT
              - GU
              - GW
              - GY
              - HK
              - HN
              - HR
              - HT
              - HU
              - ID
              - IE
              - IL
              - IM
              - IN
              - IO
              - IQ
              - IR
              - IS
              - IT
              - JE
              - JM
              - JO
              - JP
              - KE
              - KG
              - KH
              - KI
              - KM
              - KN
              - KP
              - KR
              - KW
              - KY
              - KZ
              - LA
              - LB
              - LC
              - LI
              - LK
              - LR
              - LS
              - LT
              - LU
              - LV
              - LY
              - MA
              - MC
              - MD
              - ME
              - MF
              - MG
              - MH
              - MK
              - ML
              - MM
              - MN
              - MO
              - MQ
              - MR
              - MS
              - MT
              - MU
              - MV
              - MW
              - MX
              - MY
              - MZ
              - NA
              - NC
              - NE
              - NF
              - NG
              - NI
              - NL
              - 'NO'
              - NP
              - NR
              - NU
              - NZ
              - OM
              - PA
              - PE
              - PF
              - PG
              - PH
              - PK
              - PL
              - PM
              - PN
              - PR
              - PS
              - PT
              - PW
              - PY
              - QA
              - RE
              - RO
              - RS
              - RU
              - RW
              - SA
              - SB
              - SC
              - SD
              - SE
              - SG
              - SH
              - SI
              - SJ
              - SK
              - SL
              - SM
              - SN
              - SO
              - SR
              - SS
              - ST
              - SV
              - SX
              - SY
              - SZ
              - TC
              - TD
              - TF
              - TG
              - TH
              - TJ
              - TK
              - TL
              - TM
              - TN
              - TO
              - TR
              - TT
              - TV
              - TW
              - TZ
              - UA
              - UG
              - UM
              - US
              - UY
              - UZ
              - VA
              - VC
              - VE
              - VG
              - VI
              - VN
              - VU
              - WF
              - WS
              - YE
              - YT
              - ZA
              - ZM
              - ZW
              - XK
        prescriptionCountriesByDataEntry:
          type: array
          description: List of countries where the doctor can prescribe by Data Entry
          items:
            type: string
            enum:
              - AD
              - AE
              - AF
              - AG
              - AI
              - AL
              - AM
              - AO
              - AR
              - AS
              - AT
              - AU
              - AW
              - AX
              - AZ
              - BA
              - BB
              - BD
              - BE
              - BF
              - BG
              - BH
              - BI
              - BJ
              - BL
              - BM
              - BN
              - BO
              - BQ
              - BR
              - BS
              - BT
              - BV
              - BW
              - BY
              - BZ
              - CA
              - CC
              - CD
              - CF
              - CG
              - CH
              - CI
              - CK
              - CL
              - CM
              - CN
              - CO
              - CR
              - CU
              - CV
              - CW
              - CX
              - CY
              - CZ
              - DE
              - DJ
              - DK
              - DM
              - DO
              - DZ
              - EC
              - EE
              - EG
              - EH
              - ER
              - ES
              - ET
              - FI
              - FJ
              - FK
              - FM
              - FO
              - FR
              - GA
              - GB
              - GD
              - GE
              - GF
              - GG
              - GH
              - GI
              - GL
              - GM
              - GN
              - GP
              - GQ
              - GR
              - GS
              - GT
              - GU
              - GW
              - GY
              - HK
              - HN
              - HR
              - HT
              - HU
              - ID
              - IE
              - IL
              - IM
              - IN
              - IO
              - IQ
              - IR
              - IS
              - IT
              - JE
              - JM
              - JO
              - JP
              - KE
              - KG
              - KH
              - KI
              - KM
              - KN
              - KP
              - KR
              - KW
              - KY
              - KZ
              - LA
              - LB
              - LC
              - LI
              - LK
              - LR
              - LS
              - LT
              - LU
              - LV
              - LY
              - MA
              - MC
              - MD
              - ME
              - MF
              - MG
              - MH
              - MK
              - ML
              - MM
              - MN
              - MO
              - MQ
              - MR
              - MS
              - MT
              - MU
              - MV
              - MW
              - MX
              - MY
              - MZ
              - NA
              - NC
              - NE
              - NF
              - NG
              - NI
              - NL
              - 'NO'
              - NP
              - NR
              - NU
              - NZ
              - OM
              - PA
              - PE
              - PF
              - PG
              - PH
              - PK
              - PL
              - PM
              - PN
              - PR
              - PS
              - PT
              - PW
              - PY
              - QA
              - RE
              - RO
              - RS
              - RU
              - RW
              - SA
              - SB
              - SC
              - SD
              - SE
              - SG
              - SH
              - SI
              - SJ
              - SK
              - SL
              - SM
              - SN
              - SO
              - SR
              - SS
              - ST
              - SV
              - SX
              - SY
              - SZ
              - TC
              - TD
              - TF
              - TG
              - TH
              - TJ
              - TK
              - TL
              - TM
              - TN
              - TO
              - TR
              - TT
              - TV
              - TW
              - TZ
              - UA
              - UG
              - UM
              - US
              - UY
              - UZ
              - VA
              - VC
              - VE
              - VG
              - VI
              - VN
              - VU
              - WF
              - WS
              - YE
              - YT
              - ZA
              - ZM
              - ZW
              - XK
        clinicName:
          type: string
          description: Appointment's location name
        phones:
          type: array
          description: List of location's phone numbers (privileged)
          items:
            type: string
        zipCode:
          type: string
          description: Postal or zip code (privileged)
          example: 10029
        city:
          type: string
          description: City (privileged)
          example: New York
        street:
          type: string
          description: Street name (privileged)
          example: Madison Ave
        number:
          type: string
          description: Street number (privileged)
          example: 1468
        floor:
          type: string
          description: Floor number in the building (privileged)
          example: 3
        entrance:
          type: string
          description: Entrance name or number (privileged)
          example: 2a
        room:
          type: string
          description: Room or office number (privileged)
          example: 3284
        addressNotes:
          type: string
          description: Any special address notes (privileged)
          example: Take the second elevator
        latitude:
          type: number
          format: double
          description: >-
            Location latitude (privileged: will not be exact, unless granted
            access to)
          example: 40.79
        longitude:
          type: number
          format: double
          description: >-
            Location longitude (privileged: will not be exact, unless granted
            access to)
          example: -73.953
        spokenLanguages:
          type: array
          description: List languages the doctor speaks or are understood within the clinic
          items:
            type: string
            enum:
              - AA
              - AB
              - AE
              - AF
              - AK
              - AM
              - AN
              - AR
              - AS
              - AV
              - AY
              - AZ
              - BA
              - BE
              - BG
              - BH
              - BI
              - BM
              - BN
              - BO
              - BR
              - BS
              - CA
              - CE
              - CH
              - CO
              - CR
              - CS
              - CU
              - CV
              - CY
              - DA
              - DE
              - DV
              - DZ
              - EE
              - EL
              - EN
              - EO
              - ES
              - ET
              - EU
              - FA
              - FF
              - FI
              - FJ
              - FO
              - FR
              - FY
              - GA
              - GD
              - GL
              - GN
              - GU
              - GV
              - HA
              - HE
              - HI
              - HO
              - HR
              - HT
              - HU
              - HY
              - HZ
              - IA
              - ID
              - IE
              - IG
              - II
              - IK
              - IO
              - IS
              - IT
              - IU
              - JA
              - JV
              - KA
              - KG
              - KI
              - KJ
              - KK
              - KL
              - KM
              - KN
              - KO
              - KR
              - KS
              - KU
              - KV
              - KW
              - KY
              - LA
              - LB
              - LG
              - LI
              - LN
              - LO
              - LT
              - LU
              - LV
              - MG
              - MH
              - MI
              - MK
              - ML
              - MN
              - MR
              - MS
              - MT
              - MY
              - NA
              - NB
              - ND
              - NE
              - NG
              - NL
              - NN
              - 'NO'
              - NR
              - NV
              - NY
              - OC
              - OJ
              - OM
              - OR
              - OS
              - PA
              - PI
              - PL
              - PS
              - PT
              - QU
              - RM
              - RN
              - RO
              - RU
              - RW
              - SA
              - SC
              - SD
              - SE
              - SG
              - SI
              - SK
              - SL
              - SM
              - SN
              - SO
              - SQ
              - SR
              - SS
              - ST
              - SU
              - SV
              - SW
              - TA
              - TE
              - TG
              - TH
              - TI
              - TK
              - TL
              - TN
              - TO
              - TR
              - TS
              - TT
              - TW
              - TY
              - UG
              - UK
              - UR
              - UZ
              - VE
              - VI
              - VO
              - WA
              - WO
              - XH
              - YI
              - YO
              - ZA
              - ZH
              - YUE
              - ZU
        profilesDelta:
          type: integer
          format: int32
          description: >-
            Delta time in minutes between the user's local time and the current
            profile's local time
          example: -300
    ClaimDetailsDto:
      type: object
      properties:
        appointmentId:
          type: integer
          format: int32
          description: >-
            ID of an appointment, if this claim is filed in relation to a
            managed appointment
          example: 1987
        companyId:
          type: integer
          format: int32
          description: ID of the company having claim submitted to
          example: 1
        bankId:
          type: integer
          format: int32
          description: Bank ID to transfer the claimed funds to
          example: 12
        branch:
          type: string
          description: Account branch name or number
          example: 855
        accountNumber:
          type: string
          description: Account number within the branch
          example: 432678
        accountHolder:
          type: string
          description: Account holder name
          example: John Smith
        accountTypeEnum:
          type: string
          description: Bank account type
          enum:
            - SAVINGS
            - CURRENT
            - OTHERS
          example: SAVINGS
        bankName:
          type: string
          description: Bank name
          example: First International Bank
        bankNumber:
          type: string
          description: Bank number
          example: IL170108000000012612345
        codeNumber:
          type: string
          description: Bank code number
          example: 323232
        branchNumber:
          type: string
          description: Account branch number
          example: '00003456'
      title: Additional details, applicable for claims
    EventDto:
      type: object
      properties:
        eventId:
          type: integer
          format: int32
          description: Event id
        caseId:
          type: integer
          format: int32
          description: Case id
        parentEventId:
          type: integer
          format: int32
          description: Parent event id
        initiatorUserName:
          type: string
          description: Event initiator name
        initiatorId:
          type: integer
          format: int32
          description: Event initiator id
        patientUserName:
          type: string
          description: Patient name
        subscriberId:
          type: integer
          format: int32
          description: Subscriber id
        profileId:
          type: integer
          format: int32
          description: Doctor id
        profileFullName:
          type: string
          description: Doctor full name
        aggregatorId:
          type: integer
          format: int32
          description: Clinic id
        appointmentId:
          type: integer
          format: int32
          description: Appointment id
        assigneeId:
          type: integer
          format: int32
          description: Admin id
        statusId:
          type: integer
          format: int32
          description: Event status id
        department:
          type: string
          description: Department type
          enum:
            - ACCOUNT
            - BILLING
            - CS
            - CS_OPERATION
            - DATA
            - DR_COMM
            - FINANCE
            - HR
            - PRODUCT
            - QA
            - SCALE
            - TRAINING
            - TRANSLATION
            - TIER_2
            - PORTAL
        dueTimestamp:
          type: string
          format: date-time
          description: Event expiration time
        timestamp:
          type: string
          format: date-time
          description: Event creation time
        amount:
          type: number
          format: double
          description: Event amount
        internalNote:
          type: string
          description: Event internal note
        publicNote:
          type: string
          description: Event public note
        currency:
          type: string
          description: Event currency
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
        paymentMethod:
          type: string
          description: Event payment method
          enum:
            - CREDIT_CARD
            - CASH
            - NO_PAYMENT
            - PAYPAL
            - BANK_TRANSFER
            - PAYONEER
            - MASAV
            - E_PAYMENT
            - REPRESENTATIVE
            - PAID_EXTERNALLY
            - GOOGLE_PAY
            - APPLE_PAY
            - AIRWALLEX
        type:
          type: string
          description: Event type
          enum:
            - APPOINTMENT_UPDATE
            - SWITCH_PATIENT
            - PAYMENT_METHOD
            - DOCTOR_PAYMENT
            - INVOICE_STATUS
            - CHARGE_INSURANCE_FEE
            - CHARGE_INSURANCE_COMMISSION
            - PATIENT_CREDIT_CARD
            - CREDIT_CARD_WAS_EXPIRED
            - CHARGE_PATIENT
            - REFUND_PATIENT
            - CAPTURE_CHARGE
            - REIMBURSEMENT_PATIENT
            - PAYMENT_FAILED
            - CLAIM_SUBMITTED
            - POLICY_RENEW
            - CONTACT_INSURANCE
            - CONTACT_FORM
            - INSURANCE_ANOTHER_CLAIM
            - POLICY_ADDED
            - REVIEW
            - APPLICATION_REVIEW
            - EXTEND_PROCESSING
            - INTERNAL_NOTE
            - MESSAGE_IMAGING
            - TICKET_OPENED
            - TICKET_CLOSED
            - CASE_CREATED
            - CASE_OWNER_CHANGED
            - CASE_TYPE_CHANGED
            - CASE_SUB_TYPE_CHANGED
            - CASE_PRIORITY_CHANGED
            - CASE_STATUS_CHANGED
            - CASE_CLOSED
            - CASE_PATIENT_CHANGED
            - ALTERNATIVE_NAME
            - CASE_DEPARTMENT_CHANGED
            - CASE_LINK_TO_USER
            - ANONYMOUS_CASE_CREATED
            - ERROR
            - REMOVE_MESSAGE_SERVICE
            - USER_LOCATION_CHANGED
            - RELATED_CASE_CHANGED
            - CS_TIME_TRACKING
            - TEST_USER_TYPE_CHANGED
            - LOST_PATIENT_RECOVERY
            - LOST_PATIENT_TRIGGER
            - VIDEO_ROOM_STATUS_CHANGE
            - VIDEO_ROOM_INTERPRETER_INVITATION
            - GUARANTEE_OF_PAYMENT
            - TRANSFER_MESSAGES
            - HANDOVER_TO_ASSISTANCE
            - MFA_UPDATE
            - SMS_OPT_IN
            - SMS_OPT_OUT
            - ADJUSTMENT_CREATED
            - DIRECT_CLINIC
            - USER_SOURCE_IDENTIFIED
        issueId:
          type: integer
          format: int32
          description: Event issue
        photos:
          type: array
          description: Event attachments
          items:
            $ref: '#/components/schemas/PhotoDto'
        invoiceIdList:
          type: array
          description: >-
            List of event ids with status 'Invoice Status' associated with the
            event
          items:
            type: integer
            format: int32
        paymentIdList:
          type: array
          description: >-
            List of event ids with status 'Doctor Payment' associated with the
            event
          items:
            type: integer
            format: int32
      title: A holder containing information about event.
    ExchangeRateDto:
      type: object
      properties:
        from:
          type: string
          format: date-time
          description: The start date of exchange rate's range (inclusive)
          example: 2022-08-25T00:00
        till:
          type: string
          format: date-time
          description: The end date of exchange rate's range (exclusive)
          example: 2022-08-26T00:00
        rate:
          type: number
          format: double
          description: Currency exchange rate against the USD
          example: 0.995481
      title: Exchange rate info by a date-time range
    HoursDto:
      type: object
      properties:
        dayOfWeek:
          type: string
          description: Day of week (all details are given per day of week)
          enum:
            - MONDAY
            - TUESDAY
            - WEDNESDAY
            - THURSDAY
            - FRIDAY
            - SATURDAY
            - SUNDAY
          example: MONDAY
        startTimes:
          type: array
          description: >-
            List of work start times for the day (given as minutes since
            midnight; for "8:00-14:00, 16:30-20:00" this list will contain [480,
            990])
          items:
            type: integer
            format: int32
        endTimes:
          type: array
          description: >-
            List of work end times for the day (given as minutes since midnight;
            for "8:00-14:00, 16:30-20:00" this list will contain [840, 1200])
          items:
            type: integer
            format: int32
        feeWorkingHours:
          type: number
          format: double
          description: Visit fee during working hours (in profile's currency)
          example: 100
        workingHoursAvailability:
          type: boolean
          description: Availability of working hours
          example: true
        locationAvailabilityStatus:
          type: string
          description: Status of location availability
          enum:
            - HIDE
            - SHOW_BLOCK
            - ASSISTANCE
            - PAY
            - PREPAYMENT
            - CC_BACKUP
            - COVERED
            - PAY_UNDER_INSURER
          example: COVERED
        locationAvailabilityMessageId:
          type: integer
          format: int32
          description: Message identifier for location availability
        feeOffHours:
          type: number
          format: double
          description: Visit fee for off hours (in profile's currency)
          example: 120
        offHoursAvailability:
          type: boolean
          description: Availability of off hours
          example: true
      title: >-
        Record defining the working hours and the cost of a visit for a given
        location
    InsuranceCompanyClientDto:
      type: object
      properties:
        companyId:
          type: integer
          format: int32
          description: Unique insurance company ID
          example: 1
        logos:
          type: object
          additionalProperties:
            type: string
          description: Logo type and logo path
          example: LIGHT_BACKGROUND_LOGO,  56734892042353.png
        color:
          type: integer
          format: int32
          description: Corporate color
          example: ff00ff
        homeCountry:
          type: string
          description: Home country
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
          example: MX
        followUpWindowLength:
          type: integer
          format: int32
          description: >-
            Time window from last appointment, when a follow-up is possible
            (seconds)
          example: 604800
        followUpQuestion:
          type: string
          description: Follow up visit Question
          enum:
            - ALWAYS
            - ONLY_FOR_EXCESS
            - NEVER
          example: ALWAYS
        policyRenewalURL:
          type: string
          description: The URL to redirect the user to request policy renewal
          example: https://www.carrier.com/renew/
        claimsContactPhone:
          type: string
          description: Phone number to use for a submitted claim follow-ups
          example: '+14676784322'
        claimsDelayedFlightURL:
          type: string
          description: The URL to redirect the user to submit a delayed flight claim
          example: https://www.carrier.com/delay/
        claimsLostLuggageURL:
          type: string
          description: The URL to redirect the user to submit a lost luggage claim
          example: https://www.carrier.com/lost-luggage/
        claimsDelayedLuggageURL:
          type: string
          description: The URL to redirect the user to submit a delayed luggage claim
          example: https://www.carrier.com/delayed-luggage/
        idFields:
          type: array
          description: List of fields which the user should fill to identify the policy
          items:
            type: string
            enum:
              - COMPANY
              - SUBSCRIBER_ID
              - POLICY_NUMBER
              - FIRST_NAME
              - LAST_NAME
              - GENDER
              - PERSONAL_ID_NUMBER
              - DATE_OF_BIRTH
              - POLICY_START_DATE
              - POLICY_END_DATE
              - PHONE_NUMBER
              - EMAIL_ADDRESS
              - CARD_4_DIGITS
              - TRAVEL_START_DATE
              - TRAVEL_END_DATE
              - EXCESS
              - EXCESS_CURRENCY
              - PASSWORD_HINT
              - LATITUDE
              - LONGITUDE
              - PACKAGE
              - SPECIALITY
              - LANGUAGE
        personalIdRegEx:
          type: string
          description: >-
            Person's government ID number's validation regular expression
            (usually either an identity card number or a passport number)
          example: '[0-9]{9,9}'
        policyNumberRegEx:
          type: string
          description: Policy number's validation regular expression
          example: '[0-9]{9,9}'
        assistancePhone:
          type: string
          description: Phone number to advise the user to call for assistance service
          example: '+16782348902'
        assistanceEmail:
          type: string
          description: Assistance service email address
          example: help@carrier.com
        assistanceLanguages:
          type: array
          description: List of languages spoken in the carrier's assistance service
          items:
            type: string
            enum:
              - AA
              - AB
              - AE
              - AF
              - AK
              - AM
              - AN
              - AR
              - AS
              - AV
              - AY
              - AZ
              - BA
              - BE
              - BG
              - BH
              - BI
              - BM
              - BN
              - BO
              - BR
              - BS
              - CA
              - CE
              - CH
              - CO
              - CR
              - CS
              - CU
              - CV
              - CY
              - DA
              - DE
              - DV
              - DZ
              - EE
              - EL
              - EN
              - EO
              - ES
              - ET
              - EU
              - FA
              - FF
              - FI
              - FJ
              - FO
              - FR
              - FY
              - GA
              - GD
              - GL
              - GN
              - GU
              - GV
              - HA
              - HE
              - HI
              - HO
              - HR
              - HT
              - HU
              - HY
              - HZ
              - IA
              - ID
              - IE
              - IG
              - II
              - IK
              - IO
              - IS
              - IT
              - IU
              - JA
              - JV
              - KA
              - KG
              - KI
              - KJ
              - KK
              - KL
              - KM
              - KN
              - KO
              - KR
              - KS
              - KU
              - KV
              - KW
              - KY
              - LA
              - LB
              - LG
              - LI
              - LN
              - LO
              - LT
              - LU
              - LV
              - MG
              - MH
              - MI
              - MK
              - ML
              - MN
              - MR
              - MS
              - MT
              - MY
              - NA
              - NB
              - ND
              - NE
              - NG
              - NL
              - NN
              - 'NO'
              - NR
              - NV
              - NY
              - OC
              - OJ
              - OM
              - OR
              - OS
              - PA
              - PI
              - PL
              - PS
              - PT
              - QU
              - RM
              - RN
              - RO
              - RU
              - RW
              - SA
              - SC
              - SD
              - SE
              - SG
              - SI
              - SK
              - SL
              - SM
              - SN
              - SO
              - SQ
              - SR
              - SS
              - ST
              - SU
              - SV
              - SW
              - TA
              - TE
              - TG
              - TH
              - TI
              - TK
              - TL
              - TN
              - TO
              - TR
              - TS
              - TT
              - TW
              - TY
              - UG
              - UK
              - UR
              - UZ
              - VE
              - VI
              - VO
              - WA
              - WO
              - XH
              - YI
              - YO
              - ZA
              - ZH
              - YUE
              - ZU
        priceLimits:
          type: array
          description: The list of maximum fee covered by this insurance
          items:
            $ref: '#/components/schemas/PriceLimitDto'
        primaryCurrency:
          type: string
          description: The company's main currency
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
        currencyList:
          type: array
          description: List of currencies accepted by this insurance company
          items:
            type: string
            enum:
              - AED
              - ALL
              - AMD
              - ANG
              - ARS
              - AUD
              - AWG
              - BAM
              - BBD
              - BGN
              - BHD
              - BMD
              - BND
              - BOB
              - BRL
              - BSD
              - BWP
              - BYR
              - CAD
              - CHF
              - CLP
              - CNY
              - COP
              - CRC
              - CZK
              - DKK
              - DOP
              - DZD
              - EGP
              - EUR
              - FJD
              - GBP
              - GEL
              - GIP
              - GTQ
              - HKD
              - HRK
              - HUF
              - IDR
              - ILS
              - INR
              - ISK
              - JMD
              - JOD
              - JPY
              - KES
              - KHR
              - KRW
              - KWD
              - KYD
              - KZT
              - LBP
              - LKR
              - MAD
              - MDL
              - MKD
              - MRO
              - MUR
              - MWK
              - MXN
              - MYR
              - NAD
              - NGN
              - NOK
              - NPR
              - NZD
              - OMR
              - PAB
              - PEN
              - PGK
              - PHP
              - PKR
              - PLN
              - QAR
              - RON
              - RSD
              - RUB
              - SAR
              - SCR
              - SDG
              - SEK
              - SGD
              - THB
              - TND
              - TRY
              - TTD
              - TWD
              - TZS
              - UAH
              - USD
              - UYU
              - UZS
              - VEF
              - VND
              - XCD
              - XOF
              - ZAR
              - AFN
              - AOA
              - AZN
              - BDT
              - BIF
              - BZD
              - CDF
              - CVE
              - DJF
              - ETB
              - FKP
              - GMD
              - GNF
              - GYD
              - HNL
              - HTG
              - KGS
              - KMF
              - LAK
              - LRD
              - LSL
              - MGA
              - MMK
              - MNT
              - MOP
              - MVR
              - MZN
              - NIO
              - PYG
              - RWF
              - SBD
              - SHP
              - SLL
              - SOS
              - SRD
              - STD
              - SZL
              - TJS
              - TOP
              - UGX
              - VUV
              - WST
              - XAF
              - XPF
              - YER
              - ZMW
        excessRecipient:
          type: string
          description: 'Whom does the patient pay excess: doctor owner, doctor or air-doctor'
          enum:
            - AIR_DOCTOR
            - PATIENT_DIRECT
            - OWNER
        permissibleOwners:
          type: array
          description: >-
            Profile owners, permissible for this insurance company referred
            patients
          items:
            type: integer
            format: int32
        permissibleDistance:
          type: integer
          format: int32
          description: >-
            The maximum distance from the patient to profile to present the
            profile in the list (meters)
          example: 50000
        urgentPhone:
          type: string
          description: Urgent phone number to advise the user to call for urgent service
          example: '+16782348902'
        defaultLongitude:
          type: number
          format: double
          description: >-
            Default location longitude, when exact user's location is not
            available
          example: 48.8566
        defaultLatitude:
          type: number
          format: double
          description: >-
            Default location latitude, when exact user's location is not
            available
          example: 2.3522
        visitSummaryRequiredEnum:
          type: string
          description: Is visit summary required
          enum:
            - MUST_PROVIDED_BY_DOCTOR
            - SHOULD_PROVIDED_BY_SOMEHOW
            - NOT_REQUIRED
          example: NOT_REQUIRED
        contactLostPatient:
          type: string
          description: Contact lost patient service
          enum:
            - ALWAYS
            - ONLY_AFTER_LOGIN
            - NEVER
          example: NEVER
        packages:
          type: array
          description: List of the insurer packages
          items:
            $ref: '#/components/schemas/InsurerPackageClientDto'
        profileDisclaimer:
          type: object
          additionalProperties:
            type: string
          description: Specialty-specific doctor disclaimer
        patientDisclaimer:
          type: object
          additionalProperties:
            type: string
          description: Specialty-specific patient disclaimer
        language:
          type: string
          description: Primary company language
          enum:
            - ENGLISH
            - ENGLISH_UK
            - HEBREW
            - SPANISH
            - GERMAN
            - CHINESE
            - DUTCH
            - FRENCH
            - RUSSIAN
            - JAPANESE
            - ITALIAN
          example: ENGLISH
        companyCountriesIncluded:
          type: boolean
          description: Is countries list allowed by company
          example: true
        companyCountries:
          type: array
          description: List of allowed/forbidden countries
          items:
            type: string
            enum:
              - AD
              - AE
              - AF
              - AG
              - AI
              - AL
              - AM
              - AO
              - AR
              - AS
              - AT
              - AU
              - AW
              - AX
              - AZ
              - BA
              - BB
              - BD
              - BE
              - BF
              - BG
              - BH
              - BI
              - BJ
              - BL
              - BM
              - BN
              - BO
              - BQ
              - BR
              - BS
              - BT
              - BV
              - BW
              - BY
              - BZ
              - CA
              - CC
              - CD
              - CF
              - CG
              - CH
              - CI
              - CK
              - CL
              - CM
              - CN
              - CO
              - CR
              - CU
              - CV
              - CW
              - CX
              - CY
              - CZ
              - DE
              - DJ
              - DK
              - DM
              - DO
              - DZ
              - EC
              - EE
              - EG
              - EH
              - ER
              - ES
              - ET
              - FI
              - FJ
              - FK
              - FM
              - FO
              - FR
              - GA
              - GB
              - GD
              - GE
              - GF
              - GG
              - GH
              - GI
              - GL
              - GM
              - GN
              - GP
              - GQ
              - GR
              - GS
              - GT
              - GU
              - GW
              - GY
              - HK
              - HN
              - HR
              - HT
              - HU
              - ID
              - IE
              - IL
              - IM
              - IN
              - IO
              - IQ
              - IR
              - IS
              - IT
              - JE
              - JM
              - JO
              - JP
              - KE
              - KG
              - KH
              - KI
              - KM
              - KN
              - KP
              - KR
              - KW
              - KY
              - KZ
              - LA
              - LB
              - LC
              - LI
              - LK
              - LR
              - LS
              - LT
              - LU
              - LV
              - LY
              - MA
              - MC
              - MD
              - ME
              - MF
              - MG
              - MH
              - MK
              - ML
              - MM
              - MN
              - MO
              - MQ
              - MR
              - MS
              - MT
              - MU
              - MV
              - MW
              - MX
              - MY
              - MZ
              - NA
              - NC
              - NE
              - NF
              - NG
              - NI
              - NL
              - 'NO'
              - NP
              - NR
              - NU
              - NZ
              - OM
              - PA
              - PE
              - PF
              - PG
              - PH
              - PK
              - PL
              - PM
              - PN
              - PR
              - PS
              - PT
              - PW
              - PY
              - QA
              - RE
              - RO
              - RS
              - RU
              - RW
              - SA
              - SB
              - SC
              - SD
              - SE
              - SG
              - SH
              - SI
              - SJ
              - SK
              - SL
              - SM
              - SN
              - SO
              - SR
              - SS
              - ST
              - SV
              - SX
              - SY
              - SZ
              - TC
              - TD
              - TF
              - TG
              - TH
              - TJ
              - TK
              - TL
              - TM
              - TN
              - TO
              - TR
              - TT
              - TV
              - TW
              - TZ
              - UA
              - UG
              - UM
              - US
              - UY
              - UZ
              - VA
              - VC
              - VE
              - VG
              - VI
              - VN
              - VU
              - WF
              - WS
              - YE
              - YT
              - ZA
              - ZM
              - ZW
              - XK
        companySpecialties:
          type: array
          description: List of allowed specialties
          items:
            type: string
            enum:
              - GENERAL
              - DENTIST
              - ORTHOPEDIST
              - PEDIATRICIAN
              - GYNECOLOGIST
              - PULMONOLOGIST
              - GASTROENTEROLOGIST
              - OPHTALMOLOGIST
              - DERMATOLOGIST
              - NEUROLOGIST
              - ENT
              - PSYCHIATRIST
              - CARDIOLOGIST
              - UROLOGIST
              - ALTERNATIVE
              - OTHER
              - EMERGENCY
              - MORE
              - MASSEUSE
              - ONCOLOGIST
              - SURGEON
              - INTERNIST
              - HEMATOLOGIST
              - NEPHROLOGIST
              - RHEUMATOLOGIST
              - GERIATRICIAN
              - ALLERGOLOGIST
              - ONLINE_DOCTOR
              - IMAGING
              - LABS
        allowClinicVisit:
          type: boolean
          description: Is clinic visits allowed
        allowVideoVisit:
          type: boolean
          description: Is video visits allowed
        allowHomeVisit:
          type: boolean
          description: Is clinic visits allowed
        lastModifierName:
          type: string
          description: Name of the last user who modified the record
        lastUpdateTimestamp:
          type: string
          format: date-time
          description: Timestamp of the last modification of the record
        parentInsurerId:
          type: integer
          format: int32
          description: Parent company id
          example: 10
      title: Record describing a single insurance carrier (client-side data type)
    InsurancePolicyDto:
      type: object
      description: >-
        Almost all the fields are optional; on update any missing field will not
        be left as is
      properties:
        policyId:
          type: integer
          format: int32
          description: Unique insurance policy ID
          example: 123
        corporateName:
          type: string
          description: For corporate policies, the name of the company
          example: Over the Rainbow inc
        companyId:
          type: integer
          format: int32
          description: >-
            Insurance company ID (will be supplied by Air Doctor; security will
            forbid calls with the wrong value)
          example: 1
        policyNumber:
          type: string
          description: >-
            The insurance policy number (this is the unique identifier of the
            insurance policy for this call)
          example: 468239748923321
        creationDate:
          type: string
          format: date-time
          description: Timestamp when policy was created
          example: '2019-12-09T08:40:53'
        phone:
          type: string
          description: Phone number associated with the policy
          example: '+15467383892'
        startDate:
          type: string
          format: date
          description: Policy validity start date
          example: '2020-01-01'
        endDate:
          type: string
          format: date
          description: Policy validity end date
          example: '2020-12-31'
        status:
          type: string
          description: >-
            Status of the policy (policy deletion is not supported; pass
            CANCELLED to cancel the policy)
          enum:
            - ACTIVE
            - CANCELLED
          example: ACTIVE
        excessCurrency:
          type: string
          description: The currency of the excess (deductible) amount
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
          example: USD
        excessPercentage:
          type: number
          format: double
          description: >-
            Excess (deductible) to be charged for a visit (basic fee percentage;
            to remove excess, set to a negative value)
          example: 0.2
        excessFee:
          type: number
          format: double
          description: >-
            Excess (deductible) to be charged for a visit (fixed part; to remove
            excess, set to a negative value)
          example: 50
        accumulatedExcess:
          type: boolean
          description: >-
            Accumulated excess behaviour. “Atomic/copay” (if set to false) or
            all accumulated (if set to true)
        canRenewPolicy:
          type: boolean
          description: >-
            The insurance policy allows the user to request policy renewal (via
            insurer's website)
        canBookPrivately:
          type: boolean
          description: >-
            The insurance policy allows the user to book an appointment
            privately (ignoring the policy)
        canAddPatients:
          type: boolean
          description: >-
            The insurance policy allows the user to add patients to the policy
            (usually when the list of policyholders cannot be supplied upfront)
        canUseClinicVisits:
          type: boolean
          description: The patient can use clinic visits
        canUseHomeVisits:
          type: boolean
          description: The patient can use home visits
        canUseVideoVisits:
          type: boolean
          description: The patient can use video visits
        canBeDisabled:
          type: boolean
          description: The user is allowed to remove the policy from his account
        skipPolicyPull:
          type: boolean
          description: Policy skips external insurer's validation
        needsCreditCard:
          type: boolean
          description: The policy requires credit card entry to book an appointment
        requireTravelDates:
          type: boolean
          description: The policy can have the travel dates
        useStatus:
          type: string
          description: >-
            Association status for the current user (ignored for policy
            management; only used for token status)
          enum:
            - ACTIVE
            - CANCELLED
          example: ACTIVE
        usersLimit:
          type: integer
          format: int32
          default: '999'
          description: >-
            The number of users who can associate this policy to their account
            (0 value is ignored - 999 assumed; pass a negative value to set the
            field to zero)
          example: 1
        travelDates:
          type: array
          description: Travel dates for insurance policy
          items:
            $ref: '#/components/schemas/TravelDatesDto'
        packageType:
          type: integer
          format: int32
          description: The package type of policy
        associationDate:
          type: string
          format: date-time
          description: Timestamp when policy was associated to the user (GET only)
          example: '2019-12-09T08:40:53'
        touchedByAssistance:
          type: boolean
          description: TRUE if a policy was created or updated through the 'Assistance API'
        homeCountry:
          type: string
          description: Home country for policy
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
          example: BV
        notificationOnCreation:
          type: string
          description: The user can receive a notification about the creation of a policy
          enum:
            - SEND
            - OMIT
            - DEFAULT
          example: OMIT
        notificationOnUpdate:
          type: string
          description: The user can receive a notification about the update of a policy
          enum:
            - SEND
            - OMIT
            - DEFAULT
          example: SEND
        notificationOnCancelation:
          type: string
          description: The user can receive a notification about the cancel of a policy
          enum:
            - SEND
            - OMIT
            - DEFAULT
          example: DEFAULT
        notificationTimeBeforePolicyStart:
          type: integer
          format: int32
          description: >-
            Shows the time in seconds for which the user will receive a
            notification before creating the policy. 
             0 means default; -1 means do not send; any other negative means revert to default. 
          example: 86400
        distributorName:
          type: string
          description: Name of policy distributor company
          example: Delta
      required:
        - companyId
        - policyNumber
      title: Insurance policy record
    InsurerPackageClientDto:
      type: object
      properties:
        packageId:
          type: integer
          format: int32
          description: Unique insurance package ID
          example: 1002103
        packageDefinition:
          type: string
          description: Package description
          example: 1
        strings:
          $ref: '#/components/schemas/MapCompanyMessageEnumString'
          description: Multilingual message, as prescribed by the insurance package
        preferences:
          type: array
          description: List of preferences of the insurance company package
          items:
            type: string
            enum:
              - CAN_SUBMIT_CLAIMS
              - CAN_REQUEST_CASH_PROFILES
              - LOCK_IN_IN_ADVANCE
              - POLICY_DATES_UNKNOWN
              - LOCAL_POLICY
              - EXTRAS_FORBIDDEN
              - TEXTUAL_TIME_REQUEST
              - COUNT_FOLLOW_UP
              - CHARGE_NO_SHOW
              - CHARGE_LATE_CANCELLATION
              - SHOW_CANCELLATION_DISCLAIMER
              - DIRECTLY_SELECTABLE
              - POLICY_NUMBER_UNKNOWN
              - USES_VOUCHERS
              - INSURER_SENDS_NOTIFICATIONS
              - HIDE_URGENT_CARE
              - AUTO_EXTEND_CS_HOURS
              - SHOW_EXCESS_CALCULATION_BUTTON
              - CALL_ASSISTANCE_FROM_DIALOG
              - HIDE_CALL_ASSISTANCE_BUTTON
              - SKIP_PATIENT_NOTIFICATIONS
              - SKIP_PROFILE_NOTIFICATIONS
              - CHARGE_EXCESS_FOLLOW_UP
              - KEEP_POLICY_LEADING_ZEROS
              - USE_AIR_DOCTOR_ASSISTANCE
              - SKIP_REQUIRED_CREDIT_CARD
              - VIDEO_SERVICE_ONLY
              - SHOW_WARNING_BY_CATEGORY_CLICK
              - USE_ALTERNATIVE_ERROR_MESSAGE_WRONG_POLICY
              - COMPANIES_REP_CAN_NOT_EDIT_POLICY
              - SEND_MESSAGES_ON_CREATION_OF_POLICY
              - SEND_MESSAGES_ON_UPDATE_OF_POLICY
              - SEND_MESSAGES_ON_CANCELATION_OF_POLICY
              - HIDE_INSURER_ON_EDIT_PROFILE_PAGE
              - HAS_TWO_ASSISTANCE_COMPANIES
              - HIDE_POLICY_NUMBER
              - NO_SHOW_LIMIT_FOR_PAY_UNDER_INSURER_DIALOG
              - PULL_ONCE_WEBHOOK
              - SHOW_CONFIRMATION_CHECKBOX_FOR_RATE
              - PRODUCTION
              - GENERATE_POLICY_NUMBER_IF_EMPTY
              - NEED_TO_HANDLE_THIRD_PARTY_EXCEPTION
              - EXISTS_THIRD_PARTY_VALIDATION
              - HIDE_SUBMIT_CLAIM_FOR_INDIVIDUAL_POLICY
              - NOT_SKIP_ADD_COVERAGE_SCREEN
              - POLICY_ASSOCIATED_NUMBER_BY_BENEFICIARIES
              - HIDE_DOCTORS_AVAILABILITY_ON_ASSISTANCE_PAGE
              - CHARGE_COMMISSION_ON_FIRST_OPPORTUNITY
              - TOUCHED_BY_ASSISTANCE
              - SHOW_PACKAGES_ON_ASSISTANCE_PAGE
              - HIDE_EXCESS_ON_ASSISTANCE_PAGE
              - SHOW_EXCESS_CURRENCIES_ON_ASSISTANCE_PAGE
              - HIDE_ADD_BENEFICIARY_ON_ASSISTANCE_PAGE
              - HIDE_POLICY_START_DATE_ON_ASSISTANCE_PAGE
              - ASSISTANCE_ONLY
              - POLICY_PACKAGE_MANDATORY
              - HIDE_POLICY_END_DATE_ON_ASSISTANCE_PAGE
              - SHOW_CREATION_DATE_INSTEAD_OF_POLICY_DATES
              - SHOW_EXCESS_ON_OVERRIDE_SECTION
              - SHOW_VISITS_LIMIT_ON_OVERRIDE_SECTION
              - SHOW_COUNTRIES_ON_OVERRIDE_SECTION
              - SHOW_SPECIALTIES_ON_OVERRIDE_SECTION
              - SHOW_VISIT_TYPES_ON_OVERRIDE_SECTION
              - SHOW_FROM_DATE_ON_OVERRIDE_SECTION
              - SHOW_TO_DATE_ON_OVERRIDE_SECTION
              - PRESCRIBE_ONLY
              - SKIP_PRESCRIPTION_BY_MATRIX
              - LARGE_GREETING_POPUP
              - HOME_PAGE_DIRECT_CALL
              - HIDE_NEXT_VISIT_BUTTON
              - POLICY_CREATION_PROHIBITED
              - SHOW_COMPANY_IN_DIRECT_CLINIC_MODE
              - HAS_EXTERNAL_VALIDATION
              - POLICY_NUMBER_UNKNOWN_FOR_POLICY_CARD
              - REQUIRE_SIGNUP
              - INTERPRETER_ALLOWED
              - ALWAYS_SHOW_ALLOW_MORE_VISITS_BUTTON
              - SKIP_COMPANY_RESTRICTION_FOR_OVERRIDE
              - SHOW_PATIENTS_SELECTION_ON_OVERRIDE_SECTION
              - HAS_CLIENT_EXTERNAL_VALIDATION
              - USE_ADVANCED_CLAIM_FLOW
              - EXTRA_DISCLAIMER_OPTIONS_VISIBLE
              - HIDE_GENDER_FIELD_ON_ASSISTANCE_PAGE
              - HIDE_DOB_FIELD_ON_ASSISTANCE_PAGE
              - SET_GENDER_FIELD_MANDATORY_ON_ASSISTANCE_PAGE
              - SET_DOB_FIELD_MANDATORY_ON_ASSISTANCE_PAGE
      title: Record describing a single insurer package
    LocationDto:
      type: object
      description: >-
        For the fields below, `privileged` means that the field will be blank,
        if the user has not had a confirmed appointment in this location
      properties:
        locationId:
          type: integer
          format: int32
          description: The unique location ID
          example: 1234
        type:
          type: string
          description: Location type
          enum:
            - HOME_VISIT
            - CLINIC_VISIT
            - VIDEO_VISIT
          example: CLINIC
        status:
          type: string
          description: Location status (only ENABLED locations can have new appointments)
          enum:
            - ENABLED
            - DISABLED
            - ARCHIVED
          example: ENABLED
        maxRadius:
          type: integer
          format: int32
          description: >-
            Maximum acceptable radius around the coordinates for the home visit
            to be acceptable (in meters)
          example: 50000
        minFeeRadius:
          type: integer
          format: int32
          description: >-
            Minimum fee acceptable radius around the coordinates for the home
            visit to be acceptable (in meters)
          example: 1000
        feePerMeter:
          type: number
          format: double
          description: >-
            This fee applies to the distance between the inner circle and the
            outer circle for the home visit
          example: 0,10
        offHours:
          type: string
          description: Regular work schedule for this location
          enum:
            - WORKING_HOURS_ONLY
            - AVAILABLE_OFF_HOURS
            - AD_HOC
            - AD_HOC_24_7
            - NOT_AVAILABLE
          example: AVAILABLE_OFF_HOURS
        photos:
          type: array
          description: List of location's pictures
          items:
            type: string
        specialtyHours:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/HoursDto'
          description: Location's regular working hours and costs per specialty
        phones:
          type: array
          description: List of location's phone numbers (privileged)
          items:
            type: string
        name:
          type: string
          description: Location name (usually the clinic's name; privileged)
          example: Mount Sinai Hospital
        zipCode:
          type: string
          description: Postal or zip code (privileged)
          example: 10029
        city:
          type: string
          description: City (privileged)
          example: New York
        street:
          type: string
          description: Street name (privileged)
          example: Madison Ave
        number:
          type: string
          description: Street number (privileged)
          example: 1468
        floor:
          type: string
          description: Floor number in the building (privileged)
          example: 3
        entrance:
          type: string
          description: Entrance name or number (privileged)
          example: 2a
        room:
          type: string
          description: Room or office number (privileged)
          example: 3284
        addressNotes:
          type: string
          description: Any special address notes (privileged)
          example: Take the second elevator
        dispatchType:
          type: string
          description: Location dispatch type
          enum:
            - VIDEO_DISPATCH
          example: VIDEO_DISPATCH
        dispatchPassword:
          type: string
          description: Location dispatch password
          example: 123$!
        latitude:
          type: number
          format: double
          description: >-
            Location latitude (privileged: will not be exact, unless granted
            access to)
          example: 40.79
        longitude:
          type: number
          format: double
          description: >-
            Location longitude (privileged: will not be exact, unless granted
            access to)
          example: -73.953
        requiredData:
          type: string
          description: Indicates required data for appointment confirmation
          enum:
            - NONE
            - PASSPORT_NUMBER_AND_COUNTRY
            - PASSPORT_NUMBER_COUNTRY_AND_ISSUE_DATE
          example: PASSPORT_NUMBER_COUNTRY_AND_ISSUE_DATE
        requiresAccommodationAddress:
          type: string
          description: >-
            Indicates whether accommodation address is required for appointment
            confirmation or not
          enum:
            - NOT_REQUIRED
            - REQUIRED
          example: NOT_REQUIRED
        requiresHomeAddress:
          type: string
          description: >-
            Indicates whether home address is required for appointment
            confirmation or not
          enum:
            - NOT_REQUIRED
            - REQUIRED
          example: REQUIRED
      title: Location record (physical clinic, home visit or a video call)
    MapCompanyMessageEnumString:
      type: object
      description: Multilingual message, as prescribed by the insurance package
      properties:
        NAME:
          type: string
        INTERNAL_NAME:
          type: string
        GREETING:
          type: string
        URGENT_CARE:
          type: string
        PREPAYMENT_DISCLAIMER:
          type: string
        PAYMENT_DISCLAIMER:
          type: string
        ASSISTANCE_COMPANY_NAME:
          type: string
        SUPPORT_AVAILABILITY:
          type: string
        ASSISTANCE_MESSAGE:
          type: string
        ADDING_NEW_PATIENT_DISCLAIMER:
          type: string
        EXCESS_PAYMENT_DISCLAIMER:
          type: string
        NO_NEED_TO_PAY_DISCLAIMER:
          type: string
        ADDITIONAL_VISIT_SUMMARY_DISCLAIMER:
          type: string
        MESSAGE_FOR_EXCLUDED_COUNTRY:
          type: string
        ASSISTANCE_CALL_COMPANY:
          type: string
        CALL_ASSISTANCE_OPTION:
          type: string
        POLICY_NUMBER_FIELD_NAME:
          type: string
        PENDING_MESSAGE:
          type: string
        POLICYHOLDERS_DATE_OF_BIRTH_FIELD_NAME:
          type: string
        WORD_FOR_EXCESS:
          type: string
        THIRD_PARTY_DATA_INVALID_MESSAGE:
          type: string
        THIRD_PARTY_NO_COVERED_MESSAGE:
          type: string
        POLICY_HEADER_NAME:
          type: string
        POLICY_NOT_FOUND_MESSAGE:
          type: string
        WRONG_POLICY_NUMBER_MESSAGE:
          type: string
        INVOICE_TITLE:
          type: string
        CREDIT_INVOICE_TITLE:
          type: string
        GREETING_TITLE:
          type: string
        OVERRIDE_NO_AVAILABILITY_OF_AD_PROVIDERS:
          type: string
        OVERRIDE_REFERRAL_TO_PROCEDURE:
          type: string
        OVERRIDE_REFERRAL_TO_SPECIALIST:
          type: string
        OVERRIDE_URGENT_CARE_NEEDED:
          type: string
        OVERRIDE_EVACUATION:
          type: string
        OVERRIDE_FLY_BACK_HOME:
          type: string
        OVERRIDE_PATIENT_IN_HOSPITAL:
          type: string
        COVERAGE_WORDING:
          type: string
        NAME_FOR_DIRECT_CLINIC:
          type: string
        OVERRIDE_EXCEEDING_COST_LIMITATION:
          type: string
        OVERRIDE_TEXT_VISIT_IS_COVERED:
          type: string
        OVERRIDE_TEXT_COVERED_INSURANCE:
          type: string
        OVERRIDE_TEXT_EXCESS_CHARGES_FOLLOWUP:
          type: string
        FUTURE_POLICY_CANNOT_BOOK_PRIVATELY_CAN_ADD_POLICY:
          type: string
        EXPIRED_POLICY_SOON_CANNOT_BOOK_PRIVATELY_CAN_ADD_POLICY:
          type: string
        EXPIRED_POLICY_CANNOT_BOOK_PRIVATELY_CAN_ADD_POLICY:
          type: string
        MEDICINE_NOTE_IN_THE_DISCLAIMER_ENGINE:
          type: string
        OVERRIDE_TEXT_ADD_COVERAGE_BUTTON:
          type: string
      title: >-
        Map giving a value based on Type of insurance carrier specific,
        multilingual strings
    MapCurrencyEnumDouble:
      type: object
      description: Currencies exchange rates compared to the US dollar.
      properties:
        AED:
          type: number
          format: double
        ALL:
          type: number
          format: double
        AMD:
          type: number
          format: double
        ANG:
          type: number
          format: double
        ARS:
          type: number
          format: double
        AUD:
          type: number
          format: double
        AWG:
          type: number
          format: double
        BAM:
          type: number
          format: double
        BBD:
          type: number
          format: double
        BGN:
          type: number
          format: double
        BHD:
          type: number
          format: double
        BMD:
          type: number
          format: double
        BND:
          type: number
          format: double
        BOB:
          type: number
          format: double
        BRL:
          type: number
          format: double
        BSD:
          type: number
          format: double
        BWP:
          type: number
          format: double
        BYR:
          type: number
          format: double
        CAD:
          type: number
          format: double
        CHF:
          type: number
          format: double
        CLP:
          type: number
          format: double
        CNY:
          type: number
          format: double
        COP:
          type: number
          format: double
        CRC:
          type: number
          format: double
        CZK:
          type: number
          format: double
        DKK:
          type: number
          format: double
        DOP:
          type: number
          format: double
        DZD:
          type: number
          format: double
        EGP:
          type: number
          format: double
        EUR:
          type: number
          format: double
        FJD:
          type: number
          format: double
        GBP:
          type: number
          format: double
        GEL:
          type: number
          format: double
        GIP:
          type: number
          format: double
        GTQ:
          type: number
          format: double
        HKD:
          type: number
          format: double
        HRK:
          type: number
          format: double
        HUF:
          type: number
          format: double
        IDR:
          type: number
          format: double
        ILS:
          type: number
          format: double
        INR:
          type: number
          format: double
        ISK:
          type: number
          format: double
        JMD:
          type: number
          format: double
        JOD:
          type: number
          format: double
        JPY:
          type: number
          format: double
        KES:
          type: number
          format: double
        KHR:
          type: number
          format: double
        KRW:
          type: number
          format: double
        KWD:
          type: number
          format: double
        KYD:
          type: number
          format: double
        KZT:
          type: number
          format: double
        LBP:
          type: number
          format: double
        LKR:
          type: number
          format: double
        MAD:
          type: number
          format: double
        MDL:
          type: number
          format: double
        MKD:
          type: number
          format: double
        MRO:
          type: number
          format: double
        MUR:
          type: number
          format: double
        MWK:
          type: number
          format: double
        MXN:
          type: number
          format: double
        MYR:
          type: number
          format: double
        NAD:
          type: number
          format: double
        NGN:
          type: number
          format: double
        NOK:
          type: number
          format: double
        NPR:
          type: number
          format: double
        NZD:
          type: number
          format: double
        OMR:
          type: number
          format: double
        PAB:
          type: number
          format: double
        PEN:
          type: number
          format: double
        PGK:
          type: number
          format: double
        PHP:
          type: number
          format: double
        PKR:
          type: number
          format: double
        PLN:
          type: number
          format: double
        QAR:
          type: number
          format: double
        RON:
          type: number
          format: double
        RSD:
          type: number
          format: double
        RUB:
          type: number
          format: double
        SAR:
          type: number
          format: double
        SCR:
          type: number
          format: double
        SDG:
          type: number
          format: double
        SEK:
          type: number
          format: double
        SGD:
          type: number
          format: double
        THB:
          type: number
          format: double
        TND:
          type: number
          format: double
        TRY:
          type: number
          format: double
        TTD:
          type: number
          format: double
        TWD:
          type: number
          format: double
        TZS:
          type: number
          format: double
        UAH:
          type: number
          format: double
        USD:
          type: number
          format: double
        UYU:
          type: number
          format: double
        UZS:
          type: number
          format: double
        VEF:
          type: number
          format: double
        VND:
          type: number
          format: double
        XCD:
          type: number
          format: double
        XOF:
          type: number
          format: double
        ZAR:
          type: number
          format: double
        AFN:
          type: number
          format: double
        AOA:
          type: number
          format: double
        AZN:
          type: number
          format: double
        BDT:
          type: number
          format: double
        BIF:
          type: number
          format: double
        BZD:
          type: number
          format: double
        CDF:
          type: number
          format: double
        CVE:
          type: number
          format: double
        DJF:
          type: number
          format: double
        ETB:
          type: number
          format: double
        FKP:
          type: number
          format: double
        GMD:
          type: number
          format: double
        GNF:
          type: number
          format: double
        GYD:
          type: number
          format: double
        HNL:
          type: number
          format: double
        HTG:
          type: number
          format: double
        KGS:
          type: number
          format: double
        KMF:
          type: number
          format: double
        LAK:
          type: number
          format: double
        LRD:
          type: number
          format: double
        LSL:
          type: number
          format: double
        MGA:
          type: number
          format: double
        MMK:
          type: number
          format: double
        MNT:
          type: number
          format: double
        MOP:
          type: number
          format: double
        MVR:
          type: number
          format: double
        MZN:
          type: number
          format: double
        NIO:
          type: number
          format: double
        PYG:
          type: number
          format: double
        RWF:
          type: number
          format: double
        SBD:
          type: number
          format: double
        SHP:
          type: number
          format: double
        SLL:
          type: number
          format: double
        SOS:
          type: number
          format: double
        SRD:
          type: number
          format: double
        STD:
          type: number
          format: double
        SZL:
          type: number
          format: double
        TJS:
          type: number
          format: double
        TOP:
          type: number
          format: double
        UGX:
          type: number
          format: double
        VUV:
          type: number
          format: double
        WST:
          type: number
          format: double
        XAF:
          type: number
          format: double
        XPF:
          type: number
          format: double
        YER:
          type: number
          format: double
        ZMW:
          type: number
          format: double
      title: Map giving a value based on Currency
    MapCurrencyEnumListExchangeRateDto:
      type: object
      description: >-
        Currency history as exchange rates list that are based on appointments'
        scheduled dates.
      properties:
        AED:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        ALL:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        AMD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        ANG:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        ARS:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        AUD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        AWG:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        BAM:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        BBD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        BGN:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        BHD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        BMD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        BND:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        BOB:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        BRL:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        BSD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        BWP:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        BYR:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        CAD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        CHF:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        CLP:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        CNY:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        COP:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        CRC:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        CZK:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        DKK:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        DOP:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        DZD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        EGP:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        EUR:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        FJD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        GBP:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        GEL:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        GIP:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        GTQ:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        HKD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        HRK:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        HUF:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        IDR:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        ILS:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        INR:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        ISK:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        JMD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        JOD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        JPY:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        KES:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        KHR:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        KRW:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        KWD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        KYD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        KZT:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        LBP:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        LKR:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        MAD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        MDL:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        MKD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        MRO:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        MUR:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        MWK:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        MXN:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        MYR:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        NAD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        NGN:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        NOK:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        NPR:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        NZD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        OMR:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        PAB:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        PEN:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        PGK:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        PHP:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        PKR:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        PLN:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        QAR:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        RON:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        RSD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        RUB:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        SAR:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        SCR:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        SDG:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        SEK:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        SGD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        THB:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        TND:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        TRY:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        TTD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        TWD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        TZS:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        UAH:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        USD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        UYU:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        UZS:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        VEF:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        VND:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        XCD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        XOF:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        ZAR:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        AFN:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        AOA:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        AZN:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        BDT:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        BIF:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        BZD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        CDF:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        CVE:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        DJF:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        ETB:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        FKP:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        GMD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        GNF:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        GYD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        HNL:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        HTG:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        KGS:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        KMF:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        LAK:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        LRD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        LSL:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        MGA:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        MMK:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        MNT:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        MOP:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        MVR:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        MZN:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        NIO:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        PYG:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        RWF:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        SBD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        SHP:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        SLL:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        SOS:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        SRD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        STD:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        SZL:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        TJS:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        TOP:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        UGX:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        VUV:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        WST:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        XAF:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        XPF:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        YER:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
        ZMW:
          type: array
          items:
            $ref: '#/components/schemas/ExchangeRateDto'
      title: Map giving a value based on Currency
    PasswordHintDto:
      type: object
      properties:
        hint:
          type: string
          description: Last password action taken (reset, change, etc.)
          enum:
            - SET
            - CHANGED
            - PASSWORD_RESET_REQUESTED
            - FACEBOOK
            - GOOGLE
            - APPLE
            - OAUTH2
          example: SET
        date:
          type: string
          format: date
          description: Date on which that action was taken
          example: '2020-05-25'
        requiresMFA:
          type: boolean
          description: Shows if MFA is enabled for an account.
          example: false
        ssoRegistrationName:
          type: string
          description: Third-party IDP client registration name
          example: bestcompany
        ssoRegistrationType:
          type: string
          description: Third-party IDP client registration type
          enum:
            - OAUTH2
            - SAML2
          example: OAUTH2
      title: Password information (if an email was indeed registered)
    PatientDto:
      type: object
      properties:
        personId:
          type: integer
          format: int32
          description: >-
            Unique user ID (should only be specified when existing the person is
            being edited)
          example: 123
        policyId:
          type: integer
          format: int32
          description: >-
            Policy ID reference (should not be specified for a person passed
            within the policy's list)
          example: 456
        firstName:
          type: string
          description: Person's first name
          example: John
        lastName:
          type: string
          description: Person's last name
          example: Smith
        firstNameLatin:
          type: string
          description: Person's first name in Latin letters
          example: John
        lastNameLatin:
          type: string
          description: Person's last name in Latin letters
          example: Smith
        gender:
          type: string
          description: Person's gender
          enum:
            - MALE
            - FEMALE
            - BOTH
            - OTHER
          example: MALE
        birthday:
          type: string
          format: date
          description: Person's date of birth
          example: '1980-04-20'
        personalIdNumber:
          type: string
          description: >-
            Person's government ID number (usually either an identity card
            number or a passport number)
          example: 30123456789
        status:
          type: string
          description: >-
            Status of the person within the policy (set to CANCELLED to revoke
            person's rights under the policy)
          enum:
            - ACTIVE
            - CANCELLED
          example: ACTIVE
        liabilityLimit:
          type: number
          format: double
          default: '1000000000'
          description: >-
            Maximum liability provided by the insurance (to zero-out liability,
            set to a negative value)
          example: 200000
        excessPercentage:
          type: number
          format: double
          description: >-
            Excess (deductible) to be charged for a visit (basic fee percentage;
            to remove excess, set to a negative value)
          example: 0.2
        excessFee:
          type: number
          format: double
          description: >-
            Excess (deductible) to be charged for a visit (fixed part; to remove
            excess, set to a negative value)
          example: 50
        packageType:
          type: integer
          format: int32
          description: The package type of person
        subscriberId:
          type: integer
          format: int32
          description: User ID (this field has a legacy-based name)
          example: 1234
        companyId:
          type: integer
          format: int32
          description: ID of an insurance company or zero, if uninsured
          example: 1
        startDate:
          type: string
          format: date
          description: Start date of the insurance policy
          example: '2019-05-19'
        endDate:
          type: string
          format: date
          description: End date of the insurance policy
          example: '2019-08-25'
        policyNumber:
          type: string
          description: The insurance policy number
          example: 468239748923321
      title: Appointment patient record
    PermissionDto:
      type: object
      properties:
        countries:
          type: array
          items:
            type: string
            enum:
              - AD
              - AE
              - AF
              - AG
              - AI
              - AL
              - AM
              - AO
              - AR
              - AS
              - AT
              - AU
              - AW
              - AX
              - AZ
              - BA
              - BB
              - BD
              - BE
              - BF
              - BG
              - BH
              - BI
              - BJ
              - BL
              - BM
              - BN
              - BO
              - BQ
              - BR
              - BS
              - BT
              - BV
              - BW
              - BY
              - BZ
              - CA
              - CC
              - CD
              - CF
              - CG
              - CH
              - CI
              - CK
              - CL
              - CM
              - CN
              - CO
              - CR
              - CU
              - CV
              - CW
              - CX
              - CY
              - CZ
              - DE
              - DJ
              - DK
              - DM
              - DO
              - DZ
              - EC
              - EE
              - EG
              - EH
              - ER
              - ES
              - ET
              - FI
              - FJ
              - FK
              - FM
              - FO
              - FR
              - GA
              - GB
              - GD
              - GE
              - GF
              - GG
              - GH
              - GI
              - GL
              - GM
              - GN
              - GP
              - GQ
              - GR
              - GS
              - GT
              - GU
              - GW
              - GY
              - HK
              - HN
              - HR
              - HT
              - HU
              - ID
              - IE
              - IL
              - IM
              - IN
              - IO
              - IQ
              - IR
              - IS
              - IT
              - JE
              - JM
              - JO
              - JP
              - KE
              - KG
              - KH
              - KI
              - KM
              - KN
              - KP
              - KR
              - KW
              - KY
              - KZ
              - LA
              - LB
              - LC
              - LI
              - LK
              - LR
              - LS
              - LT
              - LU
              - LV
              - LY
              - MA
              - MC
              - MD
              - ME
              - MF
              - MG
              - MH
              - MK
              - ML
              - MM
              - MN
              - MO
              - MQ
              - MR
              - MS
              - MT
              - MU
              - MV
              - MW
              - MX
              - MY
              - MZ
              - NA
              - NC
              - NE
              - NF
              - NG
              - NI
              - NL
              - 'NO'
              - NP
              - NR
              - NU
              - NZ
              - OM
              - PA
              - PE
              - PF
              - PG
              - PH
              - PK
              - PL
              - PM
              - PN
              - PR
              - PS
              - PT
              - PW
              - PY
              - QA
              - RE
              - RO
              - RS
              - RU
              - RW
              - SA
              - SB
              - SC
              - SD
              - SE
              - SG
              - SH
              - SI
              - SJ
              - SK
              - SL
              - SM
              - SN
              - SO
              - SR
              - SS
              - ST
              - SV
              - SX
              - SY
              - SZ
              - TC
              - TD
              - TF
              - TG
              - TH
              - TJ
              - TK
              - TL
              - TM
              - TN
              - TO
              - TR
              - TT
              - TV
              - TW
              - TZ
              - UA
              - UG
              - UM
              - US
              - UY
              - UZ
              - VA
              - VC
              - VE
              - VG
              - VI
              - VN
              - VU
              - WF
              - WS
              - YE
              - YT
              - ZA
              - ZM
              - ZW
              - XK
        companyId:
          type: integer
          format: int32
        recruitmentStatusEnum:
          type: string
          enum:
            - ACCEPTS_ONLY_LOCALS
            - FULLY_BOOKED
            - NOT_RELEVANT
            - NOT_INTERESTED
            - REPRESENTATIVE_NOT_COOPERATING
            - DO_NOT_ACCEPT_PAYMENT_FROM_LONG_DISTANCE
            - SENT_MESSAGE_VIA_FACEBOOK
            - SENT_EMAIL_WITH_GENERAL_EXPLANATION
            - LANGUAGE_BARRIER
            - NO_RESPONSE
            - FOLLOW_UP_AFTER_CORONAVIRUS_SITUATION
            - SENT_MESSAGE_VIA_WHATSAPP
            - SENT_MESSAGE_VIA_LINKEDIN
            - INTERESTED_EMAIL_SENT_FOR_MISSING_DATA
            - RECRUITED_FOLLOW_UP_NEEDED
            - RECRUITED_MISSING_DETAILS
            - READY_FOR_UPLOAD
        grantEnum:
          type: string
          enum:
            - ADMIN
            - OPERATION_ADMIN
            - TRANSLATOR
            - TRANSLATOR_ADMIN
            - INSURER_ADMIN
            - QUERY_POLICY
            - CREATE_POLICY
            - MODIFY_POLICY
            - DATA_ENTRY_ACCESS
            - REPORTING_AGENT
            - POLICY_USE_HISTORY
            - PRODUCT
            - BILLING
            - FINANCE
            - BPO
            - BPO_PHILIPPINES
            - PROMO_CODE_ADMIN
            - AFFILIATE_ADMIN
            - ALLOW_DUMMY_APPOINTMENT
            - PARTNER_CUSTOMIZATION_ADMIN
      title: Permission record; represents user grant with all dependencies
    PersonDto:
      type: object
      description: >-
        Almost all the fields are optional; on update any missing field will not
        be left as is
      properties:
        personId:
          type: integer
          format: int32
          description: >-
            Unique user ID (should only be specified when existing the person is
            being edited)
          example: 123
        policyId:
          type: integer
          format: int32
          description: >-
            Policy ID reference (should not be specified for a person passed
            within the policy's list)
          example: 456
        firstName:
          type: string
          description: Person's first name
          example: John
        lastName:
          type: string
          description: Person's last name
          example: Smith
        firstNameLatin:
          type: string
          description: Person's first name in Latin letters
          example: John
        lastNameLatin:
          type: string
          description: Person's last name in Latin letters
          example: Smith
        gender:
          type: string
          description: Person's gender
          enum:
            - MALE
            - FEMALE
            - BOTH
            - OTHER
          example: MALE
        birthday:
          type: string
          format: date
          description: Person's date of birth
          example: '1980-04-20'
        personalIdNumber:
          type: string
          description: >-
            Person's government ID number (usually either an identity card
            number or a passport number)
          example: 30123456789
        status:
          type: string
          description: >-
            Status of the person within the policy (set to CANCELLED to revoke
            person's rights under the policy)
          enum:
            - ACTIVE
            - CANCELLED
          example: ACTIVE
        liabilityLimit:
          type: number
          format: double
          default: '1000000000'
          description: >-
            Maximum liability provided by the insurance (to zero-out liability,
            set to a negative value)
          example: 200000
        excessPercentage:
          type: number
          format: double
          description: >-
            Excess (deductible) to be charged for a visit (basic fee percentage;
            to remove excess, set to a negative value)
          example: 0.2
        excessFee:
          type: number
          format: double
          description: >-
            Excess (deductible) to be charged for a visit (fixed part; to remove
            excess, set to a negative value)
          example: 50
        packageType:
          type: integer
          format: int32
          description: The package type of person
      title: >-
        Person record (either an insured individual or one for whom an
        appointment was created)
    PhotoDto:
      type: object
      properties:
        id:
          type: integer
          format: int32
          description: Unique photo ID (leave blank when creating a photo)
          example: 1234
        path:
          type: string
          description: Server path of the previously uploaded file (GET only)
          example: 39d80a47f12c985f72c13f8e91a74.png
        base64Data:
          type: string
          description: Base-64 encoded content of the file (POST only)
          example: 4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923
        name:
          type: string
          description: Original name of the file
          example: photo.png
        timestampUploaded:
          type: string
          format: date
          default: today
          description: Date of the file upload
          example: '2020-04-29'
        timestampExpire:
          type: string
          format: date
          description: Expected date of the file expiration, if any
          example: '2021-12-31'
        comments:
          type: string
          description: Any file-specific comments
          example: Photo explaining the issue
        fileTypeEnum:
          type: string
          description: Type of the attachment
          enum:
            - CV
            - LICENSE
            - AGREEMENT
            - DIPLOMA
            - PRICE_LIST
            - REGULATIONS
            - INVOICE_CHARGE_INSURANCE
            - INVOICE_DOCTOR_PAYMENT
            - INVOICE_STATUS
            - CLINIC_PHOTO
            - PROFILE_PHOTO
            - CLINIC_LOGO_PHOTO
            - PROBLEM_DESCRIPTION_PHOTO
            - CLAIM_PHOTO
            - EVENT_ATTACHMENT
            - OTHER
            - CONFIRMATION_OF_WITHHOLDING_TAX
            - GUARANTEE_OF_PAYMENT
            - COMMISSION_CHANGE_REASON
            - LIGHT_BACKGROUND_LOGO
            - DARK_BACKGROUND_LOGO
            - LIGHT_BACKGROUND_INTERNAL_LOGO
            - DARK_BACKGROUND_INTERNAL_LOGO
            - SQUARE_LOGO
          example: PROBLEM_DESCRIPTION_PHOTO
        fileSize:
          type: integer
          format: int32
          description: Previously uploaded file size (GET only)
          example: 647823
      title: >-
        Record holding a single file attachment (usually a photo or a document
        scan, but different types of files can be uploaded)
    PriceLimitDto:
      type: object
      properties:
        country:
          type: string
          description: Country of the price limit
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
        visitType:
          type: string
          description: Visit type of the price limit
          enum:
            - HOME_VISIT
            - CLINIC_VISIT
            - VIDEO_VISIT
        specialty:
          type: string
          description: Specialty of the price limit
          enum:
            - GENERAL
            - DENTIST
            - ORTHOPEDIST
            - PEDIATRICIAN
            - GYNECOLOGIST
            - PULMONOLOGIST
            - GASTROENTEROLOGIST
            - OPHTALMOLOGIST
            - DERMATOLOGIST
            - NEUROLOGIST
            - ENT
            - PSYCHIATRIST
            - CARDIOLOGIST
            - UROLOGIST
            - ALTERNATIVE
            - OTHER
            - EMERGENCY
            - MORE
            - MASSEUSE
            - ONCOLOGIST
            - SURGEON
            - INTERNIST
            - HEMATOLOGIST
            - NEPHROLOGIST
            - RHEUMATOLOGIST
            - GERIATRICIAN
            - ALLERGOLOGIST
            - ONLINE_DOCTOR
            - IMAGING
            - LABS
        packageId:
          type: integer
          format: int32
          description: Package of the price limit
        priceLimit:
          type: number
          format: double
          description: >-
            Price limit depending on country, visit type and specialty, covered
            by insurance
        guaranteeOfPaymentCap:
          type: number
          format: double
          description: Price limit for guarantee of payment, covered by insurance
        priceLimitCurrency:
          type: string
          description: Currency of the price limit
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
        insurerInvoiceType:
          type: string
          description: Invoice type for insurer
          enum:
            - REGULAR
            - COMBINE_SUM
            - COMBINE_SPLIT
      title: Record defining price limit and currency covered by insurance
    ProfileAdministeredDto:
      type: object
      properties:
        profileId:
          type: integer
          format: int32
        disabledUntil:
          type: string
          format: date-time
        disabledByAdmin:
          type: boolean
        friendlyType:
          type: string
          enum:
            - NOT_FRIENDLY
            - APP_FRIENDLY
            - TRUSTED_TO_CLOSE
    ProfileDto:
      type: object
      properties:
        profileId:
          type: integer
          format: int32
          description: The unique profile ID
          example: 1234
        ownerId:
          type: integer
          format: int32
          description: ID of the company, owning the profile data
          example: 1
        prefix:
          type: string
          description: The profile prefix or clinic designation
          enum:
            - DR
            - PROF
            - CLINIC
            - NONE
          example: DR
        pseudonym:
          type: string
          description: Doctor's pseudonym or clinic's short name
          example: Dr. John S.
        gender:
          type: string
          description: Gender of a doctor
          enum:
            - MALE
            - FEMALE
            - BOTH
            - OTHER
          example: MALE
        photo:
          type: string
          description: Main picture of the profile
        name:
          type: string
          description: >-
            Clinic name or doctor's first name (this data is privileged; if the
            user had no approved appointment with this profile, this field will
            be blank)
          example: John
        lastName:
          type: string
          description: >-
            Doctor's last name (this data is privileged; if the user had no
            approved appointment with this profile, this field will be blank)
          example: Smith
        disabled:
          type: boolean
          description: True, if this profile is temporarily or permanently disabled
        showToB2C:
          type: boolean
          description: False, if the profile should not be presented to B2C users
        showToB2B2C:
          type: boolean
          description: False, if the profile should not be presented to B2B2C users
        paymentSource:
          type: string
          description: Who settles the profile's bill at the end of the visit
          enum:
            - AIR_DOCTOR
            - PATIENT_DIRECT
            - OWNER
          example: AIR_DOCTOR
        country:
          type: string
          description: The country the profile is located in
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
          example: US
        currency:
          type: string
          description: Currency for the appointments with this profile
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
          example: USD
        deltaTime:
          type: integer
          format: int32
          description: >-
            Delta time in minutes between the user's local time and the current
            profile's local time
          example: -300
        specialty:
          type: array
          description: List of specialties this profile caters
          items:
            type: string
            enum:
              - GENERAL
              - DENTIST
              - ORTHOPEDIST
              - PEDIATRICIAN
              - GYNECOLOGIST
              - PULMONOLOGIST
              - GASTROENTEROLOGIST
              - OPHTALMOLOGIST
              - DERMATOLOGIST
              - NEUROLOGIST
              - ENT
              - PSYCHIATRIST
              - CARDIOLOGIST
              - UROLOGIST
              - ALTERNATIVE
              - OTHER
              - EMERGENCY
              - MORE
              - MASSEUSE
              - ONCOLOGIST
              - SURGEON
              - INTERNIST
              - HEMATOLOGIST
              - NEPHROLOGIST
              - RHEUMATOLOGIST
              - GERIATRICIAN
              - ALLERGOLOGIST
              - ONLINE_DOCTOR
              - IMAGING
              - LABS
        subSpecialities:
          type: array
          description: More detailed list of applicable sub-specialities
          items:
            type: string
            enum:
              - ACUPUNCTURE
              - AYURVEDA
              - HOMEOPATHY
              - NATUROPATHY
              - CHINESE_OR_ORIENTAL_MEDICINE
              - GENERAL_CLINICAL_CARDIOLOGIST
              - CARDIOTHORACIC_SURGEON
              - ECHOCARDIOLOGIST
              - ELECTROPHYSIOLOGIST
              - INTERVENTIONAL_CARDIOLOGY_CARDIOLOGIST
              - ELECTROPHYSIOLOGY
              - ADVANCED_HEART_FAILURE_AND_TRANSPLANTATION
              - ADULT_CONGENITAL_CARDIOLOGIST
              - NUCLEAR_CARDIOLOGIST
              - HEART_FAILURE_AND_TRANSPLANT_CARDIOLOGIST
              - COMPUTED_TOMOGRAPHY_MAGNETIC_RESONANCE_IMAGING_CARDIOLOGIST
              - ENDODONTIST
              - ORAL_AND_MAXILLOFACIAL_SURGEON
              - ORTHODONTIST_ALIGNMENT_SPECIALIST
              - PEDIATRIC_DENTIST
              - PERIODONTIST_GUM_SPECIALIST
              - PROSTHODONTIST_REPLACEMENT_SPECIALIST
              - DERMATOPATHOLOGY
              - EPIDERMOLYSIS_BULLOSA_CLINIC
              - LASER
              - MOHS_SURGERY
              - PEDIATRIC_DERMATOLOGY
              - PHOTOTHERAPY
              - CONTACT_DERMATITIS
              - VITILIGO_ALOPECIA_AREATA
              - PIGMENTED_LESION_AND_MELANOMA
              - AUTOIMMUNE_SKIN_DISEASE
              - SKIN_CANCER_GENETICS
              - HIGH_RISK_NONMELANOMA_SKIN_CANCER
              - NAIL_DISORDERS
              - HAIR_LOSS
              - GENITAL_DERMATOLOGY
              - ADVANCED_BASAL_CELL_CARCINOMA
              - SKIN_ALLERGIES_AND_CONTACT_DERMATITIS
              - PALLIATIVE_MEDICINE
              - CRITICAL_CARE_MEDICINE_EMERGENCY
              - MEDICAL_TOXICOLOGY_EMERGENCY
              - PEDIATRIC_EMERGENCY_MEDICINE
              - SPORTS_MEDICINE_EMERGENCY
              - EMERGENCY_MEDICAL_SERVICES
              - UNDERSEA_AND_HYPERBARIC_MEDICINE
              - ALLERGIES
              - FACIAL_SURGERY
              - HEAD_AND_NECK
              - THROAT
              - EAR
              - PEDIATRIC_CONDITIONS
              - COSMETIC_SURGERY
              - LARYNGOLOGY
              - OTOLOGY_AND_NEUROTOLOGY
              - INFLAMMATORY_BOWEL_DISEASE
              - TROPICAL_DISEASES
              - GASTROINTESTINAL_CANCER_AND_ITS_PREVENTION
              - ENDOSCOPIC_SURVEILLANCE
              - REFLUX_OESOPHAGITIS
              - HEPATOLOGY
              - PANCREATIC_DISEASE
              - TRANSPLANTATION
              - MEDICOLEGAL_ISSUES_IN_MEDICINE
              - CLINICAL_PHARMACOLOGY
              - INHERITED_CANCER_SYNDROMES
              - ADOLESCENT_MEDICINE_GENERAL
              - CLINICAL_INFORMATICS
              - EMERGENCY_MEDICINE
              - GERIATRIC_MEDICINE_GENERAL
              - HIV_AIDS
              - HOSPICE_AND_PALLIATIVE_MEDICINE_GENERAL
              - MATERNAL_FETAL_MEDICINE
              - REPRODUCTIVE_ENDOCRINOLOGY
              - GYNECOLOGIC_ONCOLOGY_GYNECOLOGIST
              - UROGYNECOLOGY
              - EPILEPSY_NEURO_DIAGNOSTICS
              - HEADACHE_PAIN_MEDICINE
              - MOVEMENT_DISORDERS
              - NEURO_BEHAVIOR_MEMORY_DISORDERS
              - NEURO_IMMUNOLOGY_MS
              - NEURO_INFECTIOUS_DISEASE
              - NEURO_MUSCULAR
              - NEURO_ONCOLOGY_NEUROLOGIST
              - NEURO_OPHTHALMOLOGY_NEUROLOGIST
              - NEURO_VASCULAR_STROKE
              - SPORTS_MEDICINE_ORTHOPEDIST
              - HAND_AND_ARM
              - PEDIATRIC_ORTHOPEDICS
              - SPINE_SURGERY
              - FOOT_AND_ANKLE_ORTHOPEDICS_PODIATRY
              - JOINT_REPLACEMENT
              - TRAUMA_SURGERY
              - HIP_AND_KNEE_REPLACEMENT
              - SHOULDER_AND_ELBOW
              - ORTHOPAEDIC_ONCOLOGY
              - MUSCULOSKELETALTUMORS
              - ANTERIOR_SEGMENT_SURGERY
              - CATARACTS_AND_REFRACTIVE_SURGERY
              - CORNEA_AND_EXTERNAL_DISEASE
              - GLAUCOMA
              - NEURO_OPHTHALMOLOGY_OPHTALMOLOGIST
              - OCULAR_ONCOLOGY
              - OCULOPLASTICS_AND_ORBIT_SURGERY
              - OPHTHALMIC_PATHOLOGY
              - PEDIATRICS
              - UVEITIS_AND_IMMUNOLOGY
              - VITREORETINAL_SURGERY
              - PEDIATRIC_RHEUMATOLOGY
              - PEDIATRIC_PULMONOLOGY
              - PEDIATRIC_NEPHROLOGY
              - PEDIATRIC_INFECTIOUS_DISEASES
              - PEDIATRIC_HEMATOLOGYONCOLOGY
              - PEDIATRIC_GASTROENTEROLOGY
              - PEDIATRIC_ENDOCRINOLOGY
              - PEDIATRIC_EMERGENCY_MEDICINE_PEDIATRICIAN
              - DEVELOPMENTAL_BEHAVIORAL_PEDIATRICS
              - PEDIATRIC_CRITICAL_CARE_MEDICINE
              - PEDIATRIC_CARDIOLOGY
              - ADOLESCENT_MEDICINE_PEDIATRICIAN
              - MEDICAL_TOXICOLOGY_PEDIATRICIAN
              - SLEEP_MEDICINE_PEDIATRICIAN
              - SPORTS_MEDICINE_PEDIATRICIAN
              - PEDIATRIC_TRANSPLANT_HEPATOLOGY
              - GENERAL_ADULT_PSYCHIATRY
              - SOCIAL_AND_COMMUNITY_PSYCHIATRY
              - OLD_AGE_PSYCHIATRY
              - CHILD_AND_ADOLESCENT_PSYCHIATRY
              - LIAISON_PSYCHIATRY
              - FORENSIC_PSYCHIATRY
              - LEARNING_DISABILITY
              - PSYCHOTHERAPY
              - RADIATION_ONCOLOGY
              - SURGICAL_ONCOLOGY
              - MEDICAL_ONCOLOGY
              - INTERVENTIONAL_ONCOLOGY
              - GYNECOLOGIC_ONCOLOGY
              - PEDIATRIC_ONCOLOGY
              - NEURO_ONCOLOGY
              - HEMATO_ONCOLOGY
              - URO_ONCOLOGY
              - CARDIOTHORACIC_SURGERY
              - GENERAL_SURGERY
              - NEUROSURGERY
              - ORAL_AND_MAXILLOFACIAL_SURGERY
              - OTOLARYNGOLOGY_SURGERY
              - PAEDIATRIC_SURGERY
              - PLASTIC_SURGERY
              - TRAUMA_AND_ORTHOPAEDIC_SURGERY
              - UROLOGY_SURGERY
              - VASCULAR_SURGERY
              - CARDIOVASCULAR_DISEASE
              - ADULT_CONGENITAL_HEART_DISEASE
              - CARDIAC_ELECTROPHYSIOLOGY
              - HEART_FAILURE_AND_TRANSPLANT_CARDIOLOGY
              - INTERVENTIONAL_CARDIOLOGY_INTERNAL
              - ENDOCRINOLOGY_DIABETES_AND_METABOLISM
              - GASTROENTEROLOGY
              - TRANSPLANT_HEPATOLOGY
              - HEMATOLOGY_BLOOD
              - INFECTIOUS_DISEASE
              - NEPHROLOGY
              - ONCOLOGY
              - PULMONARY_DISEASE
              - RHEUMATOLOGY
              - ADOLESCENT_MEDICINE_INTERNAL
              - ALLERGY_AND_IMMUNOLOGY
              - CRITICAL_CARE_MEDICINE_INTERNAL
              - GERIATRIC_MEDICINE_INTERNAL
              - NEUROCRITICAL_CARE
              - SLEEP_MEDICINE_INTERNAL
              - SPORTS_MEDICINE_INTERNAL
              - RHINOLOGY
              - SLEEP_MEDICINE
              - ENDO_UROLOGY
              - ONCOLOGICAL_UROLOGY
              - NEURO_UROLOGY
              - PREDIATRIC_UROLOGIST
              - ANDROLOGY
              - RECONSTRUCTIVE_UROLOGY
              - UROGYNECOLOGY_UROLOGIST
              - GASTROENTEROLOGIST_PEDIATRIC_GASTROENTEROLOGY
              - NEUROGASTROENTEROLOGY
              - ORTHOPEDIC_SURGERY
              - ONCOLOGICAL_SURGERY
              - ENDOCRINE_SURGERY
              - COLORECTAL_SURGERY
              - NEUROLOGIST_NEUROSURGERY
              - PRIATRIC_NEUROLOGY
              - NEUROLOGIST_SLEEP_MEDICINE
              - CARDIOLOGIST_PEDIATRIC_CARDIOLOGY
              - PAIN_MEDICINE
              - PEDIATRIC_OTOLARYNGOLOGY
              - PEDIATRIC_UROLOGIST
              - PEDIATRICIAN_PEDIATRIC_ORTHOPEDICS
              - PEDIATRIC_SURGERY
              - PEDIATRIC_NEUROLOGY
              - PEDIATRICIAN_PEDIATRIC_DERMATOLOGY
              - CT
              - MRI
              - THYROID_AND_PARATHYROID_SURGERY
              - MILITARY_INVASIVE_SURGERY
              - BARIATRIC_SURGERY
              - ORGAN_TRANSPLANT
              - LAPAROSCOPIC_SURGERY
              - GASTROINTESTINAL_SURGERY
              - PEDIATRIC_ALLERGY_AND_IMMUNOLOGY
              - EATING_DISORDER
              - GASTROINTESTINAL_ONCOLOGY
              - HIGH_RISK_PREGNANCY
              - CERVIX
              - FERTILITY_TREATMENTS
              - IVF
              - ULTRASOUND
              - MINIMALLY_INVASIVE_GYNECOLOGIC_SURGERY
              - CATARACTS_SURGERY
              - STRABISMUS
              - RETINA
              - SHOULDER
              - ELBOW
              - HIP
              - KNEE
              - FOOT
              - ANKLE
              - PALM
              - ARM
              - ARTHROSCOPY_SURGERY
              - MRI_LAB
              - BLOOD_TEST
              - X_RAY
              - VACCINATION
              - ULTRASOUND_LAB
              - CT_LAB
              - URINE
              - THROAT_SURFACE
              - STD
              - HIV
              - PCR
        specialSkills:
          type: string
          description: Any special skills, which can be included in profile description
          example: Also a sergeon
        languages:
          type: array
          description: List languages the doctor speaks or are understood within the clinic
          items:
            type: string
            enum:
              - AA
              - AB
              - AE
              - AF
              - AK
              - AM
              - AN
              - AR
              - AS
              - AV
              - AY
              - AZ
              - BA
              - BE
              - BG
              - BH
              - BI
              - BM
              - BN
              - BO
              - BR
              - BS
              - CA
              - CE
              - CH
              - CO
              - CR
              - CS
              - CU
              - CV
              - CY
              - DA
              - DE
              - DV
              - DZ
              - EE
              - EL
              - EN
              - EO
              - ES
              - ET
              - EU
              - FA
              - FF
              - FI
              - FJ
              - FO
              - FR
              - FY
              - GA
              - GD
              - GL
              - GN
              - GU
              - GV
              - HA
              - HE
              - HI
              - HO
              - HR
              - HT
              - HU
              - HY
              - HZ
              - IA
              - ID
              - IE
              - IG
              - II
              - IK
              - IO
              - IS
              - IT
              - IU
              - JA
              - JV
              - KA
              - KG
              - KI
              - KJ
              - KK
              - KL
              - KM
              - KN
              - KO
              - KR
              - KS
              - KU
              - KV
              - KW
              - KY
              - LA
              - LB
              - LG
              - LI
              - LN
              - LO
              - LT
              - LU
              - LV
              - MG
              - MH
              - MI
              - MK
              - ML
              - MN
              - MR
              - MS
              - MT
              - MY
              - NA
              - NB
              - ND
              - NE
              - NG
              - NL
              - NN
              - 'NO'
              - NR
              - NV
              - NY
              - OC
              - OJ
              - OM
              - OR
              - OS
              - PA
              - PI
              - PL
              - PS
              - PT
              - QU
              - RM
              - RN
              - RO
              - RU
              - RW
              - SA
              - SC
              - SD
              - SE
              - SG
              - SI
              - SK
              - SL
              - SM
              - SN
              - SO
              - SQ
              - SR
              - SS
              - ST
              - SU
              - SV
              - SW
              - TA
              - TE
              - TG
              - TH
              - TI
              - TK
              - TL
              - TN
              - TO
              - TR
              - TS
              - TT
              - TW
              - TY
              - UG
              - UK
              - UR
              - UZ
              - VE
              - VI
              - VO
              - WA
              - WO
              - XH
              - YI
              - YO
              - ZA
              - ZH
              - YUE
              - ZU
        prescriptionStates:
          type: array
          description: List of states where the doctor can prescribe
          items:
            type: string
            enum:
              - US_AL
              - US_AK
              - US_AZ
              - US_AR
              - US_CA
              - US_CO
              - US_CT
              - US_DE
              - US_DC
              - US_FL
              - US_GA
              - US_HI
              - US_ID
              - US_IL
              - US_IN
              - US_IA
              - US_KS
              - US_KY
              - US_LA
              - US_ME
              - US_MD
              - US_MA
              - US_MI
              - US_MN
              - US_MS
              - US_MO
              - US_MT
              - US_NE
              - US_NV
              - US_NH
              - US_NJ
              - US_NM
              - US_NY
              - US_NC
              - US_ND
              - US_OH
              - US_OK
              - US_OR
              - US_PA
              - US_RI
              - US_SC
              - US_SD
              - US_TN
              - US_TX
              - US_UT
              - US_VT
              - US_VA
              - US_WA
              - US_WV
              - US_WI
              - US_WY
              - DE_BW
              - DE_BY
              - DE_BE
              - DE_BB
              - DE_HB
              - DE_HH
              - DE_HE
              - DE_MV
              - DE_NI
              - DE_NW
              - DE_RP
              - DE_SL
              - DE_SN
              - DE_ST
              - DE_SH
              - DE_TH
              - CA_AB
              - CA_BC
              - CA_MB
              - CA_NB
              - CA_NL
              - CA_NT
              - CA_NS
              - CA_NU
              - CA_ON
              - CA_PE
              - CA_QC
              - CA_SK
              - CA_YT
              - IN_AN
              - IN_AP
              - IN_AR
              - IN_AS
              - IN_BR
              - IN_CH
              - IN_CG
              - IN_DH
              - IN_DL
              - IN_GA
              - IN_GJ
              - IN_HR
              - IN_HP
              - IN_JK
              - IN_JH
              - IN_KA
              - IN_KL
              - IN_LA
              - IN_LD
              - IN_MP
              - IN_MH
              - IN_MN
              - IN_ML
              - IN_MZ
              - IN_NL
              - IN_OD
              - IN_PY
              - IN_PB
              - IN_RJ
              - IN_SK
              - IN_TN
              - IN_TS
              - IN_TR
              - IN_UP
              - IN_UK
              - IN_WB
              - AU_NSW
              - AU_QLD
              - AU_SA
              - AU_TAS
              - AU_VIC
              - AU_WA
              - AU_ACT
              - AU_NT
              - CH_ZH
              - CH_BE
              - CH_LU
              - CH_UR
              - CH_SZ
              - CH_OW
              - CH_NW
              - CH_GL
              - CH_ZG
              - CH_FR
              - CH_SO
              - CH_BS
              - CH_BL
              - CH_SH
              - CH_AR
              - CH_AI
              - CH_SG
              - CH_GR
              - CH_AG
              - CH_TG
              - CH_TI
              - CH_VD
              - CH_VS
              - CH_NE
              - CH_GE
              - CH_JU
              - BR_AC
              - BR_AL
              - BR_AM
              - BR_AP
              - BR_BA
              - BR_CE
              - BR_DF
              - BR_ES
              - BR_GO
              - BR_MA
              - BR_MG
              - BR_MS
              - BR_MT
              - BR_PA
              - BR_PB
              - BR_PE
              - BR_PI
              - BR_PR
              - BR_RJ
              - BR_RN
              - BR_RO
              - BR_RR
              - BR_RS
              - BR_SC
              - BR_SE
              - BR_SP
              - BR_TO
        prescriptionCountriesByMatrix:
          type: array
          description: List of countries where the doctor can prescribe by matrix
          items:
            type: string
            enum:
              - AD
              - AE
              - AF
              - AG
              - AI
              - AL
              - AM
              - AO
              - AR
              - AS
              - AT
              - AU
              - AW
              - AX
              - AZ
              - BA
              - BB
              - BD
              - BE
              - BF
              - BG
              - BH
              - BI
              - BJ
              - BL
              - BM
              - BN
              - BO
              - BQ
              - BR
              - BS
              - BT
              - BV
              - BW
              - BY
              - BZ
              - CA
              - CC
              - CD
              - CF
              - CG
              - CH
              - CI
              - CK
              - CL
              - CM
              - CN
              - CO
              - CR
              - CU
              - CV
              - CW
              - CX
              - CY
              - CZ
              - DE
              - DJ
              - DK
              - DM
              - DO
              - DZ
              - EC
              - EE
              - EG
              - EH
              - ER
              - ES
              - ET
              - FI
              - FJ
              - FK
              - FM
              - FO
              - FR
              - GA
              - GB
              - GD
              - GE
              - GF
              - GG
              - GH
              - GI
              - GL
              - GM
              - GN
              - GP
              - GQ
              - GR
              - GS
              - GT
              - GU
              - GW
              - GY
              - HK
              - HN
              - HR
              - HT
              - HU
              - ID
              - IE
              - IL
              - IM
              - IN
              - IO
              - IQ
              - IR
              - IS
              - IT
              - JE
              - JM
              - JO
              - JP
              - KE
              - KG
              - KH
              - KI
              - KM
              - KN
              - KP
              - KR
              - KW
              - KY
              - KZ
              - LA
              - LB
              - LC
              - LI
              - LK
              - LR
              - LS
              - LT
              - LU
              - LV
              - LY
              - MA
              - MC
              - MD
              - ME
              - MF
              - MG
              - MH
              - MK
              - ML
              - MM
              - MN
              - MO
              - MQ
              - MR
              - MS
              - MT
              - MU
              - MV
              - MW
              - MX
              - MY
              - MZ
              - NA
              - NC
              - NE
              - NF
              - NG
              - NI
              - NL
              - 'NO'
              - NP
              - NR
              - NU
              - NZ
              - OM
              - PA
              - PE
              - PF
              - PG
              - PH
              - PK
              - PL
              - PM
              - PN
              - PR
              - PS
              - PT
              - PW
              - PY
              - QA
              - RE
              - RO
              - RS
              - RU
              - RW
              - SA
              - SB
              - SC
              - SD
              - SE
              - SG
              - SH
              - SI
              - SJ
              - SK
              - SL
              - SM
              - SN
              - SO
              - SR
              - SS
              - ST
              - SV
              - SX
              - SY
              - SZ
              - TC
              - TD
              - TF
              - TG
              - TH
              - TJ
              - TK
              - TL
              - TM
              - TN
              - TO
              - TR
              - TT
              - TV
              - TW
              - TZ
              - UA
              - UG
              - UM
              - US
              - UY
              - UZ
              - VA
              - VC
              - VE
              - VG
              - VI
              - VN
              - VU
              - WF
              - WS
              - YE
              - YT
              - ZA
              - ZM
              - ZW
              - XK
        prescriptionCountriesByDataEntry:
          type: array
          description: List of countries where the doctor can prescribe by Data Entry
          items:
            type: string
            enum:
              - AD
              - AE
              - AF
              - AG
              - AI
              - AL
              - AM
              - AO
              - AR
              - AS
              - AT
              - AU
              - AW
              - AX
              - AZ
              - BA
              - BB
              - BD
              - BE
              - BF
              - BG
              - BH
              - BI
              - BJ
              - BL
              - BM
              - BN
              - BO
              - BQ
              - BR
              - BS
              - BT
              - BV
              - BW
              - BY
              - BZ
              - CA
              - CC
              - CD
              - CF
              - CG
              - CH
              - CI
              - CK
              - CL
              - CM
              - CN
              - CO
              - CR
              - CU
              - CV
              - CW
              - CX
              - CY
              - CZ
              - DE
              - DJ
              - DK
              - DM
              - DO
              - DZ
              - EC
              - EE
              - EG
              - EH
              - ER
              - ES
              - ET
              - FI
              - FJ
              - FK
              - FM
              - FO
              - FR
              - GA
              - GB
              - GD
              - GE
              - GF
              - GG
              - GH
              - GI
              - GL
              - GM
              - GN
              - GP
              - GQ
              - GR
              - GS
              - GT
              - GU
              - GW
              - GY
              - HK
              - HN
              - HR
              - HT
              - HU
              - ID
              - IE
              - IL
              - IM
              - IN
              - IO
              - IQ
              - IR
              - IS
              - IT
              - JE
              - JM
              - JO
              - JP
              - KE
              - KG
              - KH
              - KI
              - KM
              - KN
              - KP
              - KR
              - KW
              - KY
              - KZ
              - LA
              - LB
              - LC
              - LI
              - LK
              - LR
              - LS
              - LT
              - LU
              - LV
              - LY
              - MA
              - MC
              - MD
              - ME
              - MF
              - MG
              - MH
              - MK
              - ML
              - MM
              - MN
              - MO
              - MQ
              - MR
              - MS
              - MT
              - MU
              - MV
              - MW
              - MX
              - MY
              - MZ
              - NA
              - NC
              - NE
              - NF
              - NG
              - NI
              - NL
              - 'NO'
              - NP
              - NR
              - NU
              - NZ
              - OM
              - PA
              - PE
              - PF
              - PG
              - PH
              - PK
              - PL
              - PM
              - PN
              - PR
              - PS
              - PT
              - PW
              - PY
              - QA
              - RE
              - RO
              - RS
              - RU
              - RW
              - SA
              - SB
              - SC
              - SD
              - SE
              - SG
              - SH
              - SI
              - SJ
              - SK
              - SL
              - SM
              - SN
              - SO
              - SR
              - SS
              - ST
              - SV
              - SX
              - SY
              - SZ
              - TC
              - TD
              - TF
              - TG
              - TH
              - TJ
              - TK
              - TL
              - TM
              - TN
              - TO
              - TR
              - TT
              - TV
              - TW
              - TZ
              - UA
              - UG
              - UM
              - US
              - UY
              - UZ
              - VA
              - VC
              - VE
              - VG
              - VI
              - VN
              - VU
              - WF
              - WS
              - YE
              - YT
              - ZA
              - ZM
              - ZW
              - XK
        acceptLocalOnlyVideoPatients:
          type: boolean
          description: True, if the profile can attend video visits only to local patients
        about:
          type: string
          description: Short description or a CV for the profile
          example: A very long life story would go here
        licenseNumber:
          type: string
          description: Legal license number of the doctor or clinic
          example: 1234567/89034567
        experience:
          type: integer
          format: int32
          description: >-
            Years of experience as a doctor or years since establishment for a
            clinic
          example: 5
        university:
          type: string
          description: The name of the university the doctor graduated
          example: Harvard Medical School
        locations:
          type: array
          description: List of locations where the profile is practices
          items:
            $ref: '#/components/schemas/LocationDto'
        reviewCount:
          type: integer
          format: int32
          description: Number of reviews the doctor received
          example: 5
        reviewRating:
          type: number
          format: double
          description: Average reviews rating of the doctor
          example: 3.9
        doctorReviewRating:
          type: number
          format: double
          description: Average reviews rating of the doctor
          example: 8.9
        taxIdentificationNumber:
          type: string
          description: Tax identification number for the profile (temporary solution)
          example: 304657283
        personalIdentificationNumber:
          type: string
          description: Personal identification number for the doctor (temporary solution)
          example: 304657283
      title: >-
        Profile record; represents a single doctor or a clinic, which elected to
        be listed as a single entity
    PromoCodeDto:
      type: object
      description: It includes additional information specific to a promo code
      properties:
        promoCodeId:
          type: integer
          format: int32
          description: Unique identifier of the promo code
          example: 1234
        name:
          type: string
          description: Name of the promo code
          example: Welcome promo code
        key:
          type: string
          description: Unique key used to apply the promo code
          example: PROMO15
        discountPercentage:
          type: number
          format: double
          description: Discount percentage applied to the appointment cost
          example: 10
        discountFixed:
          type: number
          format: double
          description: Fixed discount amount applied to the  appointment cost
          example: 10
        currency:
          type: string
          description: Currency in which the discount is applied
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
          example: EUR
        discountPercentageLimit:
          type: number
          format: double
          description: >-
            Maximum amount for the discount that cannot be exceeded to apply
            this promo code
          example: 20
        minimalApplicableCost:
          type: number
          format: double
          description: Minimum appointment cost required to apply this promo code
          example: 50
      title: Promo Code details record
    SysParamDto:
      type: object
      properties:
        adminSubscriberId:
          type: integer
          format: int32
          description: Subscriber ID of the admin; for use in jobs
          example: 1789
        alternativeClinicLimitByDistance:
          type: integer
          format: int32
          description: Distance between requested location and offered location (meters)
          example: 10000
        amountOfAsapDoctorsF2F:
          type: integer
          format: int32
          description: Number of f2f appointments to create at the same time
          example: 1
        doctorReviewsLimit:
          type: integer
          format: int32
          description: Number of reviews returned by request
          example: 10
        doctorTermsOfUseVersion:
          type: integer
          format: int32
          description: >-
            The currently valid Terms of Use agreement version (in case an
            earlier version was approved, the practitioner will have to approve
            the new one)
          example: 1
        enabledAndroidWebViewModeFlag:
          type: integer
          format: int32
          description: >-
            Android Web view mode enabled indicator: one indicates web view is
            enabled, and zero indicates native view
          example: 0
        enabledIosWebViewModeFlag:
          type: integer
          format: int32
          description: >-
            iOS Web view mode enabled indicator: one indicates web view is
            enabled, and zero indicates native view
          example: 0
        enabledMultichannelNotificationsFlag:
          type: integer
          format: int32
          description: >-
            Multichannel notifications enabled indicator: one indicates it is
            enabled, and zero otherwise
          example: 1
        f2fBufferMinutes:
          type: integer
          format: int32
          description: buffer time for next available f2f visits (in minutes)
          example: 75
        graceCancellationCutoff:
          type: integer
          format: int32
          description: Grace cancellation cutoff
          example: 1800
        graceCancellationPeriod:
          type: integer
          format: int32
          description: Grace cancellation period
          example: 600
        graceRegretCutoff:
          type: integer
          format: int32
          description: Grace regret cutoff
          example: 1800
        graceRegretPeriod:
          type: integer
          format: int32
          description: Grace regret period
          example: 300
        interpreterLinkConnectionEnabled:
          type: integer
          format: int32
          description: >-
            Indicates whether interpreter connection uses call flow (0) or link
            flow (1).
          example: 1
        maxNumberOfAppointmentAlternatives:
          type: integer
          format: int32
          description: Maximum number of appointment alternatives
          example: 3
        maxPagesNumberForAttachments:
          type: integer
          format: int32
          description: Maximum number of pages allowed for attachments
          example: 10
        maxProfilesToPullForAggregator:
          type: integer
          format: int32
          description: >-
            The maximum number of profiles under one aggregator that are
            available for display in the pull profile view.
          example: 5
        maxPromoCodeNameLength:
          type: integer
          format: int32
          description: Maximum promo code name length
          example: 15
        maxVisibleDoctors:
          type: integer
          format: int32
          description: Maximum number of visible doctors on doctor list at the same time
          example: 20
        messageLimitForCSChat:
          type: integer
          format: int32
          description: Maximum number of messages returned at a time
          example: 50
        messageLimitForUserChat:
          type: integer
          format: int32
          description: Maximum number of messages returned at a time
          example: 20
        minDoctorAmountForOfflineCard:
          type: integer
          format: int32
          description: >-
            Minimum doctors amount which needed for showing f2f card on doctor
            list 
          example: 3
        minPromoCodeKeyLength:
          type: integer
          format: int32
          description: Minimum promo code key length
        minutesToExpireWizardSecondPageCache:
          type: integer
          format: int32
          description: Time to expire wizard second page cache in minutes
          example: 1440
        oneClickDelay:
          type: integer
          format: int32
          description: Delay to create ASAP video request (seconds).
          example: 900
        overrideRulesWindow:
          type: integer
          format: int32
          description: Period of working overridden policy rules (in minutes)
          example: 1
        patientTimeReminder:
          type: integer
          format: int32
          description: The time of emails and notifications for patient till video visit
          example: 120
        productionEnvironmentFlag:
          type: integer
          format: int32
          description: >-
            Running environment indicator: one indicates production and zero a
            sandbox
          example: 0
        profileTimeReminder:
          type: integer
          format: int32
          description: The time of emails and notifications for doctor till video visit
          example: 300
        reactionTimeAfterOpening:
          type: integer
          format: int32
          description: Minimum reaction time from the moment the clinic reopens (seconds)
          example: 1800
        reactionTimeBeforeClosing:
          type: integer
          format: int32
          description: Minimum reaction time before clinic closure (seconds)
          example: 900
        sameTimeLimitAfter:
          type: integer
          format: int32
          description: >-
            Maximum number of seconds into the future for the change to be
            considered insignificant
          example: 2700
        sameTimeLimitBefore:
          type: integer
          format: int32
          description: >-
            Maximum number of seconds into the past for the change to be
            considered insignificant
          example: 900
        shortRequestAppointmentTime:
          type: integer
          format: int32
          description: Countdown of appointment short request
          example: 1800
        shortRequestInitiatorId:
          type: integer
          format: int32
          description: ID of the short request initiator
          example: 299548
        showPatientChargeAndRefundButtons:
          type: integer
          format: int32
          description: Is show Patient Charge and Patient Refund buttons
          example: 0
        suggestInterpreterService:
          type: integer
          format: int32
          description: Is show interpreter service
          example: 1
        suggestShortRequestAppointments:
          type: integer
          format: int32
          description: Is show short request
          example: 1
        telemedicineBufferMinutes:
          type: integer
          format: int32
          description: buffer time for next available telemedicine visits (in minutes)
          example: 45
        timeAfterLastRecordedAction:
          type: integer
          format: int32
          description: >-
            Time after the last recorded action after which we create a new CS
            Time tracking event
          example: 600
        timeIntervalAgentsListExpiration:
          type: integer
          format: int32
          description: Delay for updating list of agents, in seconds
          example: 300
        timeIntervalForUploadingNewMessage:
          type: integer
          format: int32
          description: Time interval for uploading new messages (seconds)
          example: 15
        timeOutOverriddenPolicyRules:
          type: integer
          format: int32
          description: Time out when overridden policy rules active (seconds)
          example: 28800
        timePeriodicityUpdateCSTimeTracking:
          type: integer
          format: int32
          description: Time of update periodicity CS Time tracking event
          example: 300
        timeTillNoShowIsDeclared:
          type: integer
          format: int32
          description: Time from appointment time until NO_SHOW is declared (seconds)
          example: 31536000
        timeToCancelForFree:
          type: integer
          format: int32
          description: >-
            Time before the appointment, during which it could be cancelled for
            free (seconds)
          example: 10800
        timeToConfirmationExpiration:
          type: integer
          format: int32
          description: Time to status CONFIRM_TIME expiration (seconds)
          example: 3600
        timeToDoctorConfirmReminder:
          type: integer
          format: int32
          description: Time to wait for doctor confirmation after scheduled time (seconds)
          example: 3600
        timeToInviteInterpreterByPatient:
          type: integer
          format: int32
          description: Time before appointment scheduled time to invite interpreter
          example: 60
        timeToJoinVideoVisitAfter:
          type: integer
          format: int32
          description: >-
            Ending time after the appointment, until which the user can join
            video visit (seconds)
          example: 10800
        timeToJoinVideoVisitBefore:
          type: integer
          format: int32
          description: >-
            Starting time before the appointment, during which the user can join
            video visit (seconds)
          example: 300
        timeToPatientReviewReminder:
          type: integer
          format: int32
          description: Time to wait for patient review after scheduled time (seconds)
          example: 604800
        timeToProposalExpiration:
          type: integer
          format: int32
          description: Time to status PROPOSAL expiration (seconds)
          example: 7200
        timeToRequestExpiration:
          type: integer
          format: int32
          description: Time to status REQUESTED expiration (seconds)
          example: 2700
        timeToTextualConfirmationExpiration:
          type: integer
          format: int32
          description: >-
            Time to status CONFIRM_TIME expiration for textual requests
            (seconds)
          example: 86400
        timeToTextualRequestExpiration:
          type: integer
          format: int32
          description: Time to status REQUESTED expirationfor textual requests (seconds)
          example: 7200
        timeToTextualVisitReminder:
          type: integer
          format: int32
          description: Time to visit reminder expiration for textual requests (seconds)
          example: 43200
        timeToVisitReminder:
          type: integer
          format: int32
          description: Time before an appointment reminder should be issued (seconds)
          example: 14400
        versionAndroidMajor:
          type: integer
          format: int32
          description: >-
            Android minimum Air Doctor major software version supported (lower
            version will require a software update on the client)
          example: 3
        versionAndroidMinor:
          type: integer
          format: int32
          description: >-
            Android minimum Air Doctor minor software version supported (lower
            version will require a software update on the client)
          example: 100
        versioniOSMajor:
          type: integer
          format: int32
          description: >-
            iOS minimum Air Doctor major software version supported (lower
            version will require a software update on the client)
          example: 3
        versioniOSMinor:
          type: integer
          format: int32
          description: >-
            iOS minimum Air Doctor minor software version supported (lower
            version will require a software update on the client)
          example: 100
        visitSummaryMinCharacters:
          type: integer
          format: int32
          description: Minimum number of characters for visit summary
          example: 10
        allowedPromoCodeOwnerEmailDomain:
          type: string
          description: Allowed promo code owner email domain
          example: '@air-dr.com'
        availableInterpreterLanguages:
          type: string
          description: Languages, which are available for interpreter service
          example: IT,JA
        customerSupportSmsNumber:
          type: string
          description: used in email signature
          example: +1-585-332-2332
        customerSupportWhatsAppLink:
          type: string
          description: used in email signature
          example: https://wa.me/972549958615
        customerSupportWhatsAppNumber:
          type: string
          description: used in email signature
          example: +972-54-995-8615
        emailForCopyToQA:
          type: string
          description: Email addresses of QA or CS to send copies of all emails
          example: >-
            olga.g@air-dr.com,svetlana.n@air-dr.com,chana.b@air-dr.com,oleg.k@air-dr.com,anton.p@air-dr.com,arina.p@air-dr.com
        environmentCode:
          type: string
          description: Environment code
          example: dev
        integrationBluesnapPublicKey:
          type: string
          description: >-
            Encryption key used to encrypt patient's credit card before sending
            it out of the device
        integrationPushwooshAppCode:
          type: string
          description: Pushwoosh notification sending service registration App Code
          example: 68B35-6F04E
        integrationS3ServerUrl:
          type: string
          description: >-
            Base URL used to build paths of the attached photos (files are
            placed within the uploads folder on this server)
          example: https://airdrdev.s3.eu-west-3.amazonaws.com/
        mailCustomerSupport:
          type: string
          description: Mail server username for Community of Doctors account
          example: cases@air-dr.com
        mailInfoUsername:
          type: string
          description: Mail server username for Info account
          example: dev@air-dr.com
        mailLinksPrefix:
          type: string
          description: Mail links prefix (effectively the base URL the app runs at)
          example: https://dev.air-dr.com/webapp/
        mixpanelAnalyticsToken:
          type: string
          description: Mixpanel access token
        resetPasswordMessageSenderTeamName:
          type: string
          description: used in email signature
          example: The Air Doctor Team
        showCountryPatientStateToDoctor:
          type: string
          description: Show the patient's state/province from current country to the doctor
          example: US,CA
        signatureEmail:
          type: string
          description: Air Doctor customer support email
          example: support@air-dr.com
        signaturePhoneNumber:
          type: string
          description: Air Doctor customer support phone number
          example: +972-3-5457547
        signatureSmsTwillio:
          type: string
          description: AirDoctor SMS sender for Twilio
          example: '+12363267570'
        signatureUsPhoneNumber:
          type: string
          description: Air Doctor customer support US phone number
          example: +1-646-233-2756
        signatureWhatsApp:
          type: string
          description: Air Doctor customer support WhatsApp number supported by Combox
          example: +972-54-9958615
        signatureWhatsAppCombox:
          type: string
          description: Air Doctor customer support WhatsApp number supported by Combox
          example: +972-54-1465157
        signatureWhatsAppTwillio:
          type: string
          description: Air Doctor customer support WhatsApp number supported by Twillio
          example: '+48571490197'
        smartlookAccessToken:
          type: string
          description: Access token to Smartlook
        videoAutosuggestSpecialties:
          type: string
          description: Specialties, for which auto-suggestion is supported
          example: GENERAL
      title: Various system parameters
    TokenStatusDto:
      type: object
      properties:
        token:
          type: string
          description: >-
            User access token (value returned is as supplied, or new, if the
            token was not specified)
          example: >-
            0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123
        email:
          type: string
          description: User email
          example: test@air-dr.com
        permissions:
          type: array
          description: User`s permissions list
          items:
            $ref: '#/components/schemas/PermissionDto'
        subscriberId:
          type: integer
          format: int32
          description: User ID (this field has a legacy-based name)
          example: 1234
        firstName:
          type: string
          description: User's first name (if previsouly specified)
          example: John
        lastName:
          type: string
          description: User's last name (if previsouly specified)
          example: Smith
        phone:
          type: string
          description: User's phone number (if previsouly specified)
          example: '+972501234567'
        gender:
          type: string
          description: User's gender (if previsouly specified)
          enum:
            - MALE
            - FEMALE
            - BOTH
            - OTHER
          example: MALE
        birthday:
          type: string
          format: date
          description: User's date of birth
          example: '1980-04-20'
        cardSuffix:
          type: string
          description: >-
            Last 4 digits of the user's credit card (only provided, if the user
            chose to save credit card details for future bookings)
          example: 1234
        linkState:
          type: string
          description: >-
            If continuation is detected, this is the deep URL which should be
            followed
        minuteOffset:
          type: integer
          format: int32
          description: User minute offset
          example: 300
        ticketId:
          type: integer
          format: int32
          description: User ticket id
        prescriptions:
          type: array
          description: Countries where a prescription can be issued
          items:
            type: string
            enum:
              - AD
              - AE
              - AF
              - AG
              - AI
              - AL
              - AM
              - AO
              - AR
              - AS
              - AT
              - AU
              - AW
              - AX
              - AZ
              - BA
              - BB
              - BD
              - BE
              - BF
              - BG
              - BH
              - BI
              - BJ
              - BL
              - BM
              - BN
              - BO
              - BQ
              - BR
              - BS
              - BT
              - BV
              - BW
              - BY
              - BZ
              - CA
              - CC
              - CD
              - CF
              - CG
              - CH
              - CI
              - CK
              - CL
              - CM
              - CN
              - CO
              - CR
              - CU
              - CV
              - CW
              - CX
              - CY
              - CZ
              - DE
              - DJ
              - DK
              - DM
              - DO
              - DZ
              - EC
              - EE
              - EG
              - EH
              - ER
              - ES
              - ET
              - FI
              - FJ
              - FK
              - FM
              - FO
              - FR
              - GA
              - GB
              - GD
              - GE
              - GF
              - GG
              - GH
              - GI
              - GL
              - GM
              - GN
              - GP
              - GQ
              - GR
              - GS
              - GT
              - GU
              - GW
              - GY
              - HK
              - HN
              - HR
              - HT
              - HU
              - ID
              - IE
              - IL
              - IM
              - IN
              - IO
              - IQ
              - IR
              - IS
              - IT
              - JE
              - JM
              - JO
              - JP
              - KE
              - KG
              - KH
              - KI
              - KM
              - KN
              - KP
              - KR
              - KW
              - KY
              - KZ
              - LA
              - LB
              - LC
              - LI
              - LK
              - LR
              - LS
              - LT
              - LU
              - LV
              - LY
              - MA
              - MC
              - MD
              - ME
              - MF
              - MG
              - MH
              - MK
              - ML
              - MM
              - MN
              - MO
              - MQ
              - MR
              - MS
              - MT
              - MU
              - MV
              - MW
              - MX
              - MY
              - MZ
              - NA
              - NC
              - NE
              - NF
              - NG
              - NI
              - NL
              - 'NO'
              - NP
              - NR
              - NU
              - NZ
              - OM
              - PA
              - PE
              - PF
              - PG
              - PH
              - PK
              - PL
              - PM
              - PN
              - PR
              - PS
              - PT
              - PW
              - PY
              - QA
              - RE
              - RO
              - RS
              - RU
              - RW
              - SA
              - SB
              - SC
              - SD
              - SE
              - SG
              - SH
              - SI
              - SJ
              - SK
              - SL
              - SM
              - SN
              - SO
              - SR
              - SS
              - ST
              - SV
              - SX
              - SY
              - SZ
              - TC
              - TD
              - TF
              - TG
              - TH
              - TJ
              - TK
              - TL
              - TM
              - TN
              - TO
              - TR
              - TT
              - TV
              - TW
              - TZ
              - UA
              - UG
              - UM
              - US
              - UY
              - UZ
              - VA
              - VC
              - VE
              - VG
              - VI
              - VN
              - VU
              - WF
              - WS
              - YE
              - YT
              - ZA
              - ZM
              - ZW
              - XK
        searchedState:
          type: string
          description: The state that the user entered in the search field
          enum:
            - US_AL
            - US_AK
            - US_AZ
            - US_AR
            - US_CA
            - US_CO
            - US_CT
            - US_DE
            - US_DC
            - US_FL
            - US_GA
            - US_HI
            - US_ID
            - US_IL
            - US_IN
            - US_IA
            - US_KS
            - US_KY
            - US_LA
            - US_ME
            - US_MD
            - US_MA
            - US_MI
            - US_MN
            - US_MS
            - US_MO
            - US_MT
            - US_NE
            - US_NV
            - US_NH
            - US_NJ
            - US_NM
            - US_NY
            - US_NC
            - US_ND
            - US_OH
            - US_OK
            - US_OR
            - US_PA
            - US_RI
            - US_SC
            - US_SD
            - US_TN
            - US_TX
            - US_UT
            - US_VT
            - US_VA
            - US_WA
            - US_WV
            - US_WI
            - US_WY
            - DE_BW
            - DE_BY
            - DE_BE
            - DE_BB
            - DE_HB
            - DE_HH
            - DE_HE
            - DE_MV
            - DE_NI
            - DE_NW
            - DE_RP
            - DE_SL
            - DE_SN
            - DE_ST
            - DE_SH
            - DE_TH
            - CA_AB
            - CA_BC
            - CA_MB
            - CA_NB
            - CA_NL
            - CA_NT
            - CA_NS
            - CA_NU
            - CA_ON
            - CA_PE
            - CA_QC
            - CA_SK
            - CA_YT
            - IN_AN
            - IN_AP
            - IN_AR
            - IN_AS
            - IN_BR
            - IN_CH
            - IN_CG
            - IN_DH
            - IN_DL
            - IN_GA
            - IN_GJ
            - IN_HR
            - IN_HP
            - IN_JK
            - IN_JH
            - IN_KA
            - IN_KL
            - IN_LA
            - IN_LD
            - IN_MP
            - IN_MH
            - IN_MN
            - IN_ML
            - IN_MZ
            - IN_NL
            - IN_OD
            - IN_PY
            - IN_PB
            - IN_RJ
            - IN_SK
            - IN_TN
            - IN_TS
            - IN_TR
            - IN_UP
            - IN_UK
            - IN_WB
            - AU_NSW
            - AU_QLD
            - AU_SA
            - AU_TAS
            - AU_VIC
            - AU_WA
            - AU_ACT
            - AU_NT
            - CH_ZH
            - CH_BE
            - CH_LU
            - CH_UR
            - CH_SZ
            - CH_OW
            - CH_NW
            - CH_GL
            - CH_ZG
            - CH_FR
            - CH_SO
            - CH_BS
            - CH_BL
            - CH_SH
            - CH_AR
            - CH_AI
            - CH_SG
            - CH_GR
            - CH_AG
            - CH_TG
            - CH_TI
            - CH_VD
            - CH_VS
            - CH_NE
            - CH_GE
            - CH_JU
            - BR_AC
            - BR_AL
            - BR_AM
            - BR_AP
            - BR_BA
            - BR_CE
            - BR_DF
            - BR_ES
            - BR_GO
            - BR_MA
            - BR_MG
            - BR_MS
            - BR_MT
            - BR_PA
            - BR_PB
            - BR_PE
            - BR_PI
            - BR_PR
            - BR_RJ
            - BR_RN
            - BR_RO
            - BR_RR
            - BR_RS
            - BR_SC
            - BR_SE
            - BR_SP
            - BR_TO
        actualState:
          type: string
          description: User device state
          enum:
            - US_AL
            - US_AK
            - US_AZ
            - US_AR
            - US_CA
            - US_CO
            - US_CT
            - US_DE
            - US_DC
            - US_FL
            - US_GA
            - US_HI
            - US_ID
            - US_IL
            - US_IN
            - US_IA
            - US_KS
            - US_KY
            - US_LA
            - US_ME
            - US_MD
            - US_MA
            - US_MI
            - US_MN
            - US_MS
            - US_MO
            - US_MT
            - US_NE
            - US_NV
            - US_NH
            - US_NJ
            - US_NM
            - US_NY
            - US_NC
            - US_ND
            - US_OH
            - US_OK
            - US_OR
            - US_PA
            - US_RI
            - US_SC
            - US_SD
            - US_TN
            - US_TX
            - US_UT
            - US_VT
            - US_VA
            - US_WA
            - US_WV
            - US_WI
            - US_WY
            - DE_BW
            - DE_BY
            - DE_BE
            - DE_BB
            - DE_HB
            - DE_HH
            - DE_HE
            - DE_MV
            - DE_NI
            - DE_NW
            - DE_RP
            - DE_SL
            - DE_SN
            - DE_ST
            - DE_SH
            - DE_TH
            - CA_AB
            - CA_BC
            - CA_MB
            - CA_NB
            - CA_NL
            - CA_NT
            - CA_NS
            - CA_NU
            - CA_ON
            - CA_PE
            - CA_QC
            - CA_SK
            - CA_YT
            - IN_AN
            - IN_AP
            - IN_AR
            - IN_AS
            - IN_BR
            - IN_CH
            - IN_CG
            - IN_DH
            - IN_DL
            - IN_GA
            - IN_GJ
            - IN_HR
            - IN_HP
            - IN_JK
            - IN_JH
            - IN_KA
            - IN_KL
            - IN_LA
            - IN_LD
            - IN_MP
            - IN_MH
            - IN_MN
            - IN_ML
            - IN_MZ
            - IN_NL
            - IN_OD
            - IN_PY
            - IN_PB
            - IN_RJ
            - IN_SK
            - IN_TN
            - IN_TS
            - IN_TR
            - IN_UP
            - IN_UK
            - IN_WB
            - AU_NSW
            - AU_QLD
            - AU_SA
            - AU_TAS
            - AU_VIC
            - AU_WA
            - AU_ACT
            - AU_NT
            - CH_ZH
            - CH_BE
            - CH_LU
            - CH_UR
            - CH_SZ
            - CH_OW
            - CH_NW
            - CH_GL
            - CH_ZG
            - CH_FR
            - CH_SO
            - CH_BS
            - CH_BL
            - CH_SH
            - CH_AR
            - CH_AI
            - CH_SG
            - CH_GR
            - CH_AG
            - CH_TG
            - CH_TI
            - CH_VD
            - CH_VS
            - CH_NE
            - CH_GE
            - CH_JU
            - BR_AC
            - BR_AL
            - BR_AM
            - BR_AP
            - BR_BA
            - BR_CE
            - BR_DF
            - BR_ES
            - BR_GO
            - BR_MA
            - BR_MG
            - BR_MS
            - BR_MT
            - BR_PA
            - BR_PB
            - BR_PE
            - BR_PI
            - BR_PR
            - BR_RJ
            - BR_RN
            - BR_RO
            - BR_RR
            - BR_RS
            - BR_SC
            - BR_SE
            - BR_SP
            - BR_TO
        searchedCity:
          type: string
          description: The city that the user entered in the search field
        actualCity:
          type: string
          description: User device city
        unreadChatMessagesCount:
          type: integer
          format: int32
          description: Count of unread chat messages from CS
        administeredAggregators:
          type: array
          description: >-
            List of administered aggregators, by ID (only for users granted such
            a privilege)
          items:
            type: integer
            format: int32
        administeredProfileDtos:
          type: array
          description: >-
            List of administered profiles (only for users granted such a
            privilege); if the doctor is currently available for video visit,
            the value is until when, otherwise the value is null
          items:
            $ref: '#/components/schemas/ProfileAdministeredDto'
        people:
          type: array
          description: >-
            Currently registered people for this user (either known to be
            insured or previously had an appointment)
          items:
            $ref: '#/components/schemas/PersonDto'
        policies:
          type: array
          description: Insurance policies linked to the user
          items:
            $ref: '#/components/schemas/InsurancePolicyDto'
        companies:
          type: array
          description: List of all insurance companies supported
          items:
            $ref: '#/components/schemas/InsuranceCompanyClientDto'
        appointments:
          type: array
          description: User's appointments (either booked or where he administers a profile
          items:
            $ref: '#/components/schemas/AppointmentGetDto'
        profiles:
          type: array
          description: Profiles this user should be aware of (can administer)
          items:
            $ref: '#/components/schemas/ProfileDto'
        exchangeRates:
          $ref: '#/components/schemas/MapCurrencyEnumDouble'
          description: Currencies exchange rates compared to the US dollar.
        currencyRates:
          $ref: '#/components/schemas/MapCurrencyEnumListExchangeRateDto'
          description: >-
            Currency history as exchange rates list that are based on
            appointments' scheduled dates.
        sysParam:
          $ref: '#/components/schemas/SysParamDto'
          description: Various system parameters
        passwordHint:
          $ref: '#/components/schemas/PasswordHintDto'
          description: Password hint
          example: APPLE
        created:
          type: boolean
          description: Is entity new?
          example: false
        affiliate:
          $ref: '#/components/schemas/AffiliateTokenDto'
          description: Affiliate linked to used
        spokenLanguage:
          type: string
          description: Patient's spoken language, not specified by default
          enum:
            - AA
            - AB
            - AE
            - AF
            - AK
            - AM
            - AN
            - AR
            - AS
            - AV
            - AY
            - AZ
            - BA
            - BE
            - BG
            - BH
            - BI
            - BM
            - BN
            - BO
            - BR
            - BS
            - CA
            - CE
            - CH
            - CO
            - CR
            - CS
            - CU
            - CV
            - CY
            - DA
            - DE
            - DV
            - DZ
            - EE
            - EL
            - EN
            - EO
            - ES
            - ET
            - EU
            - FA
            - FF
            - FI
            - FJ
            - FO
            - FR
            - FY
            - GA
            - GD
            - GL
            - GN
            - GU
            - GV
            - HA
            - HE
            - HI
            - HO
            - HR
            - HT
            - HU
            - HY
            - HZ
            - IA
            - ID
            - IE
            - IG
            - II
            - IK
            - IO
            - IS
            - IT
            - IU
            - JA
            - JV
            - KA
            - KG
            - KI
            - KJ
            - KK
            - KL
            - KM
            - KN
            - KO
            - KR
            - KS
            - KU
            - KV
            - KW
            - KY
            - LA
            - LB
            - LG
            - LI
            - LN
            - LO
            - LT
            - LU
            - LV
            - MG
            - MH
            - MI
            - MK
            - ML
            - MN
            - MR
            - MS
            - MT
            - MY
            - NA
            - NB
            - ND
            - NE
            - NG
            - NL
            - NN
            - 'NO'
            - NR
            - NV
            - NY
            - OC
            - OJ
            - OM
            - OR
            - OS
            - PA
            - PI
            - PL
            - PS
            - PT
            - QU
            - RM
            - RN
            - RO
            - RU
            - RW
            - SA
            - SC
            - SD
            - SE
            - SG
            - SI
            - SK
            - SL
            - SM
            - SN
            - SO
            - SQ
            - SR
            - SS
            - ST
            - SU
            - SV
            - SW
            - TA
            - TE
            - TG
            - TH
            - TI
            - TK
            - TL
            - TN
            - TO
            - TR
            - TS
            - TT
            - TW
            - TY
            - UG
            - UK
            - UR
            - UZ
            - VE
            - VI
            - VO
            - WA
            - WO
            - XH
            - YI
            - YO
            - ZA
            - ZH
            - YUE
            - ZU
          example: EN
        actionAppointmentId:
          type: integer
          format: int32
          description: If action relates to an appointment, the appointment ID
          example: 46783
        actionText:
          type: string
          description: Action button text
          example: Click to Approve
        actionType:
          type: string
          description: Type of the action button presented
          enum:
            - PROPOSED_PATIENT_CALL_US_BUTTON_TEXT
            - REQUESTED_PATIENT_PENDING_DOCTORS_APPROVAL
            - MINUTES_LEFT_PATIENT_DOCTOR_APPROVE
            - MINUTES_LEFT_DOCTOR_APPROVE
            - MINUTES_LEFT_DOCTOR_APPROVE_MORE_THAN_45
            - VISIT_OFFER_CALL_US_BUTTON_TEXT
            - PENDING_THE_PATIENT_APPROVAL
            - MINUTES_LEFT_DOCTOR_PATIENT_APPROVE
            - START_VIDEO_VISIT
            - VIDEO_VISIT_CONFIRMED_NOTIFICATION
            - VISIT_CONFIRMED_PATIENT_SIDE_NOTIFICATION
            - VISITED_STATUS_NOTIFICATION
            - RATE_NOTIFICATION
            - CS_SUGGESTION_PLEASE_CONFIRM_APPOINTMENT_DOCTOR_TEXT
            - CONTACT_US
            - PAYMENT_FAILED_CALL_US_BUTTON_TEXT
            - SHORT_REQUEST
          example: CONTACT_US
        actionRemainingTime:
          type: integer
          format: int32
          description: Action button remaining time (in minutes, for the countdown)
          example: 35
        actionLink:
          type: string
          description: Action button link to open
          example: appointment-details=46783
        actionIcon:
          type: string
          description: Action button icon
          enum:
            - ALERT
            - CANCELLED
            - CONFIRMED
            - CONTACT
            - COUNTDOWN_VIDEO
            - COUNTDOWN
            - PROPOSED
            - QUESTION
            - RATE
            - VIDEO
          example: RATE
        actualShortRequest:
          type: boolean
          description: is actual f2f request
        forceMFACreation:
          type: boolean
          description: is Multi-factor authentication required
        whatsAppPreference:
          type: string
          description: >-
            Indicates whether WhatsApp is selected as the preferred method for
            receiving notifications or not
          enum:
            - TURNED_OFF
            - TURNED_ON
            - DISABLED
        smsPreference:
          type: string
          description: >-
            Indicates whether SMS is selected as the preferred method for
            receiving notifications or not
          enum:
            - TURNED_OFF
            - TURNED_ON
            - DISABLED
        emailPreference:
          type: string
          description: >-
            Indicates whether Email is selected as the preferred method for
            receiving notifications or not
          enum:
            - TURNED_OFF
            - TURNED_ON
            - DISABLED
      title: Basic app configuration and user details
    TravelDatesDto:
      type: object
      description: Travel dates for the policy
      properties:
        id:
          type: integer
          format: int32
          description: Unique ID
          example: 1
        startDate:
          type: string
          format: date
          description: Travel start date
          example: '2022-01-01'
        endDate:
          type: string
          format: date
          description: Travel end date
          example: '2022-12-31'
        subscriberId:
          type: integer
          format: int32
          description: Subscriber ID
          example: 123
      title: Travel dates of insurance policy record
    MinTokenStatusDto:
      type: object
      properties:
        token:
          type: string
          description: >-
            User access token (value returned is as supplied, or new, if the
            token was not specified)
          example: >-
            0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123
        email:
          type: string
          description: User email
          example: test@air-dr.com
        permissions:
          type: array
          description: User`s permissions list
          items:
            $ref: '#/components/schemas/PermissionDto'
        subscriberId:
          type: integer
          format: int32
          description: User ID (this field has a legacy-based name)
          example: 1234
        firstName:
          type: string
          description: User's first name (if previsouly specified)
          example: John
        lastName:
          type: string
          description: User's last name (if previsouly specified)
          example: Smith
        phone:
          type: string
          description: User's phone number (if previsouly specified)
          example: '+972501234567'
        gender:
          type: string
          description: User's gender (if previsouly specified)
          enum:
            - MALE
            - FEMALE
            - BOTH
            - OTHER
          example: MALE
        birthday:
          type: string
          format: date
          description: User's date of birth
          example: '1980-04-20'
        cardSuffix:
          type: string
          description: >-
            Last 4 digits of the user's credit card (only provided, if the user
            chose to save credit card details for future bookings)
          example: 1234
        linkState:
          type: string
          description: >-
            If continuation is detected, this is the deep URL which should be
            followed
        minuteOffset:
          type: integer
          format: int32
          description: User minute offset
          example: 300
        ticketId:
          type: integer
          format: int32
          description: User ticket id
        prescriptions:
          type: array
          description: Countries where a prescription can be issued
          items:
            type: string
            enum:
              - AD
              - AE
              - AF
              - AG
              - AI
              - AL
              - AM
              - AO
              - AR
              - AS
              - AT
              - AU
              - AW
              - AX
              - AZ
              - BA
              - BB
              - BD
              - BE
              - BF
              - BG
              - BH
              - BI
              - BJ
              - BL
              - BM
              - BN
              - BO
              - BQ
              - BR
              - BS
              - BT
              - BV
              - BW
              - BY
              - BZ
              - CA
              - CC
              - CD
              - CF
              - CG
              - CH
              - CI
              - CK
              - CL
              - CM
              - CN
              - CO
              - CR
              - CU
              - CV
              - CW
              - CX
              - CY
              - CZ
              - DE
              - DJ
              - DK
              - DM
              - DO
              - DZ
              - EC
              - EE
              - EG
              - EH
              - ER
              - ES
              - ET
              - FI
              - FJ
              - FK
              - FM
              - FO
              - FR
              - GA
              - GB
              - GD
              - GE
              - GF
              - GG
              - GH
              - GI
              - GL
              - GM
              - GN
              - GP
              - GQ
              - GR
              - GS
              - GT
              - GU
              - GW
              - GY
              - HK
              - HN
              - HR
              - HT
              - HU
              - ID
              - IE
              - IL
              - IM
              - IN
              - IO
              - IQ
              - IR
              - IS
              - IT
              - JE
              - JM
              - JO
              - JP
              - KE
              - KG
              - KH
              - KI
              - KM
              - KN
              - KP
              - KR
              - KW
              - KY
              - KZ
              - LA
              - LB
              - LC
              - LI
              - LK
              - LR
              - LS
              - LT
              - LU
              - LV
              - LY
              - MA
              - MC
              - MD
              - ME
              - MF
              - MG
              - MH
              - MK
              - ML
              - MM
              - MN
              - MO
              - MQ
              - MR
              - MS
              - MT
              - MU
              - MV
              - MW
              - MX
              - MY
              - MZ
              - NA
              - NC
              - NE
              - NF
              - NG
              - NI
              - NL
              - 'NO'
              - NP
              - NR
              - NU
              - NZ
              - OM
              - PA
              - PE
              - PF
              - PG
              - PH
              - PK
              - PL
              - PM
              - PN
              - PR
              - PS
              - PT
              - PW
              - PY
              - QA
              - RE
              - RO
              - RS
              - RU
              - RW
              - SA
              - SB
              - SC
              - SD
              - SE
              - SG
              - SH
              - SI
              - SJ
              - SK
              - SL
              - SM
              - SN
              - SO
              - SR
              - SS
              - ST
              - SV
              - SX
              - SY
              - SZ
              - TC
              - TD
              - TF
              - TG
              - TH
              - TJ
              - TK
              - TL
              - TM
              - TN
              - TO
              - TR
              - TT
              - TV
              - TW
              - TZ
              - UA
              - UG
              - UM
              - US
              - UY
              - UZ
              - VA
              - VC
              - VE
              - VG
              - VI
              - VN
              - VU
              - WF
              - WS
              - YE
              - YT
              - ZA
              - ZM
              - ZW
              - XK
        searchedState:
          type: string
          description: The state that the user entered in the search field
          enum:
            - US_AL
            - US_AK
            - US_AZ
            - US_AR
            - US_CA
            - US_CO
            - US_CT
            - US_DE
            - US_DC
            - US_FL
            - US_GA
            - US_HI
            - US_ID
            - US_IL
            - US_IN
            - US_IA
            - US_KS
            - US_KY
            - US_LA
            - US_ME
            - US_MD
            - US_MA
            - US_MI
            - US_MN
            - US_MS
            - US_MO
            - US_MT
            - US_NE
            - US_NV
            - US_NH
            - US_NJ
            - US_NM
            - US_NY
            - US_NC
            - US_ND
            - US_OH
            - US_OK
            - US_OR
            - US_PA
            - US_RI
            - US_SC
            - US_SD
            - US_TN
            - US_TX
            - US_UT
            - US_VT
            - US_VA
            - US_WA
            - US_WV
            - US_WI
            - US_WY
            - DE_BW
            - DE_BY
            - DE_BE
            - DE_BB
            - DE_HB
            - DE_HH
            - DE_HE
            - DE_MV
            - DE_NI
            - DE_NW
            - DE_RP
            - DE_SL
            - DE_SN
            - DE_ST
            - DE_SH
            - DE_TH
            - CA_AB
            - CA_BC
            - CA_MB
            - CA_NB
            - CA_NL
            - CA_NT
            - CA_NS
            - CA_NU
            - CA_ON
            - CA_PE
            - CA_QC
            - CA_SK
            - CA_YT
            - IN_AN
            - IN_AP
            - IN_AR
            - IN_AS
            - IN_BR
            - IN_CH
            - IN_CG
            - IN_DH
            - IN_DL
            - IN_GA
            - IN_GJ
            - IN_HR
            - IN_HP
            - IN_JK
            - IN_JH
            - IN_KA
            - IN_KL
            - IN_LA
            - IN_LD
            - IN_MP
            - IN_MH
            - IN_MN
            - IN_ML
            - IN_MZ
            - IN_NL
            - IN_OD
            - IN_PY
            - IN_PB
            - IN_RJ
            - IN_SK
            - IN_TN
            - IN_TS
            - IN_TR
            - IN_UP
            - IN_UK
            - IN_WB
            - AU_NSW
            - AU_QLD
            - AU_SA
            - AU_TAS
            - AU_VIC
            - AU_WA
            - AU_ACT
            - AU_NT
            - CH_ZH
            - CH_BE
            - CH_LU
            - CH_UR
            - CH_SZ
            - CH_OW
            - CH_NW
            - CH_GL
            - CH_ZG
            - CH_FR
            - CH_SO
            - CH_BS
            - CH_BL
            - CH_SH
            - CH_AR
            - CH_AI
            - CH_SG
            - CH_GR
            - CH_AG
            - CH_TG
            - CH_TI
            - CH_VD
            - CH_VS
            - CH_NE
            - CH_GE
            - CH_JU
            - BR_AC
            - BR_AL
            - BR_AM
            - BR_AP
            - BR_BA
            - BR_CE
            - BR_DF
            - BR_ES
            - BR_GO
            - BR_MA
            - BR_MG
            - BR_MS
            - BR_MT
            - BR_PA
            - BR_PB
            - BR_PE
            - BR_PI
            - BR_PR
            - BR_RJ
            - BR_RN
            - BR_RO
            - BR_RR
            - BR_RS
            - BR_SC
            - BR_SE
            - BR_SP
            - BR_TO
        actualState:
          type: string
          description: User device state
          enum:
            - US_AL
            - US_AK
            - US_AZ
            - US_AR
            - US_CA
            - US_CO
            - US_CT
            - US_DE
            - US_DC
            - US_FL
            - US_GA
            - US_HI
            - US_ID
            - US_IL
            - US_IN
            - US_IA
            - US_KS
            - US_KY
            - US_LA
            - US_ME
            - US_MD
            - US_MA
            - US_MI
            - US_MN
            - US_MS
            - US_MO
            - US_MT
            - US_NE
            - US_NV
            - US_NH
            - US_NJ
            - US_NM
            - US_NY
            - US_NC
            - US_ND
            - US_OH
            - US_OK
            - US_OR
            - US_PA
            - US_RI
            - US_SC
            - US_SD
            - US_TN
            - US_TX
            - US_UT
            - US_VT
            - US_VA
            - US_WA
            - US_WV
            - US_WI
            - US_WY
            - DE_BW
            - DE_BY
            - DE_BE
            - DE_BB
            - DE_HB
            - DE_HH
            - DE_HE
            - DE_MV
            - DE_NI
            - DE_NW
            - DE_RP
            - DE_SL
            - DE_SN
            - DE_ST
            - DE_SH
            - DE_TH
            - CA_AB
            - CA_BC
            - CA_MB
            - CA_NB
            - CA_NL
            - CA_NT
            - CA_NS
            - CA_NU
            - CA_ON
            - CA_PE
            - CA_QC
            - CA_SK
            - CA_YT
            - IN_AN
            - IN_AP
            - IN_AR
            - IN_AS
            - IN_BR
            - IN_CH
            - IN_CG
            - IN_DH
            - IN_DL
            - IN_GA
            - IN_GJ
            - IN_HR
            - IN_HP
            - IN_JK
            - IN_JH
            - IN_KA
            - IN_KL
            - IN_LA
            - IN_LD
            - IN_MP
            - IN_MH
            - IN_MN
            - IN_ML
            - IN_MZ
            - IN_NL
            - IN_OD
            - IN_PY
            - IN_PB
            - IN_RJ
            - IN_SK
            - IN_TN
            - IN_TS
            - IN_TR
            - IN_UP
            - IN_UK
            - IN_WB
            - AU_NSW
            - AU_QLD
            - AU_SA
            - AU_TAS
            - AU_VIC
            - AU_WA
            - AU_ACT
            - AU_NT
            - CH_ZH
            - CH_BE
            - CH_LU
            - CH_UR
            - CH_SZ
            - CH_OW
            - CH_NW
            - CH_GL
            - CH_ZG
            - CH_FR
            - CH_SO
            - CH_BS
            - CH_BL
            - CH_SH
            - CH_AR
            - CH_AI
            - CH_SG
            - CH_GR
            - CH_AG
            - CH_TG
            - CH_TI
            - CH_VD
            - CH_VS
            - CH_NE
            - CH_GE
            - CH_JU
            - BR_AC
            - BR_AL
            - BR_AM
            - BR_AP
            - BR_BA
            - BR_CE
            - BR_DF
            - BR_ES
            - BR_GO
            - BR_MA
            - BR_MG
            - BR_MS
            - BR_MT
            - BR_PA
            - BR_PB
            - BR_PE
            - BR_PI
            - BR_PR
            - BR_RJ
            - BR_RN
            - BR_RO
            - BR_RR
            - BR_RS
            - BR_SC
            - BR_SE
            - BR_SP
            - BR_TO
        searchedCity:
          type: string
          description: The city that the user entered in the search field
        actualCity:
          type: string
          description: User device city
        unreadChatMessagesCount:
          type: integer
          format: int32
          description: Count of unread chat messages from CS
      title: Minimum user details
    MapInsuranceIdFieldsEnumString:
      type: object
      description: Policy Identifiers
      properties:
        COMPANY:
          type: string
        SUBSCRIBER_ID:
          type: string
        POLICY_NUMBER:
          type: string
        FIRST_NAME:
          type: string
        LAST_NAME:
          type: string
        GENDER:
          type: string
        PERSONAL_ID_NUMBER:
          type: string
        DATE_OF_BIRTH:
          type: string
        POLICY_START_DATE:
          type: string
        POLICY_END_DATE:
          type: string
        PHONE_NUMBER:
          type: string
        EMAIL_ADDRESS:
          type: string
        CARD_4_DIGITS:
          type: string
        TRAVEL_START_DATE:
          type: string
        TRAVEL_END_DATE:
          type: string
        EXCESS:
          type: string
        EXCESS_CURRENCY:
          type: string
        PASSWORD_HINT:
          type: string
        LATITUDE:
          type: string
        LONGITUDE:
          type: string
        PACKAGE:
          type: string
        SPECIALITY:
          type: string
        LANGUAGE:
          type: string
      title: Map giving a value based on Policy identifier
    ContactInsuranceDto:
      type: object
      description: Contact Request Details
      properties:
        personId:
          type: integer
          format: int32
          description: Person ID; should be linked to an insurance policy
          example: 123
        language:
          type: string
          description: >-
            User's preferred communications language (out of the languages
            accepted by the insurance carrier)
          enum:
            - AA
            - AB
            - AE
            - AF
            - AK
            - AM
            - AN
            - AR
            - AS
            - AV
            - AY
            - AZ
            - BA
            - BE
            - BG
            - BH
            - BI
            - BM
            - BN
            - BO
            - BR
            - BS
            - CA
            - CE
            - CH
            - CO
            - CR
            - CS
            - CU
            - CV
            - CY
            - DA
            - DE
            - DV
            - DZ
            - EE
            - EL
            - EN
            - EO
            - ES
            - ET
            - EU
            - FA
            - FF
            - FI
            - FJ
            - FO
            - FR
            - FY
            - GA
            - GD
            - GL
            - GN
            - GU
            - GV
            - HA
            - HE
            - HI
            - HO
            - HR
            - HT
            - HU
            - HY
            - HZ
            - IA
            - ID
            - IE
            - IG
            - II
            - IK
            - IO
            - IS
            - IT
            - IU
            - JA
            - JV
            - KA
            - KG
            - KI
            - KJ
            - KK
            - KL
            - KM
            - KN
            - KO
            - KR
            - KS
            - KU
            - KV
            - KW
            - KY
            - LA
            - LB
            - LG
            - LI
            - LN
            - LO
            - LT
            - LU
            - LV
            - MG
            - MH
            - MI
            - MK
            - ML
            - MN
            - MR
            - MS
            - MT
            - MY
            - NA
            - NB
            - ND
            - NE
            - NG
            - NL
            - NN
            - 'NO'
            - NR
            - NV
            - NY
            - OC
            - OJ
            - OM
            - OR
            - OS
            - PA
            - PI
            - PL
            - PS
            - PT
            - QU
            - RM
            - RN
            - RO
            - RU
            - RW
            - SA
            - SC
            - SD
            - SE
            - SG
            - SI
            - SK
            - SL
            - SM
            - SN
            - SO
            - SQ
            - SR
            - SS
            - ST
            - SU
            - SV
            - SW
            - TA
            - TE
            - TG
            - TH
            - TI
            - TK
            - TL
            - TN
            - TO
            - TR
            - TS
            - TT
            - TW
            - TY
            - UG
            - UK
            - UR
            - UZ
            - VE
            - VI
            - VO
            - WA
            - WO
            - XH
            - YI
            - YO
            - ZA
            - ZH
            - YUE
            - ZU
          example: EN
        location:
          type: string
          description: General user's location
          example: London, UK
        phone:
          type: string
          description: Phone number where the user can be reached
          example: '+442067894321'
        notes:
          type: string
          description: Any patient-specific comments or requests
          example: I need to urgently talk to a representative
      title: >-
        Record holding the details needed for the insurance carrier to contact
        the user
    PersonAdditionDto:
      type: object
      description: Person Details
      properties:
        personId:
          type: integer
          format: int32
          description: >-
            Unique user ID (should only be specified when existing the person is
            being edited)
          example: 123
        policyId:
          type: integer
          format: int32
          description: >-
            Policy ID reference (should not be specified for a person passed
            within the policy's list)
          example: 456
        firstName:
          type: string
          description: Person's first name
          example: John
        lastName:
          type: string
          description: Person's last name
          example: Smith
        firstNameLatin:
          type: string
          description: Person's first name in Latin letters
          example: John
        lastNameLatin:
          type: string
          description: Person's last name in Latin letters
          example: Smith
        gender:
          type: string
          description: Person's gender
          enum:
            - MALE
            - FEMALE
            - BOTH
            - OTHER
          example: MALE
        birthday:
          type: string
          format: date
          description: Person's date of birth
          example: '1980-04-20'
        personalIdNumber:
          type: string
          description: >-
            Person's government ID number (usually either an identity card
            number or a passport number)
          example: 30123456789
      title: Person record for addition or modification by the user
    InsurancePolicyWithPeopleDto:
      type: object
      description: >-
        Almost all the fields are optional; on update any missing field will be
        left as is
      properties:
        policyId:
          type: integer
          format: int32
          description: Unique insurance policy ID
          example: 123
        corporateName:
          type: string
          description: For corporate policies, the name of the company
          example: Over the Rainbow inc
        companyId:
          type: integer
          format: int32
          description: >-
            Insurance company ID (will be supplied by Air Doctor; security will
            forbid calls with the wrong value)
          example: 1
        policyNumber:
          type: string
          description: >-
            The insurance policy number (this is the unique identifier of the
            insurance policy for this call)
          example: 468239748923321
        creationDate:
          type: string
          format: date-time
          description: Timestamp when policy was created
          example: '2019-12-09T08:40:53'
        phone:
          type: string
          description: Phone number associated with the policy
          example: '+15467383892'
        startDate:
          type: string
          format: date
          description: Policy validity start date
          example: '2020-01-01'
        endDate:
          type: string
          format: date
          description: Policy validity end date
          example: '2020-12-31'
        status:
          type: string
          description: >-
            Status of the policy (policy deletion is not supported; pass
            CANCELLED to cancel the policy)
          enum:
            - ACTIVE
            - CANCELLED
          example: ACTIVE
        excessCurrency:
          type: string
          description: The currency of the excess (deductible) amount
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
          example: USD
        excessPercentage:
          type: number
          format: double
          description: >-
            Excess (deductible) to be charged for a visit (basic fee percentage;
            to remove excess, set to a negative value)
          example: 0.2
        excessFee:
          type: number
          format: double
          description: >-
            Excess (deductible) to be charged for a visit (fixed part; to remove
            excess, set to a negative value)
          example: 50
        accumulatedExcess:
          type: boolean
          description: >-
            Accumulated excess behaviour. “Atomic/copay” (if set to false) or
            all accumulated (if set to true)
        canRenewPolicy:
          type: boolean
          description: >-
            The insurance policy allows the user to request policy renewal (via
            insurer's website)
        canBookPrivately:
          type: boolean
          description: >-
            The insurance policy allows the user to book an appointment
            privately (ignoring the policy)
        canAddPatients:
          type: boolean
          description: >-
            The insurance policy allows the user to add patients to the policy
            (usually when the list of policyholders cannot be supplied upfront)
        canUseClinicVisits:
          type: boolean
          description: The patient can use clinic visits
        canUseHomeVisits:
          type: boolean
          description: The patient can use home visits
        canUseVideoVisits:
          type: boolean
          description: The patient can use video visits
        canBeDisabled:
          type: boolean
          description: The user is allowed to remove the policy from his account
        skipPolicyPull:
          type: boolean
          description: Policy skips external insurer's validation
        needsCreditCard:
          type: boolean
          description: The policy requires credit card entry to book an appointment
        requireTravelDates:
          type: boolean
          description: The policy can have the travel dates
        useStatus:
          type: string
          description: >-
            Association status for the current user (ignored for policy
            management; only used for token status)
          enum:
            - ACTIVE
            - CANCELLED
          example: ACTIVE
        usersLimit:
          type: integer
          format: int32
          default: '999'
          description: >-
            The number of users who can associate this policy to their account
            (0 value is ignored - 999 assumed; pass a negative value to set the
            field to zero)
          example: 1
        travelDates:
          type: array
          description: Travel dates for insurance policy
          items:
            $ref: '#/components/schemas/TravelDatesDto'
        packageType:
          type: integer
          format: int32
          description: The package type of policy
        associationDate:
          type: string
          format: date-time
          description: Timestamp when policy was associated to the user (GET only)
          example: '2019-12-09T08:40:53'
        touchedByAssistance:
          type: boolean
          description: TRUE if a policy was created or updated through the 'Assistance API'
        homeCountry:
          type: string
          description: Home country for policy
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
          example: BV
        notificationOnCreation:
          type: string
          description: The user can receive a notification about the creation of a policy
          enum:
            - SEND
            - OMIT
            - DEFAULT
          example: OMIT
        notificationOnUpdate:
          type: string
          description: The user can receive a notification about the update of a policy
          enum:
            - SEND
            - OMIT
            - DEFAULT
          example: SEND
        notificationOnCancelation:
          type: string
          description: The user can receive a notification about the cancel of a policy
          enum:
            - SEND
            - OMIT
            - DEFAULT
          example: DEFAULT
        notificationTimeBeforePolicyStart:
          type: integer
          format: int32
          description: >-
            Shows the time in seconds for which the user will receive a
            notification before creating the policy. 
             0 means default; -1 means do not send; any other negative means revert to default. 
          example: 86400
        distributorName:
          type: string
          description: Name of policy distributor company
          example: Delta
        people:
          type: array
          description: The list of people included in this policy
          items:
            $ref: '#/components/schemas/PersonDto'
        corporateAgent:
          type: string
          description: For corporate policies, insurance agent responsible
          example: Shuki & Sons inc
        corporateEmails:
          type: string
          description: For corporate policies, corporate email address
          example: someone@somewhere.com
        policyIdentifier:
          type: string
          description: Insurance policy custom identifier
          example: 821346
        email:
          type: string
          description: Policyholder's registration email address
          example: someone@example.com
        preferredLink:
          type: string
          description: Preferred link to send to the user (GET only)
          example: https://www.air-dr.com/some-policy-identifier
        ownerUserName:
          type: string
          description: Username that has created the policy (GET only)
          example: email@domain.com
        language:
          type: string
          description: Language of mail
          enum:
            - ENGLISH
            - ENGLISH_UK
            - HEBREW
            - SPANISH
            - GERMAN
            - CHINESE
            - DUTCH
            - FRENCH
            - RUSSIAN
            - JAPANESE
            - ITALIAN
          example: Germany
      required:
        - companyId
        - policyNumber
      title: >-
        Insurance policy record with a list of people insured as part of the
        policy
    OverriddenPolicyRulesDto:
      type: object
      properties:
        patientId:
          type: integer
          format: int32
          description: >-
            Air Doctor's internal patient id to apply the override. Pass blank
            if override is applied to the whole policy (to each active patient
            in the policy)
          example: 9876
        followUp:
          type: boolean
          description: >-
            If true - overridden policy rules will apply to follow-up visits
            only
        startTimestamp:
          type: string
          format: date-time
          default: current time
          description: Override window start time
          example: 2020-07-29T08:30
        endTimestamp:
          type: string
          format: date-time
          default: start time + 24 hours
          description: Override window end time
          example: 2020-07-29T16:30
        reason:
          type: string
          description: Override reason
          example: Customer requested extra visit
        status:
          type: string
          description: Current overridden policy rules status
          enum:
            - HIDE
            - SHOW_BLOCK
            - ASSISTANCE
            - PAY
            - PREPAYMENT
            - CC_BACKUP
            - COVERED
            - PAY_UNDER_INSURER
          example: COVERED
        country:
          type: string
          description: Allowed country. Pass blank if all company allowed countries
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
          example: DE
        specialty:
          type: string
          description: Allowed specialty. Pass blank if all company allowed specialties
          enum:
            - GENERAL
            - DENTIST
            - ORTHOPEDIST
            - PEDIATRICIAN
            - GYNECOLOGIST
            - PULMONOLOGIST
            - GASTROENTEROLOGIST
            - OPHTALMOLOGIST
            - DERMATOLOGIST
            - NEUROLOGIST
            - ENT
            - PSYCHIATRIST
            - CARDIOLOGIST
            - UROLOGIST
            - ALTERNATIVE
            - OTHER
            - EMERGENCY
            - MORE
            - MASSEUSE
            - ONCOLOGIST
            - SURGEON
            - INTERNIST
            - HEMATOLOGIST
            - NEPHROLOGIST
            - RHEUMATOLOGIST
            - GERIATRICIAN
            - ALLERGOLOGIST
            - ONLINE_DOCTOR
            - IMAGING
            - LABS
          example: GENERAL
        priceLimit:
          type: number
          format: double
          description: Price limit. Pass 0 or skip this field if up to company price limit
          example: 25.5
        priceLimitCurrency:
          type: string
          default: company default currency
          description: Price limit currency
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
          example: USD
        allowUseVideoVisit:
          type: boolean
          description: Video visits allowed
          example: true
        allowUseClinicVisit:
          type: boolean
          description: Clinic visits allowed
          example: true
        allowUseHomeVisit:
          type: boolean
          description: Home visits allowed
          example: false
        visitsNumber:
          type: integer
          format: int32
          default: '1'
          description: Max number of allowed visits inside current override
          example: 1
        excessFee:
          type: number
          format: double
          default: '0'
          description: Excess (deductible) to be charged for a visit
          example: 50
        excessCurrency:
          type: string
          description: Excess (deductible) currency to be charged for a visit
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
          example: USD
        attachments:
          type: array
          description: List of attachments
          items:
            $ref: '#/components/schemas/PhotoDto'
        followUpOverride:
          type: string
          description: Does follow up availability manually override
          enum:
            - FORBID
            - ALLOW
            - DEFAULT
          example: DEFAULT
      required:
        - status
      title: Policy rules override creation record
    InsurerStateDto:
      type: object
      properties:
        visitFee:
          type: number
          format: double
          description: Appointment visit fee
          example: 23.45
        visitFeeCurrency:
          type: string
          description: Appointment visit currency
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
          example: USD
        patientId:
          type: integer
          format: int32
          description: Patient's identifier
          example: 12233
        visitDate:
          type: string
          format: date-time
          description: Appointment scheduled date and time. Initiators local time
        country:
          type: string
          description: Country where appointment will happen
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
        specialty:
          type: string
          description: Doctors specialty
          enum:
            - GENERAL
            - DENTIST
            - ORTHOPEDIST
            - PEDIATRICIAN
            - GYNECOLOGIST
            - PULMONOLOGIST
            - GASTROENTEROLOGIST
            - OPHTALMOLOGIST
            - DERMATOLOGIST
            - NEUROLOGIST
            - ENT
            - PSYCHIATRIST
            - CARDIOLOGIST
            - UROLOGIST
            - ALTERNATIVE
            - OTHER
            - EMERGENCY
            - MORE
            - MASSEUSE
            - ONCOLOGIST
            - SURGEON
            - INTERNIST
            - HEMATOLOGIST
            - NEPHROLOGIST
            - RHEUMATOLOGIST
            - GERIATRICIAN
            - ALLERGOLOGIST
            - ONLINE_DOCTOR
            - IMAGING
            - LABS
        locationType:
          type: string
          description: Visit type
          enum:
            - HOME_VISIT
            - CLINIC_VISIT
            - VIDEO_VISIT
          example: CLINIC
        hasFollowUp:
          type: boolean
          description: Is next visit follow up
        appointmentId:
          type: integer
          format: int32
          description: Appointment id to skip in appropriate status
      title: List of parameters for next appointment status identification
    InsurerStateResponseDto:
      type: object
      properties:
        chunkStatus:
          type: string
          description: Availability status of the visit
          enum:
            - HIDE
            - SHOW_BLOCK
            - ASSISTANCE
            - PAY
            - PREPAYMENT
            - CC_BACKUP
            - COVERED
            - PAY_UNDER_INSURER
        messageId:
          type: integer
          format: int32
          description: Message identifier for the next visit
        priceLimit:
          type: number
          format: double
          description: Price limit for the next visit
        priceLimitCurrency:
          type: string
          description: Price limit currency for the next visit
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
        visitsCount:
          type: integer
          format: int32
          description: Max count of visits. Applicable for overrides only
        overriddenExcess:
          type: number
          format: double
          description: >-
            Overridden excess. Always in policy excess currency. Applicable for
            overrides only
      title: Insurer status for next appointment
    CommonInsurerStateResponseDto:
      type: object
      properties:
        chunkStatus:
          type: string
          description: Availability status of the visit
          enum:
            - HIDE
            - SHOW_BLOCK
            - ASSISTANCE
            - PAY
            - PREPAYMENT
            - CC_BACKUP
            - COVERED
            - PAY_UNDER_INSURER
        messageId:
          type: integer
          format: int32
          description: Message identifier for the next visit
      title: Insurer status for next appointment
    AppointmentPostDto:
      type: object
      properties:
        appointmentId:
          type: integer
          format: int32
          description: Unique appointment ID (leave blank when creating an appointment)
          example: 1234
        appointmentRevisionId:
          type: integer
          format: int32
          description: >-
            Unique appointment revision ID (optional, but recommended: can be
            specified to make sure the underlying appointment was not changed
            since it was retreived; leave blank when creating an appointment)
          example: 5678
        patientId:
          type: integer
          format: int32
          description: Patient ID (from the list returned for the user)
          example: 12345
        profileId:
          type: integer
          format: int32
          description: >-
            Profile ID (identifies the provider with whom the appointment is
            being made)
          example: 1234
        locationId:
          type: integer
          format: int32
          description: Location ID (location must agree with the specified profile)
          example: 1234
        speciality:
          type: string
          description: >-
            Profile specialty (optional, but becomes mandatory on creation if
            the profile has multiple allowed specialties; the specialty of the
            appointment cannot be changed)
          enum:
            - GENERAL
            - DENTIST
            - ORTHOPEDIST
            - PEDIATRICIAN
            - GYNECOLOGIST
            - PULMONOLOGIST
            - GASTROENTEROLOGIST
            - OPHTALMOLOGIST
            - DERMATOLOGIST
            - NEUROLOGIST
            - ENT
            - PSYCHIATRIST
            - CARDIOLOGIST
            - UROLOGIST
            - ALTERNATIVE
            - OTHER
            - EMERGENCY
            - MORE
            - MASSEUSE
            - ONCOLOGIST
            - SURGEON
            - INTERNIST
            - HEMATOLOGIST
            - NEPHROLOGIST
            - RHEUMATOLOGIST
            - GERIATRICIAN
            - ALLERGOLOGIST
            - ONLINE_DOCTOR
            - IMAGING
            - LABS
          example: DERMATOLOGIST
        caseId:
          type: integer
          format: int32
          description: >-
            Case ID (case associated with this appointment; created
            automatically or manually before creating the appointment)
          example: 1234
        promoCodeId:
          type: integer
          format: int32
          description: Optional; Promo code ID to be applied to the appointment
          example: 1234
        status:
          type: string
          description: Appointment status
          enum:
            - PROPOSED
            - REQUESTED
            - DOCTOR_REFUSED_REQUEST
            - REQUEST_EXPIRED
            - PATIENT_CANCELLED_REQUEST
            - ALTERNATIVE_OFFERED
            - PATIENT_REFUSED_OFFER
            - OFFER_EXPIRED
            - DOCTOR_CANCELLED_OFFER
            - APPOINTMENT_SCHEDULED
            - AUTOMATICALLY_CANCELLED
            - DOCTOR_CANCELLED_APPOINTMENT
            - PATIENT_CANCELLED_APPOINTMENT
            - VISIT_TOOK_PLACE
            - APPOINTMENT_CLOSED
            - PAYMENT_FAILED
            - NO_SHOW
            - CS_CANCELLED_REQUEST
            - CS_CANCELLED_OFFER
            - CS_CANCELLED_APPOINTMENT
            - CS_OFFER
            - LATE_CANCELLATION
            - HOLD_FEE
            - HOLD_FAILED
            - INSURER_CANCELLED_APPOINTMENT
            - CANCELLED_DUE_TO_HOLD_FAILURE
            - ADDITIONAL_ALTERNATIVE_OFFERED
            - CLAIM_OPEN
            - CLAIM_CLARIFICATION
            - CLAIM_READY_FOR_PAYMENT
            - CLAIM_INTERNALLY_PAID
            - CLAIM_SEND_TO_INSURER
            - CLAIM_SUBMITTED_TO_INSURER
            - CLAIM_CANCELED
          example: REQUESTED
        minutesToExpiration:
          type: integer
          format: int32
          description: >-
            Minutes left until the current appointment status expires (cannot be
            changed, except by customer support team)
          example: 57
        scheduledTimestamp:
          type: string
          format: date-time
          description: >-
            Scheduled time of the appointment in appointment time zone
            (profile's time zone for clinic and home visits; patient's time zone
            for patient-side video visits)
          example: 2020-07-29T16:30
        careOf:
          type: string
          description: A person responsible for the patient (useful for minors)
          example: Vivian Smith
        passportNumber:
          type: string
          description: Passport number of patient
        passportCountryEnum:
          type: string
          description: Passport country of patient
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
        passportIssueDate:
          type: string
          format: date
          description: Passport issue date of patient
        homeAddressInHomeCountry:
          type: string
          description: Patient home address in home country
        email:
          type: string
          description: Patient's email address
          example: someone@example.com
        phone:
          type: string
          description: Patient's contact phone number
          example: '+15467383892'
        notes:
          type: string
          description: Problem description to be provided by the patient
          example: Meesa don't feel so good...
        city:
          type: string
          description: For home visits, city of the visit
          example: London
        state:
          type: string
          description: For home visits, the state of the country of the visit
          enum:
            - US_AL
            - US_AK
            - US_AZ
            - US_AR
            - US_CA
            - US_CO
            - US_CT
            - US_DE
            - US_DC
            - US_FL
            - US_GA
            - US_HI
            - US_ID
            - US_IL
            - US_IN
            - US_IA
            - US_KS
            - US_KY
            - US_LA
            - US_ME
            - US_MD
            - US_MA
            - US_MI
            - US_MN
            - US_MS
            - US_MO
            - US_MT
            - US_NE
            - US_NV
            - US_NH
            - US_NJ
            - US_NM
            - US_NY
            - US_NC
            - US_ND
            - US_OH
            - US_OK
            - US_OR
            - US_PA
            - US_RI
            - US_SC
            - US_SD
            - US_TN
            - US_TX
            - US_UT
            - US_VT
            - US_VA
            - US_WA
            - US_WV
            - US_WI
            - US_WY
            - DE_BW
            - DE_BY
            - DE_BE
            - DE_BB
            - DE_HB
            - DE_HH
            - DE_HE
            - DE_MV
            - DE_NI
            - DE_NW
            - DE_RP
            - DE_SL
            - DE_SN
            - DE_ST
            - DE_SH
            - DE_TH
            - CA_AB
            - CA_BC
            - CA_MB
            - CA_NB
            - CA_NL
            - CA_NT
            - CA_NS
            - CA_NU
            - CA_ON
            - CA_PE
            - CA_QC
            - CA_SK
            - CA_YT
            - IN_AN
            - IN_AP
            - IN_AR
            - IN_AS
            - IN_BR
            - IN_CH
            - IN_CG
            - IN_DH
            - IN_DL
            - IN_GA
            - IN_GJ
            - IN_HR
            - IN_HP
            - IN_JK
            - IN_JH
            - IN_KA
            - IN_KL
            - IN_LA
            - IN_LD
            - IN_MP
            - IN_MH
            - IN_MN
            - IN_ML
            - IN_MZ
            - IN_NL
            - IN_OD
            - IN_PY
            - IN_PB
            - IN_RJ
            - IN_SK
            - IN_TN
            - IN_TS
            - IN_TR
            - IN_UP
            - IN_UK
            - IN_WB
            - AU_NSW
            - AU_QLD
            - AU_SA
            - AU_TAS
            - AU_VIC
            - AU_WA
            - AU_ACT
            - AU_NT
            - CH_ZH
            - CH_BE
            - CH_LU
            - CH_UR
            - CH_SZ
            - CH_OW
            - CH_NW
            - CH_GL
            - CH_ZG
            - CH_FR
            - CH_SO
            - CH_BS
            - CH_BL
            - CH_SH
            - CH_AR
            - CH_AI
            - CH_SG
            - CH_GR
            - CH_AG
            - CH_TG
            - CH_TI
            - CH_VD
            - CH_VS
            - CH_NE
            - CH_GE
            - CH_JU
            - BR_AC
            - BR_AL
            - BR_AM
            - BR_AP
            - BR_BA
            - BR_CE
            - BR_DF
            - BR_ES
            - BR_GO
            - BR_MA
            - BR_MG
            - BR_MS
            - BR_MT
            - BR_PA
            - BR_PB
            - BR_PE
            - BR_PI
            - BR_PR
            - BR_RJ
            - BR_RN
            - BR_RO
            - BR_RR
            - BR_RS
            - BR_SC
            - BR_SE
            - BR_SP
            - BR_TO
          example: AZ
        postalCode:
          type: string
          description: For home visits, postal code of the address for the visit
          example: W3 6RT
        street:
          type: string
          description: For home visits, street of the address for the visit
          example: Camden St
        streetNumber:
          type: string
          description: For home visits, street number of the address for the visit
          example: 11B
        buildingName:
          type: string
          description: For home visits, building name of the address for the visit
          example: The Ritz Carlton, New York
        floor:
          type: string
          description: For home visits, floor within the residence at the visit's location
          example: 3
        apartment:
          type: string
          description: For home visits, apartment or room number at the visit's location
          example: 315
        notesHomeAddress:
          type: string
          description: >-
            Patient address of accommodation or For home visits, additional
            instruction how to enter patient location
          example: Entrance is on the opposite side
        latitude:
          type: number
          format: double
          description: For home visits, latitude of visit's location
          example: 51.507351
        longitude:
          type: number
          format: double
          description: For home visits, longitude of visit's location
          example: -0.127758
        paymentStatus:
          type: string
          description: Designated appointment payment status
          enum:
            - WRITE_OFF
            - CASH_DIRECT
            - PAID_PRIVATELY
            - PREPAYMENT
            - EXCESS
            - COVERED
          example: PREPAYMENT
        chunkStatus:
          type: string
          description: Designated appointment chunk status
          enum:
            - HIDE
            - SHOW_BLOCK
            - ASSISTANCE
            - PAY
            - PREPAYMENT
            - CC_BACKUP
            - COVERED
            - PAY_UNDER_INSURER
          example: PREPAYMENT
        followUpType:
          type: string
          description: Indicates whether the appointment is a follow-up
          enum:
            - REGULAR
            - PAID_FOLLOW_UP
            - FREE_FOLLOW_UP
          example: PAID_FOLLOW_UP
        appointmentFeeNet:
          type: number
          format: double
          description: Appointment net fee (privileged)
          example: 240
        appointmentExtraFlatCommission:
          type: number
          format: double
          description: Appointment extra flat commission (privileged)
          example: 240
        photos:
          type: array
          description: Photos attached to this appointment
          items:
            $ref: '#/components/schemas/PhotoDto'
        extras:
          type: array
          description: >-
            Extra payments for this appointment. Privileged; might not be
            provided
          items:
            $ref: '#/components/schemas/AppointmentExtraDto'
        event:
          $ref: '#/components/schemas/EventDto'
          description: >-
            Event associated with this appointment; on GET only the following
            fields are filled: time stamp, type, public note and initiator ID (0
            for profile, -1 for customer support department, -2 system
            automation,  patient's Subscriber ID otherwise)
        demandNumber:
          type: string
          description: Appointment insurance demand number (if needed)
          example: F73289-G9
        voucherNumber:
          type: string
          description: Insurance visit voucher number (if needed)
          example: Q5789324841209PL
        voucherStatus:
          type: string
          description: Status of the voucher (if needed)
          enum:
            - MISSING
            - VALID
            - EXPIRED
            - CANCELLED
            - DECLINED
          example: VALID
        voucherExpirationDate:
          type: string
          format: date
          description: >-
            The day on which the voucher expires(the voucher becomes expired the
            next day)
          example: '2021-12-31'
        requestedTime:
          type: string
          description: >-
            Appointment time preference (only for manually allocated
            appointments)
        claimDetails:
          $ref: '#/components/schemas/ClaimDetailsDto'
          description: >-
            Insurance claim extra details (only present and can be specified for
            claims, not system-managed appointments)
        profileNotes:
          type: string
          description: Clinic notes about appointment
          example: Requires additional appointment
        hmoEnum:
          type: string
          description: Health Maintenance Organization
          enum:
            - CLALIT
            - MACCABI
            - MEHUHEDET
            - LEUMIT
            - OTHER
        appointmentOrigin:
          type: string
          description: Appointment origin
          enum:
            - REGULAR
            - FIRST_SERVE
            - CLINIC_DIRECT
            - VIDEO_GROUP
            - VIDEO_GROUP_ONE_CLICK
            - BOTH_OFFLINE_GROUP
            - HOME_OFFLINE_GROUP
            - CLINIC_OFFLINE_GROUP
            - BOTH_OFFLINE_GROUP_BY_SYSTEM
            - HOME_OFFLINE_GROUP_BY_SYSTEM
            - CLINIC_OFFLINE_GROUP_BY_SYSTEM
          example: CLINIC_DIRECT
        dispatchTo:
          type: string
          description: Doctor who get appointment from dispatcher
          example: Dr. Hippocrates
        medicationsInUseStatus:
          type: string
          description: Whether the patient provided a description of the medications in use
          enum:
            - STATUS_UNKNOWN
            - MEDICATIONS_TAKEN
            - NO_MEDICATIONS_TAKEN
        medicationsInUse:
          type: string
          description: Medications taken on regular basis
          example: Some pills..
        interpreterLanguage:
          type: string
          description: Language of requested interpreter
          enum:
            - AA
            - AB
            - AE
            - AF
            - AK
            - AM
            - AN
            - AR
            - AS
            - AV
            - AY
            - AZ
            - BA
            - BE
            - BG
            - BH
            - BI
            - BM
            - BN
            - BO
            - BR
            - BS
            - CA
            - CE
            - CH
            - CO
            - CR
            - CS
            - CU
            - CV
            - CY
            - DA
            - DE
            - DV
            - DZ
            - EE
            - EL
            - EN
            - EO
            - ES
            - ET
            - EU
            - FA
            - FF
            - FI
            - FJ
            - FO
            - FR
            - FY
            - GA
            - GD
            - GL
            - GN
            - GU
            - GV
            - HA
            - HE
            - HI
            - HO
            - HR
            - HT
            - HU
            - HY
            - HZ
            - IA
            - ID
            - IE
            - IG
            - II
            - IK
            - IO
            - IS
            - IT
            - IU
            - JA
            - JV
            - KA
            - KG
            - KI
            - KJ
            - KK
            - KL
            - KM
            - KN
            - KO
            - KR
            - KS
            - KU
            - KV
            - KW
            - KY
            - LA
            - LB
            - LG
            - LI
            - LN
            - LO
            - LT
            - LU
            - LV
            - MG
            - MH
            - MI
            - MK
            - ML
            - MN
            - MR
            - MS
            - MT
            - MY
            - NA
            - NB
            - ND
            - NE
            - NG
            - NL
            - NN
            - 'NO'
            - NR
            - NV
            - NY
            - OC
            - OJ
            - OM
            - OR
            - OS
            - PA
            - PI
            - PL
            - PS
            - PT
            - QU
            - RM
            - RN
            - RO
            - RU
            - RW
            - SA
            - SC
            - SD
            - SE
            - SG
            - SI
            - SK
            - SL
            - SM
            - SN
            - SO
            - SQ
            - SR
            - SS
            - ST
            - SU
            - SV
            - SW
            - TA
            - TE
            - TG
            - TH
            - TI
            - TK
            - TL
            - TN
            - TO
            - TR
            - TS
            - TT
            - TW
            - TY
            - UG
            - UK
            - UR
            - UZ
            - VE
            - VI
            - VO
            - WA
            - WO
            - XH
            - YI
            - YO
            - ZA
            - ZH
            - YUE
            - ZU
          example: EN
        languages:
          type: array
          description: List of preferred appointment languages
          items:
            type: string
            enum:
              - AA
              - AB
              - AE
              - AF
              - AK
              - AM
              - AN
              - AR
              - AS
              - AV
              - AY
              - AZ
              - BA
              - BE
              - BG
              - BH
              - BI
              - BM
              - BN
              - BO
              - BR
              - BS
              - CA
              - CE
              - CH
              - CO
              - CR
              - CS
              - CU
              - CV
              - CY
              - DA
              - DE
              - DV
              - DZ
              - EE
              - EL
              - EN
              - EO
              - ES
              - ET
              - EU
              - FA
              - FF
              - FI
              - FJ
              - FO
              - FR
              - FY
              - GA
              - GD
              - GL
              - GN
              - GU
              - GV
              - HA
              - HE
              - HI
              - HO
              - HR
              - HT
              - HU
              - HY
              - HZ
              - IA
              - ID
              - IE
              - IG
              - II
              - IK
              - IO
              - IS
              - IT
              - IU
              - JA
              - JV
              - KA
              - KG
              - KI
              - KJ
              - KK
              - KL
              - KM
              - KN
              - KO
              - KR
              - KS
              - KU
              - KV
              - KW
              - KY
              - LA
              - LB
              - LG
              - LI
              - LN
              - LO
              - LT
              - LU
              - LV
              - MG
              - MH
              - MI
              - MK
              - ML
              - MN
              - MR
              - MS
              - MT
              - MY
              - NA
              - NB
              - ND
              - NE
              - NG
              - NL
              - NN
              - 'NO'
              - NR
              - NV
              - NY
              - OC
              - OJ
              - OM
              - OR
              - OS
              - PA
              - PI
              - PL
              - PS
              - PT
              - QU
              - RM
              - RN
              - RO
              - RU
              - RW
              - SA
              - SC
              - SD
              - SE
              - SG
              - SI
              - SK
              - SL
              - SM
              - SN
              - SO
              - SQ
              - SR
              - SS
              - ST
              - SU
              - SV
              - SW
              - TA
              - TE
              - TG
              - TH
              - TI
              - TK
              - TL
              - TN
              - TO
              - TR
              - TS
              - TT
              - TW
              - TY
              - UG
              - UK
              - UR
              - UZ
              - VE
              - VI
              - VO
              - WA
              - WO
              - XH
              - YI
              - YO
              - ZA
              - ZH
              - YUE
              - ZU
        requestPreference:
          type: string
          description: >-
            Indicates that the user prefers a doctor capable of providing
            prescription, rather than speaking the language
          enum:
            - PRESCRIPTION
            - LANGUAGE
            - INTERPRETER_REQUESTED
            - WITHOUT_INTERPRETER
        patientCountry:
          type: string
          description: >-
            Preference country (used to determine whether prescription is
            possible)
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
        suggestedCountry:
          type: string
          description: Country in which the patient suggest the appointment
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
        preferredData:
          type: string
          format: date
          description: Data which was selected in filter by patient
        preferredGender:
          type: string
          description: Genders which were selected in filter by patient
          enum:
            - MALE
            - FEMALE
            - BOTH
            - OTHER
        creationDelaySeconds:
          type: integer
          format: int32
          description: Delay to create suggestion (seconds)
        locationType:
          type: string
          description: Requested appointment type
          enum:
            - HOME_VISIT
            - CLINIC_VISIT
            - VIDEO_VISIT
      title: Appointment with an automatically suggested video doctors request record
    VideoVisitTokenDto:
      type: object
      description: Video services are provided by Twilio; this is Twilio's token
      properties:
        token:
          type: string
          description: Token with which the user can connect to the video visit
          example: >-
            ecdc0dec1234c56789012cde3c4ed567c8d9e0c1d2e3cd4de5c67de89c0ed12ecd34fa56789
      title: Token for a video appointment
    AppointmentHookDto:
      type: object
      description: >-
        This structure is the format provided to Air Doctor partners, who wish
        to register for web hooks
      properties:
        appointmentId:
          type: integer
          format: int32
          description: Unique appointment ID (leave blank when creating an appointment)
          example: 1234
        appointmentRevisionId:
          type: integer
          format: int32
          description: >-
            Unique appointment revision ID (optional, but recommended: can be
            specified to make sure the underlying appointment was not changed
            since it was retreived; leave blank when creating an appointment)
          example: 5678
        patientId:
          type: integer
          format: int32
          description: Patient ID (from the list returned for the user)
          example: 12345
        profileId:
          type: integer
          format: int32
          description: >-
            Profile ID (identifies the provider with whom the appointment is
            being made)
          example: 1234
        locationId:
          type: integer
          format: int32
          description: Location ID (location must agree with the specified profile)
          example: 1234
        speciality:
          type: string
          description: >-
            Profile specialty (optional, but becomes mandatory on creation if
            the profile has multiple allowed specialties; the specialty of the
            appointment cannot be changed)
          enum:
            - GENERAL
            - DENTIST
            - ORTHOPEDIST
            - PEDIATRICIAN
            - GYNECOLOGIST
            - PULMONOLOGIST
            - GASTROENTEROLOGIST
            - OPHTALMOLOGIST
            - DERMATOLOGIST
            - NEUROLOGIST
            - ENT
            - PSYCHIATRIST
            - CARDIOLOGIST
            - UROLOGIST
            - ALTERNATIVE
            - OTHER
            - EMERGENCY
            - MORE
            - MASSEUSE
            - ONCOLOGIST
            - SURGEON
            - INTERNIST
            - HEMATOLOGIST
            - NEPHROLOGIST
            - RHEUMATOLOGIST
            - GERIATRICIAN
            - ALLERGOLOGIST
            - ONLINE_DOCTOR
            - IMAGING
            - LABS
          example: DERMATOLOGIST
        caseId:
          type: integer
          format: int32
          description: >-
            Case ID (case associated with this appointment; created
            automatically or manually before creating the appointment)
          example: 1234
        promoCodeId:
          type: integer
          format: int32
          description: Optional; Promo code ID to be applied to the appointment
          example: 1234
        status:
          type: string
          description: Appointment status
          enum:
            - PROPOSED
            - REQUESTED
            - DOCTOR_REFUSED_REQUEST
            - REQUEST_EXPIRED
            - PATIENT_CANCELLED_REQUEST
            - ALTERNATIVE_OFFERED
            - PATIENT_REFUSED_OFFER
            - OFFER_EXPIRED
            - DOCTOR_CANCELLED_OFFER
            - APPOINTMENT_SCHEDULED
            - AUTOMATICALLY_CANCELLED
            - DOCTOR_CANCELLED_APPOINTMENT
            - PATIENT_CANCELLED_APPOINTMENT
            - VISIT_TOOK_PLACE
            - APPOINTMENT_CLOSED
            - PAYMENT_FAILED
            - NO_SHOW
            - CS_CANCELLED_REQUEST
            - CS_CANCELLED_OFFER
            - CS_CANCELLED_APPOINTMENT
            - CS_OFFER
            - LATE_CANCELLATION
            - HOLD_FEE
            - HOLD_FAILED
            - INSURER_CANCELLED_APPOINTMENT
            - CANCELLED_DUE_TO_HOLD_FAILURE
            - ADDITIONAL_ALTERNATIVE_OFFERED
            - CLAIM_OPEN
            - CLAIM_CLARIFICATION
            - CLAIM_READY_FOR_PAYMENT
            - CLAIM_INTERNALLY_PAID
            - CLAIM_SEND_TO_INSURER
            - CLAIM_SUBMITTED_TO_INSURER
            - CLAIM_CANCELED
          example: REQUESTED
        minutesToExpiration:
          type: integer
          format: int32
          description: >-
            Minutes left until the current appointment status expires (cannot be
            changed, except by customer support team)
          example: 57
        scheduledTimestamp:
          type: string
          format: date-time
          description: >-
            Scheduled time of the appointment in appointment time zone
            (profile's time zone for clinic and home visits; patient's time zone
            for patient-side video visits)
          example: 2020-07-29T16:30
        careOf:
          type: string
          description: A person responsible for the patient (useful for minors)
          example: Vivian Smith
        passportNumber:
          type: string
          description: Passport number of patient
        passportCountryEnum:
          type: string
          description: Passport country of patient
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
        passportIssueDate:
          type: string
          format: date
          description: Passport issue date of patient
        homeAddressInHomeCountry:
          type: string
          description: Patient home address in home country
        email:
          type: string
          description: Patient's email address
          example: someone@example.com
        phone:
          type: string
          description: Patient's contact phone number
          example: '+15467383892'
        notes:
          type: string
          description: Problem description to be provided by the patient
          example: Meesa don't feel so good...
        city:
          type: string
          description: For home visits, city of the visit
          example: London
        state:
          type: string
          description: For home visits, the state of the country of the visit
          enum:
            - US_AL
            - US_AK
            - US_AZ
            - US_AR
            - US_CA
            - US_CO
            - US_CT
            - US_DE
            - US_DC
            - US_FL
            - US_GA
            - US_HI
            - US_ID
            - US_IL
            - US_IN
            - US_IA
            - US_KS
            - US_KY
            - US_LA
            - US_ME
            - US_MD
            - US_MA
            - US_MI
            - US_MN
            - US_MS
            - US_MO
            - US_MT
            - US_NE
            - US_NV
            - US_NH
            - US_NJ
            - US_NM
            - US_NY
            - US_NC
            - US_ND
            - US_OH
            - US_OK
            - US_OR
            - US_PA
            - US_RI
            - US_SC
            - US_SD
            - US_TN
            - US_TX
            - US_UT
            - US_VT
            - US_VA
            - US_WA
            - US_WV
            - US_WI
            - US_WY
            - DE_BW
            - DE_BY
            - DE_BE
            - DE_BB
            - DE_HB
            - DE_HH
            - DE_HE
            - DE_MV
            - DE_NI
            - DE_NW
            - DE_RP
            - DE_SL
            - DE_SN
            - DE_ST
            - DE_SH
            - DE_TH
            - CA_AB
            - CA_BC
            - CA_MB
            - CA_NB
            - CA_NL
            - CA_NT
            - CA_NS
            - CA_NU
            - CA_ON
            - CA_PE
            - CA_QC
            - CA_SK
            - CA_YT
            - IN_AN
            - IN_AP
            - IN_AR
            - IN_AS
            - IN_BR
            - IN_CH
            - IN_CG
            - IN_DH
            - IN_DL
            - IN_GA
            - IN_GJ
            - IN_HR
            - IN_HP
            - IN_JK
            - IN_JH
            - IN_KA
            - IN_KL
            - IN_LA
            - IN_LD
            - IN_MP
            - IN_MH
            - IN_MN
            - IN_ML
            - IN_MZ
            - IN_NL
            - IN_OD
            - IN_PY
            - IN_PB
            - IN_RJ
            - IN_SK
            - IN_TN
            - IN_TS
            - IN_TR
            - IN_UP
            - IN_UK
            - IN_WB
            - AU_NSW
            - AU_QLD
            - AU_SA
            - AU_TAS
            - AU_VIC
            - AU_WA
            - AU_ACT
            - AU_NT
            - CH_ZH
            - CH_BE
            - CH_LU
            - CH_UR
            - CH_SZ
            - CH_OW
            - CH_NW
            - CH_GL
            - CH_ZG
            - CH_FR
            - CH_SO
            - CH_BS
            - CH_BL
            - CH_SH
            - CH_AR
            - CH_AI
            - CH_SG
            - CH_GR
            - CH_AG
            - CH_TG
            - CH_TI
            - CH_VD
            - CH_VS
            - CH_NE
            - CH_GE
            - CH_JU
            - BR_AC
            - BR_AL
            - BR_AM
            - BR_AP
            - BR_BA
            - BR_CE
            - BR_DF
            - BR_ES
            - BR_GO
            - BR_MA
            - BR_MG
            - BR_MS
            - BR_MT
            - BR_PA
            - BR_PB
            - BR_PE
            - BR_PI
            - BR_PR
            - BR_RJ
            - BR_RN
            - BR_RO
            - BR_RR
            - BR_RS
            - BR_SC
            - BR_SE
            - BR_SP
            - BR_TO
          example: AZ
        postalCode:
          type: string
          description: For home visits, postal code of the address for the visit
          example: W3 6RT
        street:
          type: string
          description: For home visits, street of the address for the visit
          example: Camden St
        streetNumber:
          type: string
          description: For home visits, street number of the address for the visit
          example: 11B
        buildingName:
          type: string
          description: For home visits, building name of the address for the visit
          example: The Ritz Carlton, New York
        floor:
          type: string
          description: For home visits, floor within the residence at the visit's location
          example: 3
        apartment:
          type: string
          description: For home visits, apartment or room number at the visit's location
          example: 315
        notesHomeAddress:
          type: string
          description: >-
            Patient address of accommodation or For home visits, additional
            instruction how to enter patient location
          example: Entrance is on the opposite side
        latitude:
          type: number
          format: double
          description: For home visits, latitude of visit's location
          example: 51.507351
        longitude:
          type: number
          format: double
          description: For home visits, longitude of visit's location
          example: -0.127758
        paymentStatus:
          type: string
          description: Designated appointment payment status
          enum:
            - WRITE_OFF
            - CASH_DIRECT
            - PAID_PRIVATELY
            - PREPAYMENT
            - EXCESS
            - COVERED
          example: PREPAYMENT
        chunkStatus:
          type: string
          description: Designated appointment chunk status
          enum:
            - HIDE
            - SHOW_BLOCK
            - ASSISTANCE
            - PAY
            - PREPAYMENT
            - CC_BACKUP
            - COVERED
            - PAY_UNDER_INSURER
          example: PREPAYMENT
        followUpType:
          type: string
          description: Indicates whether the appointment is a follow-up
          enum:
            - REGULAR
            - PAID_FOLLOW_UP
            - FREE_FOLLOW_UP
          example: PAID_FOLLOW_UP
        appointmentFeeNet:
          type: number
          format: double
          description: Appointment net fee (privileged)
          example: 240
        appointmentExtraFlatCommission:
          type: number
          format: double
          description: Appointment extra flat commission (privileged)
          example: 240
        photos:
          type: array
          description: Photos attached to this appointment
          items:
            $ref: '#/components/schemas/PhotoDto'
        extras:
          type: array
          description: >-
            Extra payments for this appointment. Privileged; might not be
            provided
          items:
            $ref: '#/components/schemas/AppointmentExtraDto'
        event:
          $ref: '#/components/schemas/EventDto'
          description: >-
            Event associated with this appointment; on GET only the following
            fields are filled: time stamp, type, public note and initiator ID (0
            for profile, -1 for customer support department, -2 system
            automation,  patient's Subscriber ID otherwise)
        demandNumber:
          type: string
          description: Appointment insurance demand number (if needed)
          example: F73289-G9
        voucherNumber:
          type: string
          description: Insurance visit voucher number (if needed)
          example: Q5789324841209PL
        voucherStatus:
          type: string
          description: Status of the voucher (if needed)
          enum:
            - MISSING
            - VALID
            - EXPIRED
            - CANCELLED
            - DECLINED
          example: VALID
        voucherExpirationDate:
          type: string
          format: date
          description: >-
            The day on which the voucher expires(the voucher becomes expired the
            next day)
          example: '2021-12-31'
        requestedTime:
          type: string
          description: >-
            Appointment time preference (only for manually allocated
            appointments)
        claimDetails:
          $ref: '#/components/schemas/ClaimDetailsDto'
          description: >-
            Insurance claim extra details (only present and can be specified for
            claims, not system-managed appointments)
        profileNotes:
          type: string
          description: Clinic notes about appointment
          example: Requires additional appointment
        hmoEnum:
          type: string
          description: Health Maintenance Organization
          enum:
            - CLALIT
            - MACCABI
            - MEHUHEDET
            - LEUMIT
            - OTHER
        appointmentOrigin:
          type: string
          description: Appointment origin
          enum:
            - REGULAR
            - FIRST_SERVE
            - CLINIC_DIRECT
            - VIDEO_GROUP
            - VIDEO_GROUP_ONE_CLICK
            - BOTH_OFFLINE_GROUP
            - HOME_OFFLINE_GROUP
            - CLINIC_OFFLINE_GROUP
            - BOTH_OFFLINE_GROUP_BY_SYSTEM
            - HOME_OFFLINE_GROUP_BY_SYSTEM
            - CLINIC_OFFLINE_GROUP_BY_SYSTEM
          example: CLINIC_DIRECT
        dispatchTo:
          type: string
          description: Doctor who get appointment from dispatcher
          example: Dr. Hippocrates
        medicationsInUseStatus:
          type: string
          description: Whether the patient provided a description of the medications in use
          enum:
            - STATUS_UNKNOWN
            - MEDICATIONS_TAKEN
            - NO_MEDICATIONS_TAKEN
        medicationsInUse:
          type: string
          description: Medications taken on regular basis
          example: Some pills..
        interpreterLanguage:
          type: string
          description: Language of requested interpreter
          enum:
            - AA
            - AB
            - AE
            - AF
            - AK
            - AM
            - AN
            - AR
            - AS
            - AV
            - AY
            - AZ
            - BA
            - BE
            - BG
            - BH
            - BI
            - BM
            - BN
            - BO
            - BR
            - BS
            - CA
            - CE
            - CH
            - CO
            - CR
            - CS
            - CU
            - CV
            - CY
            - DA
            - DE
            - DV
            - DZ
            - EE
            - EL
            - EN
            - EO
            - ES
            - ET
            - EU
            - FA
            - FF
            - FI
            - FJ
            - FO
            - FR
            - FY
            - GA
            - GD
            - GL
            - GN
            - GU
            - GV
            - HA
            - HE
            - HI
            - HO
            - HR
            - HT
            - HU
            - HY
            - HZ
            - IA
            - ID
            - IE
            - IG
            - II
            - IK
            - IO
            - IS
            - IT
            - IU
            - JA
            - JV
            - KA
            - KG
            - KI
            - KJ
            - KK
            - KL
            - KM
            - KN
            - KO
            - KR
            - KS
            - KU
            - KV
            - KW
            - KY
            - LA
            - LB
            - LG
            - LI
            - LN
            - LO
            - LT
            - LU
            - LV
            - MG
            - MH
            - MI
            - MK
            - ML
            - MN
            - MR
            - MS
            - MT
            - MY
            - NA
            - NB
            - ND
            - NE
            - NG
            - NL
            - NN
            - 'NO'
            - NR
            - NV
            - NY
            - OC
            - OJ
            - OM
            - OR
            - OS
            - PA
            - PI
            - PL
            - PS
            - PT
            - QU
            - RM
            - RN
            - RO
            - RU
            - RW
            - SA
            - SC
            - SD
            - SE
            - SG
            - SI
            - SK
            - SL
            - SM
            - SN
            - SO
            - SQ
            - SR
            - SS
            - ST
            - SU
            - SV
            - SW
            - TA
            - TE
            - TG
            - TH
            - TI
            - TK
            - TL
            - TN
            - TO
            - TR
            - TS
            - TT
            - TW
            - TY
            - UG
            - UK
            - UR
            - UZ
            - VE
            - VI
            - VO
            - WA
            - WO
            - XH
            - YI
            - YO
            - ZA
            - ZH
            - YUE
            - ZU
          example: EN
        pastRevisions:
          type: array
          description: >-
            List of previous appointment revisions (earlier revision will be the
            last in the list; latest revision will be the first; nested records
            will not have this property set). Privileged; might not be provided
          items:
            $ref: '#/components/schemas/AppointmentGetDto'
        patient:
          $ref: '#/components/schemas/PatientDto'
          description: Explicit patient details
        groupId:
          type: integer
          format: int32
          description: >-
            Group ID (the same value will be provided for all appointments in a
            group created by a suggestion all; zero for appointments not
            belonging to a group)
          example: 1234
        scheduledLocalTimestamp:
          type: string
          format: date-time
          description: >-
            Scheduled date and time of the appointment, according to the current
            user's local time
          example: 2020-07-29T18:30
        scheduledProfileTimestamp:
          type: string
          format: date-time
          description: >-
            Scheduled date and time of the appointment, always according to the
            profile's local time
          example: 2020-07-29T16:30
        scheduledPatientTimestamp:
          type: string
          format: date-time
          description: >-
            Scheduled date and time of the appointment, always according to the
            patient's local time
          example: 2020-07-29T15:30
        appointmentFee:
          type: number
          format: double
          description: >-
            Appointment basic fee (can only be changed by a profile and only in
            some circumstances) (privileged)
          example: 240
        excessAmount:
          type: number
          format: double
          description: Excess (deductible) amount of the appointment
          example: 40
        excessCurrency:
          type: string
          description: Excess currency
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
          example: EUR
        appointmentCurrency:
          type: string
          description: Appointment currency (based on the profile's currency)
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
          example: USD
        promoCode:
          $ref: '#/components/schemas/PromoCodeDto'
          description: Explicit promo code details
        appointmentType:
          type: string
          description: Appointment type (urgent equates to off hours)
          enum:
            - VIDEO_VISIT
            - REGULAR_CLINIC
            - URGENT_CLINIC
            - REGULAR_HOME
            - URGENT_HOME
          example: URGENT_HOME
        reviewRating:
          type: integer
          format: int32
          description: If the patient rated the visit, the rating given (-1 through 10)
          example: 9
        doctorReviewRating:
          type: integer
          format: int32
          description: If the patient rated the visit, the rating given (-1 through 10)
          example: 9
        reviewText:
          type: string
          description: If the patient rated the visit, the review text provided
          example: Almost perfect!
        applicationReviewRating:
          type: integer
          format: int32
          description: >-
            If the patient rated the application after visit, the given (-1
            thought 10)
          example: 9
        invoices:
          type: array
          description: >-
            List of the appointment related invoices. Privileged; may not all
            come in
          items:
            $ref: '#/components/schemas/AppointmentInvoiceDto'
        appointmentCountry:
          type: string
          description: Appointment country when appointment was created
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
        appointmentSearchedCountry:
          type: string
          description: Manually typed country while making the appointment
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
        appointmentState:
          type: string
          description: Appointment state when appointment was created
          enum:
            - US_AL
            - US_AK
            - US_AZ
            - US_AR
            - US_CA
            - US_CO
            - US_CT
            - US_DE
            - US_DC
            - US_FL
            - US_GA
            - US_HI
            - US_ID
            - US_IL
            - US_IN
            - US_IA
            - US_KS
            - US_KY
            - US_LA
            - US_ME
            - US_MD
            - US_MA
            - US_MI
            - US_MN
            - US_MS
            - US_MO
            - US_MT
            - US_NE
            - US_NV
            - US_NH
            - US_NJ
            - US_NM
            - US_NY
            - US_NC
            - US_ND
            - US_OH
            - US_OK
            - US_OR
            - US_PA
            - US_RI
            - US_SC
            - US_SD
            - US_TN
            - US_TX
            - US_UT
            - US_VT
            - US_VA
            - US_WA
            - US_WV
            - US_WI
            - US_WY
            - DE_BW
            - DE_BY
            - DE_BE
            - DE_BB
            - DE_HB
            - DE_HH
            - DE_HE
            - DE_MV
            - DE_NI
            - DE_NW
            - DE_RP
            - DE_SL
            - DE_SN
            - DE_ST
            - DE_SH
            - DE_TH
            - CA_AB
            - CA_BC
            - CA_MB
            - CA_NB
            - CA_NL
            - CA_NT
            - CA_NS
            - CA_NU
            - CA_ON
            - CA_PE
            - CA_QC
            - CA_SK
            - CA_YT
            - IN_AN
            - IN_AP
            - IN_AR
            - IN_AS
            - IN_BR
            - IN_CH
            - IN_CG
            - IN_DH
            - IN_DL
            - IN_GA
            - IN_GJ
            - IN_HR
            - IN_HP
            - IN_JK
            - IN_JH
            - IN_KA
            - IN_KL
            - IN_LA
            - IN_LD
            - IN_MP
            - IN_MH
            - IN_MN
            - IN_ML
            - IN_MZ
            - IN_NL
            - IN_OD
            - IN_PY
            - IN_PB
            - IN_RJ
            - IN_SK
            - IN_TN
            - IN_TS
            - IN_TR
            - IN_UP
            - IN_UK
            - IN_WB
            - AU_NSW
            - AU_QLD
            - AU_SA
            - AU_TAS
            - AU_VIC
            - AU_WA
            - AU_ACT
            - AU_NT
            - CH_ZH
            - CH_BE
            - CH_LU
            - CH_UR
            - CH_SZ
            - CH_OW
            - CH_NW
            - CH_GL
            - CH_ZG
            - CH_FR
            - CH_SO
            - CH_BS
            - CH_BL
            - CH_SH
            - CH_AR
            - CH_AI
            - CH_SG
            - CH_GR
            - CH_AG
            - CH_TG
            - CH_TI
            - CH_VD
            - CH_VS
            - CH_NE
            - CH_GE
            - CH_JU
            - BR_AC
            - BR_AL
            - BR_AM
            - BR_AP
            - BR_BA
            - BR_CE
            - BR_DF
            - BR_ES
            - BR_GO
            - BR_MA
            - BR_MG
            - BR_MS
            - BR_MT
            - BR_PA
            - BR_PB
            - BR_PE
            - BR_PI
            - BR_PR
            - BR_RJ
            - BR_RN
            - BR_RO
            - BR_RR
            - BR_RS
            - BR_SC
            - BR_SE
            - BR_SP
            - BR_TO
        appointmentSearchedState:
          type: string
          description: Manually typed state while making the appointment
          enum:
            - US_AL
            - US_AK
            - US_AZ
            - US_AR
            - US_CA
            - US_CO
            - US_CT
            - US_DE
            - US_DC
            - US_FL
            - US_GA
            - US_HI
            - US_ID
            - US_IL
            - US_IN
            - US_IA
            - US_KS
            - US_KY
            - US_LA
            - US_ME
            - US_MD
            - US_MA
            - US_MI
            - US_MN
            - US_MS
            - US_MO
            - US_MT
            - US_NE
            - US_NV
            - US_NH
            - US_NJ
            - US_NM
            - US_NY
            - US_NC
            - US_ND
            - US_OH
            - US_OK
            - US_OR
            - US_PA
            - US_RI
            - US_SC
            - US_SD
            - US_TN
            - US_TX
            - US_UT
            - US_VT
            - US_VA
            - US_WA
            - US_WV
            - US_WI
            - US_WY
            - DE_BW
            - DE_BY
            - DE_BE
            - DE_BB
            - DE_HB
            - DE_HH
            - DE_HE
            - DE_MV
            - DE_NI
            - DE_NW
            - DE_RP
            - DE_SL
            - DE_SN
            - DE_ST
            - DE_SH
            - DE_TH
            - CA_AB
            - CA_BC
            - CA_MB
            - CA_NB
            - CA_NL
            - CA_NT
            - CA_NS
            - CA_NU
            - CA_ON
            - CA_PE
            - CA_QC
            - CA_SK
            - CA_YT
            - IN_AN
            - IN_AP
            - IN_AR
            - IN_AS
            - IN_BR
            - IN_CH
            - IN_CG
            - IN_DH
            - IN_DL
            - IN_GA
            - IN_GJ
            - IN_HR
            - IN_HP
            - IN_JK
            - IN_JH
            - IN_KA
            - IN_KL
            - IN_LA
            - IN_LD
            - IN_MP
            - IN_MH
            - IN_MN
            - IN_ML
            - IN_MZ
            - IN_NL
            - IN_OD
            - IN_PY
            - IN_PB
            - IN_RJ
            - IN_SK
            - IN_TN
            - IN_TS
            - IN_TR
            - IN_UP
            - IN_UK
            - IN_WB
            - AU_NSW
            - AU_QLD
            - AU_SA
            - AU_TAS
            - AU_VIC
            - AU_WA
            - AU_ACT
            - AU_NT
            - CH_ZH
            - CH_BE
            - CH_LU
            - CH_UR
            - CH_SZ
            - CH_OW
            - CH_NW
            - CH_GL
            - CH_ZG
            - CH_FR
            - CH_SO
            - CH_BS
            - CH_BL
            - CH_SH
            - CH_AR
            - CH_AI
            - CH_SG
            - CH_GR
            - CH_AG
            - CH_TG
            - CH_TI
            - CH_VD
            - CH_VS
            - CH_NE
            - CH_GE
            - CH_JU
            - BR_AC
            - BR_AL
            - BR_AM
            - BR_AP
            - BR_BA
            - BR_CE
            - BR_DF
            - BR_ES
            - BR_GO
            - BR_MA
            - BR_MG
            - BR_MS
            - BR_MT
            - BR_PA
            - BR_PB
            - BR_PE
            - BR_PI
            - BR_PR
            - BR_RJ
            - BR_RN
            - BR_RO
            - BR_RR
            - BR_RS
            - BR_SC
            - BR_SE
            - BR_SP
            - BR_TO
        canPrescribe:
          type: boolean
          description: Is profile can make a prescription
        profileDetails:
          $ref: '#/components/schemas/AppointmentProfileDto'
          description: Profile's and location's details
        profile:
          $ref: '#/components/schemas/ProfileDto'
          description: The profile with which the appointment is scheduled
        reason:
          type: string
          description: The action that occured that required a call
          enum:
            - STATUS_CHANGE
            - VIDEO_REMINDER
            - CANCELLATION_REMINDER
            - CONFIRMATION_REMINDER
            - REVIEW_REMINDER
            - APPOINTMENT_INVOICE
            - UPDATE_APPOINTMENT
            - UPDATE_PAYMENT_METHOD
            - APPOINTMENT_REMINDER
            - NEW_PRESCRIPTION
            - NEW_CHAT_MESSAGE
          example: APPOINTMENT_UPDATED
        patientMessage:
          $ref: '#/components/schemas/MessageContentDto'
          description: >-
            Message for the patient (only if Air Doctor considers the message
            needed; using patient's locale)
        profileMessage:
          $ref: '#/components/schemas/MessageContentDto'
          description: >-
            Message for the profile (only if Air Doctor considers the message
            needed; using profile's locale)
      title: Appointment details webhook format
    MessageContentDto:
      type: object
      description: >-
        This structure is the format provided to Air Doctor partners, who wish
        to register for web hooks and send notifications on their own
      properties:
        description:
          type: string
          description: Textual message describing the change
          example: Appointment was Cancelled
        details:
          type: string
          description: Additional helpfull wording for the patient
          example: Sadly the doctor was not available to take your call
        action:
          type: string
          description: Text for the list or button
          example: Click to Reschedule
        link:
          type: string
          description: The link appropriate for the button
          example: https://www.air-dr.com/webapp/#details&id=2918
        appointmentDetailsLine1:
          type: string
          description: Appointment details line 1
          example: Dr. TEST t., General Doctor
        appointmentDetailsLine2:
          type: string
          description: Appointment details line 2
          example: Online visit, Saturday, 8/6/22, 9:00 AM
        appointmentDetailsLine3:
          type: string
          description: Appointment details line 3
          example: John Smith
        notes:
          type: array
          description: List of additional notes and disclaimers
          items:
            type: string
        calendarType:
          type: string
          description: Calendar attachment target type
          enum:
            - SCHEDULE
            - CANCEL
            - NONE
          example: SCHEDULE
      title: Appointment change message details
    OfflineAsapRequestParamDto:
      type: object
      properties:
        selectedLanguages:
          type: array
          items:
            type: string
            enum:
              - AA
              - AB
              - AE
              - AF
              - AK
              - AM
              - AN
              - AR
              - AS
              - AV
              - AY
              - AZ
              - BA
              - BE
              - BG
              - BH
              - BI
              - BM
              - BN
              - BO
              - BR
              - BS
              - CA
              - CE
              - CH
              - CO
              - CR
              - CS
              - CU
              - CV
              - CY
              - DA
              - DE
              - DV
              - DZ
              - EE
              - EL
              - EN
              - EO
              - ES
              - ET
              - EU
              - FA
              - FF
              - FI
              - FJ
              - FO
              - FR
              - FY
              - GA
              - GD
              - GL
              - GN
              - GU
              - GV
              - HA
              - HE
              - HI
              - HO
              - HR
              - HT
              - HU
              - HY
              - HZ
              - IA
              - ID
              - IE
              - IG
              - II
              - IK
              - IO
              - IS
              - IT
              - IU
              - JA
              - JV
              - KA
              - KG
              - KI
              - KJ
              - KK
              - KL
              - KM
              - KN
              - KO
              - KR
              - KS
              - KU
              - KV
              - KW
              - KY
              - LA
              - LB
              - LG
              - LI
              - LN
              - LO
              - LT
              - LU
              - LV
              - MG
              - MH
              - MI
              - MK
              - ML
              - MN
              - MR
              - MS
              - MT
              - MY
              - NA
              - NB
              - ND
              - NE
              - NG
              - NL
              - NN
              - 'NO'
              - NR
              - NV
              - NY
              - OC
              - OJ
              - OM
              - OR
              - OS
              - PA
              - PI
              - PL
              - PS
              - PT
              - QU
              - RM
              - RN
              - RO
              - RU
              - RW
              - SA
              - SC
              - SD
              - SE
              - SG
              - SI
              - SK
              - SL
              - SM
              - SN
              - SO
              - SQ
              - SR
              - SS
              - ST
              - SU
              - SV
              - SW
              - TA
              - TE
              - TG
              - TH
              - TI
              - TK
              - TL
              - TN
              - TO
              - TR
              - TS
              - TT
              - TW
              - TY
              - UG
              - UK
              - UR
              - UZ
              - VE
              - VI
              - VO
              - WA
              - WO
              - XH
              - YI
              - YO
              - ZA
              - ZH
              - YUE
              - ZU
        selectedSpecialty:
          type: string
          enum:
            - GENERAL
            - DENTIST
            - ORTHOPEDIST
            - PEDIATRICIAN
            - GYNECOLOGIST
            - PULMONOLOGIST
            - GASTROENTEROLOGIST
            - OPHTALMOLOGIST
            - DERMATOLOGIST
            - NEUROLOGIST
            - ENT
            - PSYCHIATRIST
            - CARDIOLOGIST
            - UROLOGIST
            - ALTERNATIVE
            - OTHER
            - EMERGENCY
            - MORE
            - MASSEUSE
            - ONCOLOGIST
            - SURGEON
            - INTERNIST
            - HEMATOLOGIST
            - NEPHROLOGIST
            - RHEUMATOLOGIST
            - GERIATRICIAN
            - ALLERGOLOGIST
            - ONLINE_DOCTOR
            - IMAGING
            - LABS
        selectedSubSpeciality:
          type: array
          items:
            type: string
            enum:
              - ACUPUNCTURE
              - AYURVEDA
              - HOMEOPATHY
              - NATUROPATHY
              - CHINESE_OR_ORIENTAL_MEDICINE
              - GENERAL_CLINICAL_CARDIOLOGIST
              - CARDIOTHORACIC_SURGEON
              - ECHOCARDIOLOGIST
              - ELECTROPHYSIOLOGIST
              - INTERVENTIONAL_CARDIOLOGY_CARDIOLOGIST
              - ELECTROPHYSIOLOGY
              - ADVANCED_HEART_FAILURE_AND_TRANSPLANTATION
              - ADULT_CONGENITAL_CARDIOLOGIST
              - NUCLEAR_CARDIOLOGIST
              - HEART_FAILURE_AND_TRANSPLANT_CARDIOLOGIST
              - COMPUTED_TOMOGRAPHY_MAGNETIC_RESONANCE_IMAGING_CARDIOLOGIST
              - ENDODONTIST
              - ORAL_AND_MAXILLOFACIAL_SURGEON
              - ORTHODONTIST_ALIGNMENT_SPECIALIST
              - PEDIATRIC_DENTIST
              - PERIODONTIST_GUM_SPECIALIST
              - PROSTHODONTIST_REPLACEMENT_SPECIALIST
              - DERMATOPATHOLOGY
              - EPIDERMOLYSIS_BULLOSA_CLINIC
              - LASER
              - MOHS_SURGERY
              - PEDIATRIC_DERMATOLOGY
              - PHOTOTHERAPY
              - CONTACT_DERMATITIS
              - VITILIGO_ALOPECIA_AREATA
              - PIGMENTED_LESION_AND_MELANOMA
              - AUTOIMMUNE_SKIN_DISEASE
              - SKIN_CANCER_GENETICS
              - HIGH_RISK_NONMELANOMA_SKIN_CANCER
              - NAIL_DISORDERS
              - HAIR_LOSS
              - GENITAL_DERMATOLOGY
              - ADVANCED_BASAL_CELL_CARCINOMA
              - SKIN_ALLERGIES_AND_CONTACT_DERMATITIS
              - PALLIATIVE_MEDICINE
              - CRITICAL_CARE_MEDICINE_EMERGENCY
              - MEDICAL_TOXICOLOGY_EMERGENCY
              - PEDIATRIC_EMERGENCY_MEDICINE
              - SPORTS_MEDICINE_EMERGENCY
              - EMERGENCY_MEDICAL_SERVICES
              - UNDERSEA_AND_HYPERBARIC_MEDICINE
              - ALLERGIES
              - FACIAL_SURGERY
              - HEAD_AND_NECK
              - THROAT
              - EAR
              - PEDIATRIC_CONDITIONS
              - COSMETIC_SURGERY
              - LARYNGOLOGY
              - OTOLOGY_AND_NEUROTOLOGY
              - INFLAMMATORY_BOWEL_DISEASE
              - TROPICAL_DISEASES
              - GASTROINTESTINAL_CANCER_AND_ITS_PREVENTION
              - ENDOSCOPIC_SURVEILLANCE
              - REFLUX_OESOPHAGITIS
              - HEPATOLOGY
              - PANCREATIC_DISEASE
              - TRANSPLANTATION
              - MEDICOLEGAL_ISSUES_IN_MEDICINE
              - CLINICAL_PHARMACOLOGY
              - INHERITED_CANCER_SYNDROMES
              - ADOLESCENT_MEDICINE_GENERAL
              - CLINICAL_INFORMATICS
              - EMERGENCY_MEDICINE
              - GERIATRIC_MEDICINE_GENERAL
              - HIV_AIDS
              - HOSPICE_AND_PALLIATIVE_MEDICINE_GENERAL
              - MATERNAL_FETAL_MEDICINE
              - REPRODUCTIVE_ENDOCRINOLOGY
              - GYNECOLOGIC_ONCOLOGY_GYNECOLOGIST
              - UROGYNECOLOGY
              - EPILEPSY_NEURO_DIAGNOSTICS
              - HEADACHE_PAIN_MEDICINE
              - MOVEMENT_DISORDERS
              - NEURO_BEHAVIOR_MEMORY_DISORDERS
              - NEURO_IMMUNOLOGY_MS
              - NEURO_INFECTIOUS_DISEASE
              - NEURO_MUSCULAR
              - NEURO_ONCOLOGY_NEUROLOGIST
              - NEURO_OPHTHALMOLOGY_NEUROLOGIST
              - NEURO_VASCULAR_STROKE
              - SPORTS_MEDICINE_ORTHOPEDIST
              - HAND_AND_ARM
              - PEDIATRIC_ORTHOPEDICS
              - SPINE_SURGERY
              - FOOT_AND_ANKLE_ORTHOPEDICS_PODIATRY
              - JOINT_REPLACEMENT
              - TRAUMA_SURGERY
              - HIP_AND_KNEE_REPLACEMENT
              - SHOULDER_AND_ELBOW
              - ORTHOPAEDIC_ONCOLOGY
              - MUSCULOSKELETALTUMORS
              - ANTERIOR_SEGMENT_SURGERY
              - CATARACTS_AND_REFRACTIVE_SURGERY
              - CORNEA_AND_EXTERNAL_DISEASE
              - GLAUCOMA
              - NEURO_OPHTHALMOLOGY_OPHTALMOLOGIST
              - OCULAR_ONCOLOGY
              - OCULOPLASTICS_AND_ORBIT_SURGERY
              - OPHTHALMIC_PATHOLOGY
              - PEDIATRICS
              - UVEITIS_AND_IMMUNOLOGY
              - VITREORETINAL_SURGERY
              - PEDIATRIC_RHEUMATOLOGY
              - PEDIATRIC_PULMONOLOGY
              - PEDIATRIC_NEPHROLOGY
              - PEDIATRIC_INFECTIOUS_DISEASES
              - PEDIATRIC_HEMATOLOGYONCOLOGY
              - PEDIATRIC_GASTROENTEROLOGY
              - PEDIATRIC_ENDOCRINOLOGY
              - PEDIATRIC_EMERGENCY_MEDICINE_PEDIATRICIAN
              - DEVELOPMENTAL_BEHAVIORAL_PEDIATRICS
              - PEDIATRIC_CRITICAL_CARE_MEDICINE
              - PEDIATRIC_CARDIOLOGY
              - ADOLESCENT_MEDICINE_PEDIATRICIAN
              - MEDICAL_TOXICOLOGY_PEDIATRICIAN
              - SLEEP_MEDICINE_PEDIATRICIAN
              - SPORTS_MEDICINE_PEDIATRICIAN
              - PEDIATRIC_TRANSPLANT_HEPATOLOGY
              - GENERAL_ADULT_PSYCHIATRY
              - SOCIAL_AND_COMMUNITY_PSYCHIATRY
              - OLD_AGE_PSYCHIATRY
              - CHILD_AND_ADOLESCENT_PSYCHIATRY
              - LIAISON_PSYCHIATRY
              - FORENSIC_PSYCHIATRY
              - LEARNING_DISABILITY
              - PSYCHOTHERAPY
              - RADIATION_ONCOLOGY
              - SURGICAL_ONCOLOGY
              - MEDICAL_ONCOLOGY
              - INTERVENTIONAL_ONCOLOGY
              - GYNECOLOGIC_ONCOLOGY
              - PEDIATRIC_ONCOLOGY
              - NEURO_ONCOLOGY
              - HEMATO_ONCOLOGY
              - URO_ONCOLOGY
              - CARDIOTHORACIC_SURGERY
              - GENERAL_SURGERY
              - NEUROSURGERY
              - ORAL_AND_MAXILLOFACIAL_SURGERY
              - OTOLARYNGOLOGY_SURGERY
              - PAEDIATRIC_SURGERY
              - PLASTIC_SURGERY
              - TRAUMA_AND_ORTHOPAEDIC_SURGERY
              - UROLOGY_SURGERY
              - VASCULAR_SURGERY
              - CARDIOVASCULAR_DISEASE
              - ADULT_CONGENITAL_HEART_DISEASE
              - CARDIAC_ELECTROPHYSIOLOGY
              - HEART_FAILURE_AND_TRANSPLANT_CARDIOLOGY
              - INTERVENTIONAL_CARDIOLOGY_INTERNAL
              - ENDOCRINOLOGY_DIABETES_AND_METABOLISM
              - GASTROENTEROLOGY
              - TRANSPLANT_HEPATOLOGY
              - HEMATOLOGY_BLOOD
              - INFECTIOUS_DISEASE
              - NEPHROLOGY
              - ONCOLOGY
              - PULMONARY_DISEASE
              - RHEUMATOLOGY
              - ADOLESCENT_MEDICINE_INTERNAL
              - ALLERGY_AND_IMMUNOLOGY
              - CRITICAL_CARE_MEDICINE_INTERNAL
              - GERIATRIC_MEDICINE_INTERNAL
              - NEUROCRITICAL_CARE
              - SLEEP_MEDICINE_INTERNAL
              - SPORTS_MEDICINE_INTERNAL
              - RHINOLOGY
              - SLEEP_MEDICINE
              - ENDO_UROLOGY
              - ONCOLOGICAL_UROLOGY
              - NEURO_UROLOGY
              - PREDIATRIC_UROLOGIST
              - ANDROLOGY
              - RECONSTRUCTIVE_UROLOGY
              - UROGYNECOLOGY_UROLOGIST
              - GASTROENTEROLOGIST_PEDIATRIC_GASTROENTEROLOGY
              - NEUROGASTROENTEROLOGY
              - ORTHOPEDIC_SURGERY
              - ONCOLOGICAL_SURGERY
              - ENDOCRINE_SURGERY
              - COLORECTAL_SURGERY
              - NEUROLOGIST_NEUROSURGERY
              - PRIATRIC_NEUROLOGY
              - NEUROLOGIST_SLEEP_MEDICINE
              - CARDIOLOGIST_PEDIATRIC_CARDIOLOGY
              - PAIN_MEDICINE
              - PEDIATRIC_OTOLARYNGOLOGY
              - PEDIATRIC_UROLOGIST
              - PEDIATRICIAN_PEDIATRIC_ORTHOPEDICS
              - PEDIATRIC_SURGERY
              - PEDIATRIC_NEUROLOGY
              - PEDIATRICIAN_PEDIATRIC_DERMATOLOGY
              - CT
              - MRI
              - THYROID_AND_PARATHYROID_SURGERY
              - MILITARY_INVASIVE_SURGERY
              - BARIATRIC_SURGERY
              - ORGAN_TRANSPLANT
              - LAPAROSCOPIC_SURGERY
              - GASTROINTESTINAL_SURGERY
              - PEDIATRIC_ALLERGY_AND_IMMUNOLOGY
              - EATING_DISORDER
              - GASTROINTESTINAL_ONCOLOGY
              - HIGH_RISK_PREGNANCY
              - CERVIX
              - FERTILITY_TREATMENTS
              - IVF
              - ULTRASOUND
              - MINIMALLY_INVASIVE_GYNECOLOGIC_SURGERY
              - CATARACTS_SURGERY
              - STRABISMUS
              - RETINA
              - SHOULDER
              - ELBOW
              - HIP
              - KNEE
              - FOOT
              - ANKLE
              - PALM
              - ARM
              - ARTHROSCOPY_SURGERY
              - MRI_LAB
              - BLOOD_TEST
              - X_RAY
              - VACCINATION
              - ULTRASOUND_LAB
              - CT_LAB
              - URINE
              - THROAT_SURFACE
              - STD
              - HIV
              - PCR
        selectedGender:
          type: string
          enum:
            - MALE
            - FEMALE
            - BOTH
            - OTHER
        patientId:
          type: integer
          format: int32
        locationType:
          type: string
          enum:
            - HOME_VISIT
            - CLINIC_VISIT
            - VIDEO_VISIT
        suggestedCountry:
          type: string
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
        longitude:
          type: number
          format: double
        latitude:
          type: number
          format: double
        includeHomeDistanceCheck:
          type: boolean
        requestTime:
          type: string
          format: date-time
    ProfilePriceRangeDto:
      type: object
      properties:
        homeTo:
          type: number
          format: double
        homeFrom:
          type: number
          format: double
        clinicTo:
          type: number
          format: double
        clinicFrom:
          type: number
          format: double
    ReviewDto:
      type: object
      properties:
        rating:
          type: number
          format: double
          description: Number of stars indicated (1 through 5)
          example: 4
        doctorRating:
          type: number
          format: double
          description: Number of stars indicated (1 through 10)
          example: 9
        text:
          type: string
          description: The review wording (possibly translated)
          example: Generally a pretty good doctor
        firstName:
          type: string
          description: Reviewer first name
          example: John
        reviewDate:
          type: string
          format: date
          description: Date of the review
          example: '2019-04-19'
        appointmentType:
          type: string
          description: The type of appointment to which the review relates
          enum:
            - VIDEO_VISIT
            - REGULAR_CLINIC
            - URGENT_CLINIC
            - REGULAR_HOME
            - URGENT_HOME
          example: CLINIC
      title: Profile review record
    ProfilesListDto:
      type: object
      properties:
        doctorsAvailabilityStatus:
          type: string
          description: Profiles availability status
          enum:
            - NOT_AVAILABLE_BY_INSURER
            - NOT_AVAILABLE_IN_GENERAL
            - VIDEO_ONLY_IN_GENERAL
            - VIDEO_ONLY_BY_INSURER
            - ALL_AVAILABLE
        profiles:
          type: array
          description: List of available profiles
          items:
            $ref: '#/components/schemas/ProfileDto'
        requestedToReferralSpecialties:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              enum:
                - GENERAL
                - DENTIST
                - ORTHOPEDIST
                - PEDIATRICIAN
                - GYNECOLOGIST
                - PULMONOLOGIST
                - GASTROENTEROLOGIST
                - OPHTALMOLOGIST
                - DERMATOLOGIST
                - NEUROLOGIST
                - ENT
                - PSYCHIATRIST
                - CARDIOLOGIST
                - UROLOGIST
                - ALTERNATIVE
                - OTHER
                - EMERGENCY
                - MORE
                - MASSEUSE
                - ONCOLOGIST
                - SURGEON
                - INTERNIST
                - HEMATOLOGIST
                - NEPHROLOGIST
                - RHEUMATOLOGIST
                - GERIATRICIAN
                - ALLERGOLOGIST
                - ONLINE_DOCTOR
                - IMAGING
                - LABS
          description: Referral rules, based on country
        suggestedMinVideoFeePerSpecialty:
          type: object
          additionalProperties:
            type: number
            format: double
          description: >-
            Set if autosuggested video appointments available, this is the
            lowest price (in USD) per specialty
          example: 40
        suggestedMaxVideoFeePerSpecialty:
          type: object
          additionalProperties:
            type: number
            format: double
          description: >-
            Set if autosuggested video appointments available, this is the
            highest price (in USD) per specialty
          example: 50
      title: List of profiles, referral rules and availability reason
    OverriddenPolicyRulesGetDto:
      type: object
      properties:
        patientId:
          type: integer
          format: int32
          description: >-
            Air Doctor's internal patient id to apply the override. Pass blank
            if override is applied to the whole policy (to each active patient
            in the policy)
          example: 9876
        followUp:
          type: boolean
          description: >-
            If true - overridden policy rules will apply to follow-up visits
            only
        startTimestamp:
          type: string
          format: date-time
          default: current time
          description: Override window start time
          example: 2020-07-29T08:30
        endTimestamp:
          type: string
          format: date-time
          default: start time + 24 hours
          description: Override window end time
          example: 2020-07-29T16:30
        reason:
          type: string
          description: Override reason
          example: Customer requested extra visit
        status:
          type: string
          description: Current overridden policy rules status
          enum:
            - HIDE
            - SHOW_BLOCK
            - ASSISTANCE
            - PAY
            - PREPAYMENT
            - CC_BACKUP
            - COVERED
            - PAY_UNDER_INSURER
          example: COVERED
        country:
          type: string
          description: Allowed country. Pass blank if all company allowed countries
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
            - XK
          example: DE
        specialty:
          type: string
          description: Allowed specialty. Pass blank if all company allowed specialties
          enum:
            - GENERAL
            - DENTIST
            - ORTHOPEDIST
            - PEDIATRICIAN
            - GYNECOLOGIST
            - PULMONOLOGIST
            - GASTROENTEROLOGIST
            - OPHTALMOLOGIST
            - DERMATOLOGIST
            - NEUROLOGIST
            - ENT
            - PSYCHIATRIST
            - CARDIOLOGIST
            - UROLOGIST
            - ALTERNATIVE
            - OTHER
            - EMERGENCY
            - MORE
            - MASSEUSE
            - ONCOLOGIST
            - SURGEON
            - INTERNIST
            - HEMATOLOGIST
            - NEPHROLOGIST
            - RHEUMATOLOGIST
            - GERIATRICIAN
            - ALLERGOLOGIST
            - ONLINE_DOCTOR
            - IMAGING
            - LABS
          example: GENERAL
        priceLimit:
          type: number
          format: double
          description: Price limit. Pass 0 or skip this field if up to company price limit
          example: 25.5
        priceLimitCurrency:
          type: string
          default: company default currency
          description: Price limit currency
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
          example: USD
        allowUseVideoVisit:
          type: boolean
          description: Video visits allowed
          example: true
        allowUseClinicVisit:
          type: boolean
          description: Clinic visits allowed
          example: true
        allowUseHomeVisit:
          type: boolean
          description: Home visits allowed
          example: false
        visitsNumber:
          type: integer
          format: int32
          default: '1'
          description: Max number of allowed visits inside current override
          example: 1
        excessFee:
          type: number
          format: double
          default: '0'
          description: Excess (deductible) to be charged for a visit
          example: 50
        excessCurrency:
          type: string
          description: Excess (deductible) currency to be charged for a visit
          enum:
            - AED
            - ALL
            - AMD
            - ANG
            - ARS
            - AUD
            - AWG
            - BAM
            - BBD
            - BGN
            - BHD
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BWP
            - BYR
            - CAD
            - CHF
            - CLP
            - CNY
            - COP
            - CRC
            - CZK
            - DKK
            - DOP
            - DZD
            - EGP
            - EUR
            - FJD
            - GBP
            - GEL
            - GIP
            - GTQ
            - HKD
            - HRK
            - HUF
            - IDR
            - ILS
            - INR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KHR
            - KRW
            - KWD
            - KYD
            - KZT
            - LBP
            - LKR
            - MAD
            - MDL
            - MKD
            - MRO
            - MUR
            - MWK
            - MXN
            - MYR
            - NAD
            - NGN
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - QAR
            - RON
            - RSD
            - RUB
            - SAR
            - SCR
            - SDG
            - SEK
            - SGD
            - THB
            - TND
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - USD
            - UYU
            - UZS
            - VEF
            - VND
            - XCD
            - XOF
            - ZAR
            - AFN
            - AOA
            - AZN
            - BDT
            - BIF
            - BZD
            - CDF
            - CVE
            - DJF
            - ETB
            - FKP
            - GMD
            - GNF
            - GYD
            - HNL
            - HTG
            - KGS
            - KMF
            - LAK
            - LRD
            - LSL
            - MGA
            - MMK
            - MNT
            - MOP
            - MVR
            - MZN
            - NIO
            - PYG
            - RWF
            - SBD
            - SHP
            - SLL
            - SOS
            - SRD
            - STD
            - SZL
            - TJS
            - TOP
            - UGX
            - VUV
            - WST
            - XAF
            - XPF
            - YER
            - ZMW
          example: USD
        attachments:
          type: array
          description: List of attachments
          items:
            $ref: '#/components/schemas/PhotoDto'
        followUpOverride:
          type: string
          description: Does follow up availability manually override
          enum:
            - FORBID
            - ALLOW
            - DEFAULT
          example: DEFAULT
        initiatorId:
          type: integer
          format: int32
          description: User id who approved the override
          example: 158958
        initiatorName:
          type: string
          description: User name who approved the override
          example: John Smith
        timestamp:
          type: string
          format: date-time
          description: The timestamp when the policy override were created
          example: 2020-07-22T08:30
      required:
        - status
      title: Policy rules override
    MapDayOfWeekEnumProfileAvailabilityPerDay:
      type: object
      description: Availability of profiles per day
      properties:
        MONDAY:
          $ref: '#/components/schemas/ProfileAvailabilityPerDay'
        TUESDAY:
          $ref: '#/components/schemas/ProfileAvailabilityPerDay'
        WEDNESDAY:
          $ref: '#/components/schemas/ProfileAvailabilityPerDay'
        THURSDAY:
          $ref: '#/components/schemas/ProfileAvailabilityPerDay'
        FRIDAY:
          $ref: '#/components/schemas/ProfileAvailabilityPerDay'
        SATURDAY:
          $ref: '#/components/schemas/ProfileAvailabilityPerDay'
        SUNDAY:
          $ref: '#/components/schemas/ProfileAvailabilityPerDay'
      title: Map giving a value based on null
    ProfileAvailabilityPerDay:
      type: object
      description: Checking profiles availability per day
      properties:
        generalPractitionerAvailable:
          type: boolean
          description: >-
            Availability of profiles for general specialty for face-to-face
            meetings
        selectedSpecialityAvailable:
          type: boolean
          description: >-
            Availability of profiles for selected specialty for face-to-face
            meetings
        generalPractitionerAvailableSkipCompanyRestrictions:
          type: boolean
          description: >-
            Availability of profiles for general specialty for face-to-face
            meetings without company restrictions
        selectedSpecialityAvailableSkipCompanyRestrictions:
          type: boolean
          description: >-
            Availability of profiles for selected specialty for face-to-face
            meetings without company restrictions
        nearestGeneralPractitioner:
          type: integer
          format: int32
          description: Distance (in km) to the nearest general f2f doctor
        nearestSpecialist:
          type: integer
          format: int32
          description: Distance (in km) to the nearest selected f2f doctor
        nearestGeneralPractitionerSkipCompanyRestrictions:
          type: integer
          format: int32
          description: >-
            Distance (in km) to the nearest general f2f doctor without company
            restrictions
        nearestSpecialistSkipCompanyRestrictions:
          type: integer
          format: int32
          description: >-
            Distance (in km) to the nearest selected f2f doctor without company
            restrictions
        videoInEnglish:
          type: string
          description: Availability of profiles for English language for video meetings
          enum:
            - NOT_AVAILABLE
            - AVAILABLE
            - CAN_PRESCRIBE
        videoInSelectedLanguage:
          type: string
          description: Availability of profiles for selected language for video meetings
          enum:
            - NOT_AVAILABLE
            - AVAILABLE
            - CAN_PRESCRIBE
    ProfilesAvailabilityDto:
      type: object
      description: Checking profiles availability according to the specified parameters
      properties:
        profilesAvailability:
          $ref: '#/components/schemas/MapDayOfWeekEnumProfileAvailabilityPerDay'
          description: Availability of profiles per day
    MessageContactDto:
      type: object
      properties:
        messageId:
          type: integer
          format: int32
          description: Message id
        ticketId:
          type: integer
          format: int32
          description: Ticket id
        messageContactId:
          type: integer
          format: int32
          description: Message contact id
        contact:
          type: string
          description: The contact to which the message was sent
        name:
          type: string
          description: The user name to which the message was sent
        messenger:
          type: string
          description: Messenger type
          enum:
            - SMS
            - WA
            - TELEGRAM
            - WE_CHAT
            - EMAIL
            - CHAT
            - PUSH_NOTIFICATION
            - PHONE_CALL
        externalId:
          type: string
          description: Identification id of the message
        messageStatus:
          type: string
          description: Identification number message status
          enum:
            - QUEUED
            - SENDING
            - SENT
            - FAILED
            - DELIVERED
            - UNDELIVERED
            - RECEIVING
            - RECEIVED
            - ACCEPTED
            - SCHEDULED
            - READ
            - PARTIALLY_DELIVERED
            - CANCELED
            - UNKNOWN
        statusTimestamp:
          type: string
          format: date-time
          description: Time of last status update
        errorMessage:
          type: string
          description: Error type of the message
          enum:
            - UNKNOWN
            - QUEUE_OVERFLOW
            - ACCOUNT_SUSPENDED
            - UNREACHABLE_DESTINATION_HANDSET
            - MESSAGE_BLOCKED
            - UNKNOWN_DESTINATION_HANDSET
            - LANDLINE_OR_UNREACHABLE_CARRIER
            - CARRIER_VIOLATION
            - UNKNOWN_ERROR
            - MISSING_SEGMENT
            - MESSAGE_PRICE_EXCEEDS_MAX_PRICE
            - CHANNEL_COULD_NOT_AUTHENTICATE_REQUEST
            - CHANNEL_COULD_NOT_FIND_FROM_ADDRESS
            - CHANNEL_COULD_NOT_FIND_TO_ADDRESS
            - CHANNEL_DID_NOT_ACCEPT_GIVEN_CONTENT
            - COULD_NOT_FORMAT_GIVEN_CONTENT_FOR_CHANNEL
            - TWILIO_COULD_NOT_FIND_CHANNEL_WITH_SPECIFIED_FROM_ADDRESS
            - CHANNEL_MODULE_MISCONFIGURED
            - CHANNEL_RETURNED_ERROR_WHEN_EXECUTING_REQUEST
            - TWILIO_INTERNAL_ERROR
            - CHANNEL_RETURNED_INTERNAL_ERROR
            - VIOLATES_CHANNEL_PROVIDER_POLICY
            - BLOCKED_BY_USER_ACTION
            - CHANNEL_SANDBOX_CAN_SEND_MESSAGES_TO_SANDBOX_PHONES
            - WHATSAPP_MESSAGE_TEMPLATE
            - RATE_LIMIT_EXCEEDED
            - RATE_LIMIT_EXCEEDED_FOR_CHANNEL
            - MEDIA_FAILED_TO_DOWNLOAD
            - TWILIO_BUSINESS_ACCOUNT_ERROR
            - CHANNEL_INVALID_CONTENT_ERROR
            - INVALID_VNAME_CERTIFICATE
            - CHANNEL_GENERIC_ERROR
            - INVALID_MESSAGE_RECIPIENT
            - MEDIA_ALREADY_EXISTS
            - CHANNEL_SENDER_CONTENT_FLAGGED_AS_SPAM
            - TEMPLATE_NOT_EXIST_LANGUAGE_AND_LOCALE
            - NUMBER_NOT_MATCH_EXPECTED_NUMBER_PARAMETERS
            - RECEIVER_FAILED_DOWNLOAD_TEMPLATE
            - UNSUPPORTED_PARAMETER_FOR_CHANNELS
            - CHANNELS_MESSAGE_CANNOT_HAVE_SAME_FROM_AND_TO
            - WHATSAPP_LIMITATION
            - RECIPIENT_OPTED_OUT_TO_RECEIVE_MESSAGE
            - MEDIA_EXCEEDS_SIZE_LIMIT
            - RBM_AGENT_HAS_NOT_LAUNCHED
            - NUMBER_CANNOT_REACHED_BY_RBM
            - CHANNEL_MEDIA_UPLOAD_ERROR
            - ACCOUNT_EXCEEDED_DAILY_MESSAGES_LIMIT
            - FACEBOOK_WARNING
            - TEMPLATE_REJECTED
            - TEMPLATE_PAUSED
            - TEMPLATE_DISABLED
            - LINK_TO_SAMPLE_MEDIA_RETURNS_ERROR
            - LINK_TO_SAMPLE_MEDIA_NOT_FOUND
            - LINK_TO_SAMPLE_MEDIA_RETURNS_ERROR_STATUS
            - TEMPLATE_APPROVED
            - INVALID_CONTENT_TYPE
            - WHATSAPP_BUSINESS_ACCOUNT_IS_LOCKED
            - ATTEMPT_SEND_TO_UNSUBSCRIBED_RECIPIENT
            - THIS_FROM_NUMBER_HAS_EXCEEDED_MAXIMUM_NUMBER_MESSAGES
            - NOT_VALID_WITH_CURRENT_COMBINATION_TO_AND_FROM
            - TO_NUMBER_NOT_VALID
            - TO_NUMBER_CANNOT_BE_A_LANDLINE
            - TO_NUMBER_HAS_NOT_BEEN_ENABLED_FOR_THE_REGION
            - THIRD_PARTY_AUTH_ERROR
            - INVALID_ARGUMENT
            - INTERNAL
            - QUOTA_EXCEEDED
            - SENDER_ID_MISMATCH
            - UNAVAILABLE
            - UNREGISTERED
        userType:
          type: string
          description: User type
          enum:
            - PATIENT
            - DOCTOR
            - AGGREGATOR
            - POLICY
            - ALL
        userId:
          type: integer
          format: int32
          description: User id
      title: A holder containing information about message contact.
    MessageDto:
      type: object
      properties:
        messageId:
          type: integer
          format: int32
          description: Message id
        initiatorId:
          type: integer
          format: int32
          description: Message initiator id
        caseId:
          type: integer
          format: int32
          description: Case id
        appointmentId:
          type: integer
          format: int32
          description: Appointment id
        appointmentRevisionId:
          type: integer
          format: int32
          description: Appointment revision id
        timestamp:
          type: string
          format: date-time
          description: Message creation time
        subject:
          type: string
          description: Subject of the email
        body:
          type: string
          description: Body of the message
        plainBody:
          type: string
          description: Plain text content of the email, excluding HTML formatting.
        messageType:
          type: string
          description: Message type
          enum:
            - MESSAGE_TO_USER
            - MESSAGE_FROM_USER
            - GUARANTEE_OF_PAYMENT
            - VIDEO_CALL_NOTIFICATION
            - PROFILE_DOCUMENT_PASSWORD
            - APPOINTMENT_UPDATE
            - PROFILE_ENABLE_NOTIFICATION
            - DIRECT_COMMUNICATION
            - HANDOVER_TO_ASSISTANCE
            - PAYMENT_REPORTING_AUTOMATION
        photos:
          type: array
          description: Message attachments
          items:
            $ref: '#/components/schemas/PhotoDto'
        contacts:
          type: array
          description: Message contacts
          items:
            $ref: '#/components/schemas/MessageContactDto'
        buttonText:
          type: string
          description: Button text
        actionUrl:
          type: string
          description: Page's prefix with params
        showDetails:
          type: boolean
          description: Show appointment details section for chat message
        showAppointmentDialog:
          type: boolean
          description: >-
            Show additional displaying appointment information in pop up dialog
            for the user
        messageReference:
          type: string
          description: Message reference
          enum:
            - ER_P_1
            - ER_P_1_1
            - ER_P_1_2
            - ER_P_1_3
            - ER_P_1_4
            - ER_P_1_4_1
            - ER_P_1_5
            - ER_P_1_6
            - ER_P_1_7
            - ER_P_1_8
            - ER_P_1_9
            - ER_P_2
            - ER_P_2_1
            - ER_P_2_2
            - ER_P_2_3
            - ER_P_2_4
            - ER_P_2_5
            - ER_P_2_6
            - ER_P_2_7
            - ER_P_2_8
            - ER_P_2_9
            - ER_P_3
            - ER_P_3_1
            - ER_P_3_2
            - ER_P_3_2_1
            - ER_P_3_2_2
            - ER_P_3_3
            - ER_P_3_3_1
            - ER_P_3_4
            - ER_P_3_4_1
            - ER_P_3_5
            - ER_P_3_5_1
            - ER_P_3_6
            - ER_P_3_7
            - ER_P_3_8
            - ER_P_3_9
            - ER_P_4
            - ER_P_4_1
            - ER_P_4_1_2
            - ER_P_4_2
            - ER_P_4_3
            - ER_P_4_4
            - ER_P_4_5
            - ER_P_4_6
            - ER_P_4_7
            - ER_P_4_8
            - ER_P_4_9
            - ER_P_5
            - ER_P_5_0_1
            - ER_P_5_0_2
            - ER_P_5_1
            - ER_P_5_1_1
            - ER_P_5_1_2
            - ER_P_5_2
            - ER_P_5_3
            - ER_P_5_4
            - ER_P_5_5
            - ER_P_5_6
            - ER_P_5_7
            - ER_P_5_7_1
            - ER_P_5_7_2
            - ER_P_5_8
            - ER_P_5_9
            - ER_P_6
            - ER_P_6_1
            - ER_P_6_2
            - ER_P_6_3
            - ER_P_6_3_1
            - ER_P_6_4
            - ER_P_7
            - ER_PP_6_5
            - ER_PP_6_6
            - ER_PP_6_7
            - ER_PP_6_8
            - ER_PP_6_9
            - ER_D_1
            - ER_D_1_1
            - ER_D_1_2
            - ER_D_1_3
            - ER_D_1_3_1
            - ER_D_1_3_2
            - ER_D_1_4
            - ER_D_1_5
            - ER_D_1_6
            - ER_D_1_7
            - ER_D_1_8
            - ER_D_1_9
            - ER_D_2
            - ER_D_2_1
            - ER_D_2_2
            - ER_D_2_3
            - ER_D_2_4
            - ER_D_2_5
            - ER_D_2_6
            - ER_D_2_7
            - ER_D_2_8
            - ER_D_2_9
            - ER_D_3
            - ER_D_3_1
            - ER_D_3_2
            - ER_D_3_3
            - ER_D_3_4
            - ER_D_3_5
            - ER_D_3_6
            - ER_D_3_7
            - ER_D_3_8
            - ER_D_3_9
            - ER_D_4
            - ER_D_4_1
            - ER_D_4_2
            - ER_D_4_3
            - ER_D_4_4
            - ER_D_4_5
            - ER_D_4_6
            - ER_D_4_7
            - ER_D_4_8
            - ER_D_4_9
            - ER_D_5
            - ER_D_5_1
            - ER_D_5_2
            - ER_D_5_3
            - ER_D_5_4
            - DC_WA_REF_FOLLOWING_YOUR_REQUEST
            - DC_WA_REF_NEW_COMMUNICATION
            - DC_WA_REF_24_HOURS_PASSED
            - DC_WA_REF_DOCTOR_NEW_REQUEST
            - DC_WA_REF_THIS_IS_CS_TEAM
        name:
          type: string
          description: Addressee name
      title: A holder containing information about message.
