Silna V1PriorAuthorizationResource API

The V1PriorAuthorizationResource API from Silna — 2 operation(s) for v1priorauthorizationresource.

OpenAPI Specification

silna-v1priorauthorizationresource-api-openapi.yml Raw ↑
openapi: 3.0.2
info:
  title: Silna Public OldV1PriorAuthorizationResource V1PriorAuthorizationResource API
  version: '1.0'
servers:
- url: https://app.silnahealth.com/api
security:
- bearerAuth: []
tags:
- name: V1PriorAuthorizationResource
paths:
  /public/v1/prior-authorizations/{prior_authorization_id}:
    get:
      summary: Get Prior Authorization
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1PriorAuthorization'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectNotFoundError'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsError'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
      parameters:
      - in: path
        name: prior_authorization_id
        required: true
        schema:
          type: string
      - in: query
        name: with_requirements
        required: false
        schema:
          type: boolean
      operationId: V1PriorAuthorizationResource.get
      tags:
      - V1PriorAuthorizationResource
      x-folder: public_api
    patch:
      summary: Update Prior Authorization
      responses:
        '204':
          description: OK
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectNotFoundError'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsError'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
      parameters:
      - in: path
        name: prior_authorization_id
        required: true
        schema:
          type: string
      operationId: V1PriorAuthorizationResource.patch
      tags:
      - V1PriorAuthorizationResource
      x-folder: public_api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1PriorAuthorizationPatch'
        description: ''
    delete:
      summary: Abort Prior Authorization
      responses:
        '204':
          description: OK
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectNotFoundError'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsError'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
      parameters:
      - in: path
        name: prior_authorization_id
        required: true
        schema:
          type: string
      operationId: V1PriorAuthorizationResource.delete
      tags:
      - V1PriorAuthorizationResource
      x-folder: public_api
  /public/v1/prior-authorizations/:
    post:
      summary: Create Prior Authorization
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1PriorAuthorizationCreateResponse'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectNotFoundError'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
        '429':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsError'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
                description: The maximum number of requests allowed in the time window
            X-RateLimit-Remaining:
              schema:
                type: integer
                description: The number of requests remaining in the current time window
            X-RateLimit-Reset:
              schema:
                type: integer
                description: The time when the rate limit will reset, in Unix timestamp
            Retry-After:
              schema:
                type: number
                description: The number of seconds to wait before making another request
      parameters:
      - in: header
        name: idempotency-key
        required: false
        schema:
          type: string
          minLength: 1
          maxLength: 255
        description: Unique key to prevent duplicate requests. We support keys up to 255 characters.
        example: 550e8400-e29b-41d4-a716-446655440000
      operationId: V1PriorAuthorizationResource.post
      tags:
      - V1PriorAuthorizationResource
      x-folder: public_api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1PriorAuthorizationCreate'
        description: ''
