Alleva Treatment Reviews API

openapi: 3.2.0
info:
  title: Alleva Rest Treatment Reviews API
  version: '1.0'
security:
- Bearer: []
tags:
- name: TreatmentReviews
paths:
  /treatment-reviews:
    get:
      tags:
      - TreatmentReviews
      parameters:
      - name: Limit
        in: query
        schema:
          type: integer
          format: int64
      - name: Cursor
        in: query
        schema:
          type: integer
          format: int32
      - name: StartDate
        in: query
        schema:
          type: string
          format: date-time
      - name: EndDate
        in: query
        schema:
          type: string
          format: date-time
      - name: fields
        in: query
        schema:
          type: array
          items:
            type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TxReviewDetails'
            application/json; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TxReviewDetails'
            text/json; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TxReviewDetails'
  /v{version}/treatment-reviews:
    get:
      tags:
      - TreatmentReviews
      parameters:
      - name: Limit
        in: query
        schema:
          type: integer
          format: int64
      - name: Cursor
        in: query
        schema:
          type: integer
          format: int32
      - name: StartDate
        in: query
        schema:
          type: string
          format: date-time
      - name: EndDate
        in: query
        schema:
          type: string
          format: date-time
      - name: fields
        in: query
        schema:
          type: array
          items:
            type: string
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TxReviewDetails'
            application/json; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TxReviewDetails'
            text/json; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TxReviewDetails'
  /treatment-reviews/{id}:
    get:
      tags:
      - TreatmentReviews
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                $ref: '#/components/schemas/TxReviewDetails'
            application/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/TxReviewDetails'
            text/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/TxReviewDetails'
  /v{version}/treatment-reviews/{id}:
    get:
      tags:
      - TreatmentReviews
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                $ref: '#/components/schemas/TxReviewDetails'
            application/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/TxReviewDetails'
            text/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/TxReviewDetails'
components:
  schemas:
    TxReviewDetails:
      type: object
      properties:
        id:
          type: integer
          format: int32
        href:
          type:
          - string
          - 'null'
          readOnly: true
        treatmentPlanReviewId:
          type: integer
          format: int64
        newProblemsLastReview:
          type:
          - string
          - 'null'
        strengths:
          type:
          - string
          - 'null'
        needs:
          type:
          - string
          - 'null'
        abilities:
          type:
          - string
          - 'null'
        preferences:
          type:
          - string
          - 'null'
        psychiatricTreatment:
          type:
          - string
          - 'null'
        individualTherapy:
          type:
          - string
          - 'null'
        familyTherapy:
          type:
          - string
          - 'null'
        milieu:
          type:
          - string
          - 'null'
        education:
          type:
          - string
          - 'null'
        recreation:
          type:
          - string
          - 'null'
        criticalEvents:
          type:
          - string
          - 'null'
        therapeuticAbsence:
          type:
          - string
          - 'null'
        anticipatedDischarge:
          type:
          - string
          - 'null'
        livingArrangements:
          type:
          - string
          - 'null'
        dischargeEducation:
          type:
          - string
          - 'null'
        dischargeTherapy:
          type:
          - string
          - 'null'
        dischargeObstacles:
          type:
          - string
          - 'null'
        dischargeFollow:
          type:
          - string
          - 'null'
        justificationTreatment:
          type:
          - string
          - 'null'
        generatedDate:
          type:
          - string
          - 'null'
        generatedTime:
          type:
          - string
          - 'null'
        ceratorSignature:
          type:
          - string
          - 'null'
        createdDated:
          type: string
          format: date-time
        clientSignature:
          type:
          - string
          - 'null'
        clientSignatureDate:
          type:
          - string
          - 'null'
        guardianSignature:
          type:
          - string
          - 'null'
        guardianSignatureDate:
          type:
          - string
          - 'null'
        creatorSignatureDate:
          type:
          - string
          - 'null'
        clientName:
          type:
          - string
          - 'null'
        ceratorName:
          type:
          - string
          - 'null'
        tpReviewNote:
          type:
          - string
          - 'null'
        nextReviewDue:
          type:
          - string
          - 'null'
        sortOrderSetting:
          type:
          - string
          - 'null'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: "JWT Authorization header using the Bearer scheme. \n\n Enter Bearer [space] and then\
        \ your token in the text input below.\n\nExample: Bearer 12345abcdef"
      name: Authorization
      in: header
servers:
- url: https://api.helloalleva.com
  description: Base URL reconciled from apis.yml