suki/openapi/suki-info-api-openapi.yml at main · api-evangelist/suki · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
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