openapi: 3.0.0
info:
  title: Ascend Streaming API
  version: 161.0.3
  description: |
    Information related to the Ascends Streaming API.

    Disclaimer: These endpoints are based on browser push message notifications
    and are subject to change.

    Below are some examples on how to format and listen:
    - Format: organizationId.locationId.Endpoint.operationType
    - Example: '66d22762060811049b50d085.\*.AppointmentV1.\*'

      - organizationId - The id given for the org given access, * is NOT RECOMMENDED
      - locationId - You have the ability to split up the messages by location in the organization or * for all locations
      - operationType - You can specify by type CREATE, UPDATE, DELETE or * for all types
     
     - ## '\*.\*.\*.\*' - NOT RECOMMENDED 
          + #### This will then listen to ALL orgnizations that you have access to, likely overwhelming your abiltiy to take them from the queue before the Streaming API Queue Size limit has been reached.

      

      #### WARNING: It must be exact, with no typos, and cannot be missing its version EX "V1" or you will not receive any messages.

      #### Note: Please see Rest API Endpoint if there is a question on what data the Streaming API is pretaining to
      
    ## StreamingAPI Endpoint List
    - AppointmentColorV1
    - AppointmentV1
    - AppointmentHistoryV1
    - CarrierInsurancePlanCoordinationOfBenefitsV1
    - CarrierInsurancePlanV1
    - CarrierPlanCopayExceptionV1
    - CarrierPlanCoverageExceptionV1
    - CarrierPlanDeductibleV1
    - ClinicalNoteV1
    - ClinicalNoteTemplateUserFavoriteV1
    - ColorCategoryV1
    - CoverageProcedureCopayV1
    - CoverageProcedureRangeV1
    - DayNoteV1
    - DefaultPlanCoverageV1
    - DentalLabV1
    - DocumentV1
    - EventV1
    - ExamV1
    - FeeScheduleV1
    - FeeScheduleRangeV1
    - InsuranceCarrierWithExcludedProcedureV1
    - InsuranceCarrierV1
    - InsuranceClaimV1
    - LocationClaimDefaultsV1
    - LocationV1
    - LocationHourV1
    - LocationPovertyLevelV1
    - MedicalAlertV1
    - MissedAppointmentV1
    - OperatoryV1
    - OrganizationLedgerRuleV1
    - OrganizationLedgerTypeV1
    - PatientBookingAvailabilityV1
    - PatientConditionV1
    - PatientInsurancePlanV1
    - PatientMedicalAlertV1
    - PatientNoteV1
    - PatientPaymentPlanV1
    - PatientPrescriptionV1
    - PatientProcedureV1
    - PatientRecareV1
    - PatientV1
    - PatientToothV1
    - PerioExamV1
    - PerioProbeV1
    - PracticeProcedureV1
    - PrescriptionDrugCategoryV1
    - PrescriptionDrugUnitV1
    - PrescriptionPrintSettingV1
    - PrescriptionTemplateV1
    - ProviderDaysExceptionV1
    - ProviderHourV1
    - ProviderV1
    - RecareTemplateV1
    - ScheduleTemplateAppointmentReasonV1
    - ScheduleTemplateV1
    - SubscriberInsurancePlanV1
    - TransactionV1
    - TransactionTagV1
    - TransferReasonV1
    - TxCaseV1
    - UserV1
    - VisitV1
servers:
  - url: https://test.hs1api.com/ascend-streaming-api
    description: Sandbox
  - url: https://prod.hs1api.com/ascend-streaming-api
    description: Prod
security:
  - oAuthSandbox: []
  - bearerAuth: []
paths:
  /url:
    get:
      description: |
        Gets the AMQP URL for connecting to the data stream.
        An access token is embedded in the URL.
      responses:
        '200':
          description: Successful response with AMQP URL.
          content:
            text/plain:
              schema:
                type: string
      tags:
        - Connection (V1)
      operationId: GetUrlV1
  /stomp-url:
    get:
      description: |
        Gets the STOMP URL for connecting to the data stream.
      responses:
        '200':
          description: Successful response with STOMP URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                  virtual-host:
                    type: string
                  user:
                    type: string
      tags:
        - Connection (V1)
      operationId: GetStompUrlV1
components:
  securitySchemes:
    oAuthSandbox:
      type: oauth2
      description: OAuth 2.0 client credentials (Sandbox)
      flows:
        clientCredentials:
          tokenUrl: https://test.hs1api.com/oauth/client_credential/accesstoken?grant_type=client_credentials
          scopes: {}
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
tags:
  - name: Connection (V1)
    description: Streaming connection endpoints
x-tagGroups:
  - name: Connection
    tags:
      - Connection (V1)