Suki Info API

openapi: 3.0.3
info:
  title: Suki Ambient Auth Info API
  description: 'REST endpoints for Suki Speech Service ambient clinical documentation.

    Partners create an ambient session, seed it with patient and encounter

    context, stream audio over a separate WebSocket channel, end the session,

    and then retrieve the generated clinical note, transcript, structured data,

    and recording. Pair with the WebSocket audio endpoint

    `wss://sdp.suki-stage.com/api/v1/ambient/sessions/{sessionId}/audio` and the

    webhook callback POSTed to the partner endpoint on session completion.

    '
  version: 1.0.0
  contact:
    name: Suki for Partners
    url: https://developer.suki.ai
servers:
- url: https://sdp.suki-stage.com/api/v1
  description: Suki Speech Service staging environment
security:
- SdpSukiToken: []
tags:
- name: Info
  description: Clinical Reference Catalogs
paths:
  /info/specialties:
    get:
      tags:
      - Info
      summary: List Specialties
      operationId: listSpecialties
      responses:
        '200':
          description: Supported medical specialties
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CodeLabel'
  /info/diagnoses:
    get:
      tags:
      - Info
      summary: List Diagnoses
      operationId: listDiagnoses
      parameters:
      - name: q
        in: query
        schema:
          type: string
      - name: system
        in: query
        schema:
          type: string
          enum:
          - icd-10
          - snomed-ct
      responses:
        '200':
          description: Supported diagnosis codes
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CodeLabel'
  /info/encounter-types:
    get:
      tags:
      - Info
      summary: List Encounter Types
      operationId: listEncounterTypes
      responses:
        '200':
          description: Encounter types
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CodeLabel'
  /info/visit-types:
    get:
      tags:
      - Info
      summary: List Visit Types
      operationId: listVisitTypes
      responses:
        '200':
          description: Visit types
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CodeLabel'
  /info/loincs:
    get:
      tags:
      - Info
      summary: List LOINC Note Sections
      operationId: listLoincs
      responses:
        '200':
          description: LOINC-coded note sections supported by Suki
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CodeLabel'
  /info/provider-roles:
    get:
      tags:
      - Info
      summary: List Provider Roles
      operationId: listProviderRoles
      responses:
        '200':
          description: Provider roles
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CodeLabel'
components:
  schemas:
    CodeLabel:
      type: object
      properties:
        code:
          type: string
        label:
          type: string
        system:
          type: string
  securitySchemes:
    SdpSukiToken:
      type: apiKey
      in: header
      name: sdp_suki_token