Skip to content

Commit 7b55f49

Browse files
BB2-3986: Update v3 swagger for connectathon (#1354)
* First set of updates to swagger doc. * update v3 yaml * add service-date again * remove startIndex from coverage --------- Co-authored-by: jimmyfagan <jimmyfagan@navapbc.com>
1 parent 2c236f1 commit 7b55f49

File tree

1 file changed

+12
-41
lines changed

1 file changed

+12
-41
lines changed

static/connectathon_openapi.yaml

Lines changed: 12 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ paths:
3838
$ref: '#/components/examples/OpenIdConfigurationExample'
3939
description: "OIDC Discovery: listing of the OpenID/OAuth endpoints, supported scopes and claims"
4040
tags:
41-
- v2
41+
- v3
4242

4343
/v3/fhir/.well-known/smart-configuration:
4444
get:
@@ -118,7 +118,7 @@ paths:
118118
- name: resource_id
119119
in: path
120120
required: true
121-
description: "Pateint FHIR resource id, e.g. -20140000000001 (synthetic beneficiary)"
121+
description: "Patient FHIR resource id, e.g. -20140000000001 (synthetic beneficiary)"
122122
schema:
123123
type: string
124124
responses:
@@ -140,7 +140,7 @@ paths:
140140
'502':
141141
description: "Error: Bad Gateway, e.g. An error occurred contacting the FHIR server."
142142
tags:
143-
- v2
143+
- v3
144144
/v3/fhir/Patient/:
145145
get:
146146
operationId: listSearchViewPatients_v3
@@ -174,24 +174,6 @@ paths:
174174
- __lastUpdated=gt2023-01-02T00:00+00:00&\_lastUpdated=lt2023-05-01T00:00+00:00_ defines a range between two provided dates
175175
- __lastUpdated=gt2023-01-02T00:00+00:00_ defines a range between the provided date and today
176176
- __lastUpdated=lt2023-05-01T00:00+00:00_ defines a range from the earliest available records until the provided date
177-
- in: query
178-
name: startIndex
179-
schema:
180-
type: string
181-
required: false
182-
description: "The offset used for result pagination"
183-
- in: query
184-
name: _has:Coverage
185-
schema:
186-
type: string
187-
required: false
188-
description: "Part D coverage type/year"
189-
- in: query
190-
name: cursor
191-
schema:
192-
type: string
193-
required: false
194-
description: "The cursor used for result pagination"
195177
- in: query
196178
name: _id
197179
schema:
@@ -283,12 +265,6 @@ paths:
283265
- __lastUpdated=gt2023-01-02T00:00+00:00&\_lastUpdated=lt2023-05-01T00:00+00:00_ defines a range between two provided dates
284266
- __lastUpdated=gt2023-01-02T00:00+00:00_ defines a range between the provided date and today
285267
- __lastUpdated=lt2023-05-01T00:00+00:00_ defines a range from the earliest available records until the provided date
286-
- in: query
287-
name: startIndex
288-
schema:
289-
type: string
290-
required: false
291-
description: "The offset used for result pagination"
292268
responses:
293269
'200':
294270
content:
@@ -371,11 +347,18 @@ paths:
371347
- __lastUpdated=gt2023-01-02T00:00+00:00_ defines a range between the provided date and today
372348
- __lastUpdated=lt2023-05-01T00:00+00:00_ defines a range from the earliest available records until the provided date
373349
- in: query
374-
name: excludeSAMHSA
350+
name: _tag
375351
schema:
376352
type: string
377353
required: false
378-
description: "If true, exclude all SAMHSA-related resources"
354+
description: |-
355+
For the Connectathon, _tag can be used to filter for partially-adjudicated vs. fully-adjudicated claims at query time.
356+
Acceptable values for _tag are Adjudicated and PartiallyAdjudicated
357+
358+
Examples:
359+
- __tag=Adjudicated_ defines a range between two provided dates
360+
- __tag=PartiallyAdjudicated_ will only return partially-adjudicated claims
361+
- both adjudicated and partially-adjudicated claims will be available by default (eg if _tag is not passed)
379362
- in: query
380363
name: service-date
381364
schema:
@@ -399,18 +382,6 @@ paths:
399382
- _service-date=gt2023-01-02T00:00+00:00&service-date=lt2023-05-01T00:00+00:00_ defines a range between two provided dates
400383
- _service-date=gt2023-01-02T00:00+00:00_ defines a range between the provided date and today
401384
- _service-date=lt2023-05-01T00:00+00:00_ defines a range from the earliest available records until the provided date
402-
- in: query
403-
name: startIndex
404-
schema:
405-
type: string
406-
required: false
407-
description: "The offset used for result pagination"
408-
- in: query
409-
name: type
410-
schema:
411-
type: string
412-
required: false
413-
description: "A list of claim types to include"
414385
responses:
415386
'200':
416387
content:

0 commit comments

Comments
 (0)