components:
  schemas:
    PriorAuthorizationUnit:
      type: string
      enum:
      - VISITS
      - CPT_UNITS
      - HOURS
      - DAYS
      x-folder: prior_authorization
    V1DocumentsRequirement:
      properties:
        required:
          description: Whether documents are required
          title: Required
          type: boolean
        items:
          description: List of document requirements
          items:
            $ref: '#/components/schemas/V1DocumentRequirement'
          title: Items
          type: array
      required:
      - required
      title: V1DocumentsRequirement
      type: object
      x-folder: public_api
    TooManyRequestsError:
      type: object
      required:
      - message
      properties:
        message:
          type: string
          description: Human readable error message
      x-folder: null
    ValidationError:
      type: object
      required:
      - message
      properties:
        message:
          type: string
          description: Human readable error message
      x-folder: null
    PriorAuthorizationUploadDocumentType:
      type: string
      enum:
      - AUTHORIZATION_FORM
      - PROGRESS_NOTE
      - DIAGNOSIS_REPORT
      - REFERRAL
      - ASSESSMENT_EVALUATION
      - CANCELLATION_LETTER
      - TREATMENT_PLAN_PLAN_OF_CARE
      - ATTENDANCE_LOGS
      - INDIVIDUALIZED_EDUCATION_PROGRAM
      - CHANGE_OF_PROVIDER_FORM
      - TELEHEALTH_ATTESTATION
      - ORIGINAL_AUTHORIZATION_APPROVAL_LETTER
      - ABAS
      - VINELAND
      - SRS_2
      - PDDBI
      - PSI_SIPA
      x-folder: prior_authorization
    PublicSpecialty:
      type: string
      enum:
      - PHYSICAL_THERAPY
      - ABA_THERAPY
      - SPEECH_THERAPY
      - OCCUPATIONAL_THERAPY
      - PSYCHOLOGICAL_TESTING
      - HOME_HEALTH_CARE
      - HOSPICE
      - CARDIAC_REHABILITATION
      - INTENSIVE_CARDIAC_REHABILITATION
      - MENTAL_HEALTH
      - PRINCIPAL_ILLNESS_NAVIGATION
      - PRINCIPAL_CARE_MANAGEMENT
      - ADVANCED_PRIMARY_CARE_MODELS
      - PREVENTATIVE_HEALTH
      - PARTIAL_HOSPITALIZATION_PROGRAM
      - INTENSIVE_OUTPATIENT_PROGRAM
      - INTERVENTIONAL_RADIOLOGY
      - VASCULAR_SURGERY
      - INTERVENTIONAL_CARDIOLOGY
      - ORTHOPEDICS
      - CHIROPRACTIC
      - GYNECOLOGY
      - LONG_TERM_CARE
      - NUTRITIONAL_COUNSELING
      - PHYSICAL_MEDICINE
      - PULMONARY_REHABILITATION
      - INJECTABLE_SPECIALTY_MEDICATIONS
      - ALLERGY_TESTING
      - SKILLED_NURSING
      - RADIOLOGY
      - OTOLARYNGOLOGY
      - DURABLE_MEDICAL_EQUIPMENT
      - DERMATOLOGY
      - PROFESSIONAL_OFFICE_VISIT
      - PSYCHIATRY
      x-folder: specialty
    V1DocumentRequirement:
      properties:
        document_type:
          $ref: '#/components/schemas/PriorAuthorizationUploadDocumentType'
          description: Type of document required
        required:
          description: Whether this document is required
          title: Required
          type: boolean
        document_intelligence:
          $ref: '#/components/schemas/V1DocumentIntelligence'
          description: Document intelligence information
      required:
      - document_type
      - required
      - document_intelligence
      title: V1DocumentRequirement
      type: object
      x-folder: public_api
    TreatmentCodeStandard:
      type: string
      enum:
      - CPT
      - HCPCS
      - CALIFORNIA_REGIONAL_CENTER
      - ICD_10
      x-folder: codes
    UnitTimeFrame:
      type: string
      enum:
      - DAILY
      - WEEKLY
      - MONTHLY
      - AUTHORIZATION_PERIOD
      - TOTAL
      - SIX_MONTHS
      - YEARLY
      x-folder: prior_authorization
    PriorAuthorizationApprovalDocumentType:
      type: string
      enum:
      - APPROVAL_LETTER
      x-folder: prior_authorization
    V1PriorAuthorizationPatch:
      properties:
        requested_treatment_codes:
          default: null
          description: List of treatment codes to update
          title: Requested Treatment Codes
          nullable: true
          items:
            $ref: '#/components/schemas/V1RequestedTreatmentCodePatch'
          type: array
        documents:
          default: null
          description: List of documents to update
          title: Documents
          nullable: true
          items:
            $ref: '#/components/schemas/V1DocumentPatch'
          type: array
        document_intelligence_configurations:
          default: null
          description: Document intelligence configurations for validation overrides. By default, document validation is enabled if the document type supports it and document validation is enabled on your account
          title: Document Intelligence Configurations
          nullable: true
          items:
            $ref: '#/components/schemas/V1DocumentIntelligenceConfiguration'
          type: array
        clinician:
          default: null
          description: Clinician information
          nullable: true
          $ref: '#/components/schemas/V1ClinicianPatch'
        start_date:
          default: null
          description: Requested start date
          title: Start Date
          nullable: true
          format: date
          type: string
        save_as_draft:
          default: false
          description: Whether to save as draft. Only available if prior auth management is enabled. Reach out to your Silna contact to turn it on.
          title: Save As Draft
          type: boolean
        skip_document_intelligence:
          default: false
          description: Skip document intelligence across all documents.
          title: Skip Document Intelligence
          type: boolean
      title: V1PriorAuthorizationPatch
      type: object
      x-folder: public_api
    V1PriorAuthorizationApprovalDocument:
      properties:
        document_type:
          $ref: '#/components/schemas/PriorAuthorizationApprovalDocumentType'
          description: Type of document
        file_id:
          description: ID of the file
          format: uuid
          title: File Id
          type: string
      required:
      - document_type
      - file_id
      title: V1PriorAuthorizationApprovalDocument
      type: object
      x-folder: public_api
    V1ApprovedTreatmentCode:
      properties:
        treatment_codes:
          description: List of approved treatment codes
          items:
            $ref: '#/components/schemas/V1TreatmentCode'
          title: Treatment Codes
          type: array
        units:
          description: Approved units (this will be in a decimal string format)
          title: Units
          type: string
          example: '2.5'
        unit_type:
          $ref: '#/components/schemas/PriorAuthorizationUnit'
        time_frame:
          $ref: '#/components/schemas/UnitTimeFrame'
          default: TOTAL
        reference_number:
          default: null
          description: Reference number for the approved treatment code
          title: Reference Number
          nullable: true
          type: string
        approved_start_date:
          default: null
          description: Approved start date for the treatment codes
          title: Approved Start Date
          nullable: true
          format: date
          type: string
        approved_end_date:
          default: null
          description: Approved end date for the treatment codes
          title: Approved End Date
          nullable: true
          format: date
          type: string
      required:
      - units
      - unit_type
      title: V1ApprovedTreatmentCode
      type: object
      x-folder: public_api
    V1GetDocumentRequirement:
      properties:
        document_type:
          $ref: '#/components/schemas/PriorAuthorizationUploadDocumentType'
          description: Type of document required
        required:
          description: Whether this document is required
          title: Required
          type: boolean
        document_intelligence:
          $ref: '#/components/schemas/V1DocumentIntelligence'
          description: Document intelligence information
        requirement_satisfied:
          description: Whether the requirement is satisfied
          title: Requirement Satisfied
          type: boolean
        files:
          description: List of files for this document requirement
          title: Files
          nullable: true
          items:
            $ref: '#/components/schemas/V1DocumentFile'
          type: array
        document_validation:
          default: null
          deprecated: true
          description: 'Document validation information if available. Deprecated: this field returns only a single document validation. Use document_validation_batch.id with the batch endpoints instead.'
          nullable: true
          $ref: '#/components/schemas/V1DocumentValidation'
        document_validation_batch:
          default: null
          description: Document validation batch information if available
          nullable: true
          $ref: '#/components/schemas/V1DocumentValidationBatch'
      required:
      - document_type
      - required
      - document_intelligence
      - requirement_satisfied
      title: V1GetDocumentRequirement
      type: object
      x-folder: public_api
    V1PriorAuthorizationCreateResponse:
      properties:
        id:
          description: ID of the created prior authorization
          format: uuid
          title: Id
          type: string
        status:
          $ref: '#/components/schemas/PublicPriorAuthorizationStatus'
          description: Status of the prior authorization
        required_data:
          $ref: '#/components/schemas/V1PriorAuthorizationRequiredData'
          description: Data required to complete the prior authorization request
      required:
      - id
      - status
      - required_data
      title: V1PriorAuthorizationCreateResponse
      type: object
      x-folder: public_api
    V1PriorAuthorizationDocument:
      properties:
        document_type:
          $ref: '#/components/schemas/PriorAuthorizationPublicDocumentType'
          description: Type of document
        file_id:
          description: ID of the file
          format: uuid
          title: File Id
          type: string
      required:
      - document_type
      - file_id
      title: V1PriorAuthorizationDocument
      type: object
      x-folder: public_api
    V1ClinicianNpiRequirement:
      properties:
        required:
          description: Whether clinician NPI is required
          title: Required
          type: boolean
      required:
      - required
      title: V1ClinicianNpiRequirement
      type: object
      x-folder: public_api
    RuleExecutionResult:
      type: string
      enum:
      - PASSED
      - FAILED
      x-folder: document_intelligence
    V1TreatmentCode:
      properties:
        code:
          description: Treatment code (e.g. a CPT code)
          title: Code
          type: string
        description:
          description: Description of the treatment code
          title: Description
          type: string
        standard:
          $ref: '#/components/schemas/TreatmentCodeStandard'
          description: Standard for the treatment code
        treatment_code_modifiers:
          description: List of treatment code modifiers
          items:
            $ref: '#/components/schemas/V1TreatmentCodeModifier'
          title: Treatment Code Modifiers
          type: array
      required:
      - code
      - description
      - standard
      title: V1TreatmentCode
      type: object
      x-folder: public_api
    V1GetTreatmentCodesRequirement:
      properties:
        required:
          description: Whether treatment codes are required
          title: Required
          type: boolean
        standards:
          description: Standard for the treatment codes
          items:
            $ref: '#/components/schemas/TreatmentCodeStandard'
          title: Standards
          type: array
        requirement_satisfied:
          description: Whether the requirement is satisfied
          title: Requirement Satisfied
          type: boolean
      required:
      - required
      - standards
      - requirement_satisfied
      title: V1GetTreatmentCodesRequirement
      type: object
      x-folder: public_api
    V1PriorAuthorization:
      properties:
        id:
          description: ID of the prior authorization
          format: uuid
          title: Id
          type: string
        specialty:
          $ref: '#/components/schemas/PublicSpecialty'
          description: Specialty for the prior authorization
        requested_treatment_codes:
          description: List of requested treatment codes
          items:
            $ref: '#/components/schemas/V1RequestedTreatmentCode'
          title: Requested Treatment Codes
          type: array
        approved_treatment_codes:
          description: List of approved treatment codes
          items:
            $ref: '#/components/schemas/V1ApprovedTreatmentCode'
          title: Approved Treatment Codes
          type: array
        requested_start_date:
          default: null
          description: Requested start date
          title: Requested Start Date
          nullable: true
          format: date
          type: string
        requested_end_date:
          default: null
          description: Requested end date
          title: Requested End Date
          nullable: true
          format: date
          type: string
        status:
          $ref: '#/components/schemas/PublicPriorAuthorizationStatus'
          description: Status of the prior authorization
        reference_numbers:
          description: List of all reference numbers on the authorization
          items:
            type: string
          title: Reference Numbers
          type: array
        authorization_type:
          $ref: '#/components/schemas/PriorAuthorizationType'
          description:

# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/silna/refs/heads/main/openapi/silna-v1priorauthorizationresource-api-openapi.yml