Skip to content

Commit ac3e7ea

Browse files
jimmyfaganjimmyfagan
authored
BB2-3610: Swagger doc updates for Smart App Launch (#1313)
1 parent 687e76c commit ac3e7ea

File tree

1 file changed

+120
-49
lines changed

1 file changed

+120
-49
lines changed

‎static/openapi.yaml‎

Lines changed: 120 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ info:
1717
paths:
1818
/.well-known/openid-configuration:
1919
get:
20-
operationId: openIdConfig_v2
20+
operationId: openIdConfig
2121
description: "Returns OIDC (OpenID Connect protocol) Discovery: listing of the OpenID/OAuth endpoints, supported scopes and claims (public access, no token needed)"
2222
summary: "OpenID Connect protocol (OIDC) Discovery information"
2323
security: []
@@ -26,19 +26,43 @@ paths:
2626
content:
2727
application/json:
2828
schema:
29-
$ref: '#/components/schemas/V2OpenIdConfiguration'
29+
$ref: '#/components/schemas/OpenIdConfiguration'
3030
examples:
31-
V2OpenIdConfigurationExample:
32-
$ref: '#/components/examples/V2OpenIdConfigurationExample'
31+
OpenIdConfigurationExample:
32+
$ref: '#/components/examples/OpenIdConfigurationExample'
3333
application/fhir+json:
3434
schema:
35-
$ref: '#/components/schemas/V2OpenIdConfiguration'
35+
$ref: '#/components/schemas/OpenIdConfiguration'
3636
examples:
37-
V2OpenIdConfigurationExample:
38-
$ref: '#/components/examples/V2OpenIdConfigurationExample'
37+
OpenIdConfigurationExample:
38+
$ref: '#/components/examples/OpenIdConfigurationExample'
3939
description: "OIDC Discovery: listing of the OpenID/OAuth endpoints, supported scopes and claims"
4040
tags:
4141
- v2
42+
/v2/fhir/.well-known/smart-configuration:
43+
get:
44+
operationId: smartConfigV2
45+
description: "Returns Smart App Launch Discovery: listing of the authorization endpoint URLs and features the server supports"
46+
summary: "Smart App Launch Discovery information"
47+
security: []
48+
responses:
49+
'200':
50+
content:
51+
application/json:
52+
schema:
53+
$ref: '#/components/schemas/SmartConfiguration'
54+
examples:
55+
SmartConfigurationExample:
56+
$ref: '#/components/examples/SmartConfigurationExample'
57+
application/fhir+json:
58+
schema:
59+
$ref: '#/components/schemas/SmartConfiguration'
60+
examples:
61+
SmartConfigurationExample:
62+
$ref: '#/components/examples/SmartConfigurationExample'
63+
description: "Smart App Launch Discovery: listing of the authorization endpoint URLs and features the server supports"
64+
tags:
65+
- v2
4266
/v2/fhir/metadata:
4367
get:
4468
operationId: fhirMetaData_v2
@@ -405,6 +429,30 @@ paths:
405429
tags:
406430
- v2
407431

432+
/v1/fhir/.well-known/smart-configuration:
433+
get:
434+
operationId: smartConfigV1
435+
description: "Returns Smart App Launch Discovery: listing of the authorization endpoint URLs and features the server supports"
436+
summary: "Smart App Launch Discovery information"
437+
security: []
438+
responses:
439+
'200':
440+
content:
441+
application/json:
442+
schema:
443+
$ref: '#/components/schemas/SmartConfiguration'
444+
examples:
445+
SmartConfigurationExample:
446+
$ref: '#/components/examples/SmartConfigurationExample'
447+
application/fhir+json:
448+
schema:
449+
$ref: '#/components/schemas/SmartConfiguration'
450+
examples:
451+
SmartConfigurationExample:
452+
$ref: '#/components/examples/SmartConfigurationExample'
453+
description: "Smart App Launch Discovery: listing of the authorization endpoint URLs and features the server supports"
454+
tags:
455+
- v1
408456
/v1/fhir/metadata:
409457
get:
410458
operationId: fhirMetaData
@@ -804,15 +852,26 @@ components:
804852
authorizationUrl: https://sandbox.bluebutton.cms.gov/v2/o/authorize
805853
tokenUrl: https://sandbox.bluebutton.cms.gov/v2/o/token/
806854
scopes:
807-
profile: User Profile
808-
patient/Patient.read: Read patient
809-
patient/Coverage.read: Read Patient coverage
810-
patient/ExplanationOfBenefit.read: Read patient explanation of benefit
855+
profile: User profile
856+
patient/Patient.read: Read and search patient
857+
patient/Coverage.read: Read and search patient coverage
858+
patient/ExplanationOfBenefit.read: Read and search patient explanation of benefit
859+
openid: Openid profile
860+
launch/patient: Patient launch context
861+
patient/Patient.r: Read patient
862+
patient/Patient.s: Search patient
863+
patient/Patient.rs: Read and search patient
864+
patient/Coverage.r: Read patient coverage
865+
patient/Coverage.s: Search patient coverage
866+
patient/Coverage.rs: Read and search patient coverage
867+
patient/ExplanationOfBenefit.r: Read patient explanation of benefit
868+
patient/ExplanationOfBenefit.s: Search patient explanation of benefit
869+
patient/ExplanationOfBenefit.rs: Read and search patient explanation of benefit
811870

812871
schemas:
813872
FHIR-JSON-RESOURCE: {type: object, description: A FHIR resource}
814873

815-
V1OpenIdConfiguration:
874+
OpenIdConfiguration:
816875
properties:
817876
issuer:
818877
type: string
@@ -835,48 +894,42 @@ components:
835894
grant_types_supported:
836895
type: array
837896
items:
838-
type: string
897+
type: string
839898
response_types_supported:
840899
type: array
841900
items:
842901
type: string
843902
fhir_metadata_uri:
844903
type: string
845904

846-
V2OpenIdConfiguration:
905+
SmartConfiguration:
847906
properties:
848-
issuer:
849-
type: string
850907
authorization_endpoint:
851908
type: string
852909
revocation_endpoint:
853910
type: string
854911
token_endpoint:
855912
type: string
856-
userinfo_endpoint:
857-
type: string
858-
ui_locales_supported:
913+
grant_types_supported:
859914
type: array
860915
items:
861916
type: string
862-
863-
service_documentation:
864-
type: string
865-
op_tos_uri:
866-
type: string
867-
grant_types_supported:
917+
response_types_supported:
868918
type: array
869919
items:
870920
type: string
871-
872-
873-
response_types_supported:
921+
scopes_supported:
922+
type: array
923+
items:
924+
type: string
925+
code_challenge_methods_supported:
926+
type: array
927+
items:
928+
type: string
929+
capabilities:
874930
type: array
875931
items:
876932
type: string
877-
878-
fhir_metadata_uri:
879-
type: string
880933

881934
V1UserInfo:
882935
properties:
@@ -913,13 +966,13 @@ components:
913966
type: string
914967

915968
examples:
916-
V1OpenIdConfigurationExample:
969+
OpenIdConfigurationExample:
917970
value:
918971
issuer: 'https://sandbox.bluebutton.cms.gov'
919-
authorization_endpoint: 'https://sandbox.bluebutton.cms.gov/v1/o/authorize/'
920-
revocation_endpoint: 'https://sandbox.bluebutton.cms.gov/v1/o/revoke/'
921-
token_endpoint: 'https://sandbox.bluebutton.cms.gov/v1/o/token/'
922-
userinfo_endpoint: 'https://sandbox.bluebutton.cms.gov/v1/connect/userinfo'
972+
authorization_endpoint: 'https://sandbox.bluebutton.cms.gov/v2/o/authorize/'
973+
revocation_endpoint: 'https://sandbox.bluebutton.cms.gov/v2/o/revoke/'
974+
token_endpoint: 'https://sandbox.bluebutton.cms.gov/v2/o/token/'
975+
userinfo_endpoint: 'https://sandbox.bluebutton.cms.gov/v2/connect/userinfo'
923976
ui_locales_supported:
924977
- en-US
925978
service_documentation: 'https://bluebutton.cms.gov/developers'
@@ -930,28 +983,46 @@ components:
930983
response_types_supported:
931984
- code
932985
- token
933-
fhir_metadata_uri: 'https://sandbox.bluebutton.cms.gov/v1/fhir/metadata'
934-
935-
V2OpenIdConfigurationExample:
986+
fhir_metadata_uri: 'https://sandbox.bluebutton.cms.gov/v2/fhir/metadata
987+
988+
SmartConfigurationExample:
936989
value:
937-
issuer: 'https://sandbox.bluebutton.cms.gov'
938990
authorization_endpoint: 'https://sandbox.bluebutton.cms.gov/v2/o/authorize/'
939-
revocation_endpoint: 'https://sandbox.bluebutton.cms.gov/v2/o/revoke/'
991+
revocation_endpoint: 'https://sandbox.bluebutton.cms.gov/v2/o/revoke_token/'
940992
token_endpoint: 'https://sandbox.bluebutton.cms.gov/v2/o/token/'
941-
userinfo_endpoint: 'https://sandbox.bluebutton.cms.gov/v2/connect/userinfo'
942-
ui_locales_supported:
943-
- en-US
944-
service_documentation: 'https://bluebutton.cms.gov/developers'
945-
op_tos_uri: 'https://bluebutton.cms.gov/terms'
946993
grant_types_supported:
947994
- authorization_code
948-
- refresh_token
949995
response_types_supported:
950996
- code
951997
- token
952-
fhir_metadata_uri: 'https://sandbox.bluebutton.cms.gov/v2/fhir/metadata'
998+
scopes_supported:
999+
- openid
1000+
- profile
1001+
- launch/patient
1002+
- patient/Patient.read
1003+
- patient/ExplanationOfBenefit.read
1004+
- patient/Coverage.read
1005+
- patient/Patient.r
1006+
- patient/ExplanationOfBenefit.r
1007+
- patient/Coverage.r
1008+
- patient/Patient.s
1009+
- patient/ExplanationOfBenefit.s
1010+
- patient/Coverage.s
1011+
- patient/Patient.rs
1012+
- patient/ExplanationOfBenefit.rs
1013+
- patient/Coverage.rs
1014+
code_challenge_methods_supported:
1015+
- S256
1016+
capabilities:
1017+
- client-confidential-symmetric
1018+
- client-confidential-asymmetric
1019+
- context-standalone-patient
1020+
- launch-standalone
1021+
- permission-offline
1022+
- permission-patient
1023+
- permission-v1
1024+
- authorize-post
9531025

954-
9551026
V1FhirMetadataExample:
9561027
value:
9571028
resourceType: CapabilityStatement

0 commit comments

Comments
 (0)