Skip to content

Commit 678bbd9

Browse files
gmaciolekajshreddtisza1
authored
updates based on Rachel feedback (#19)
* added info to license section note re: security review * updated foo/bar variables to your_client_id/your_client_secret * fixed spelling mistake and grammatical errors * Small update that was outstanding from tester feedback * Update README.md * Update README.md Co-authored-by: David Tisza <36048547+dtisza1@users.noreply.github.com> Co-authored-by: Adrian Jones <adrian.jones@adhocteam.us> Co-authored-by: David Tisza <36048547+dtisza1@users.noreply.github.com>
1 parent c8c5e7f commit 678bbd9

1 file changed

Lines changed: 32 additions & 32 deletions

File tree

README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To learn how to create a sandbox account and generate a sample access token, see
2626
## Installation <a name="installation"></a>
2727

2828
```bash
29-
$ pip install cms-bluebutton-sdk
29+
pip install cms-bluebutton-sdk
3030
```
3131

3232
## Configuration Parameters<a name="configuration-parameters"></a>
@@ -37,17 +37,17 @@ Required SDK configuration parameters include:
3737
| ------------- | ------------------------------- |----| --------------------------------------- |
3838
| `environment` | `SANDBOX` or `PRODUCTION` |`SANDBOX` | Blue Button 2.0 API environment |
3939
| `version` | `1` or `2` | `2` | Blue Button 2.0 version |
40-
| `client_id` | *`foo`* | |OAuth2.0 client ID of the app |
41-
| `client_secret` | *`bar`* | |OAuth2.0 client secret of the app |
42-
| `callback_url` | *`https://www.example.com/callback`* | |OAuth2.0 callback URL of the app |
40+
| `client_id` | *`your_client_id`* | |OAuth2.0 client ID of your app |
41+
| `client_secret` | *`your_client_secret`* | |OAuth2.0 client secret of your app |
42+
| `callback_url` | *`https://www.example.com/callback`* | |OAuth2.0 callback URL of your app |
4343

4444

4545
### Access Token Refresh on Expire
4646
SDK FHIR requests check whether the access token is expired before the data end point call. By default, if the access token is expired, the token in the current token object refreshes. Disable token refresh by setting `token_refresh_on_expire` to `false`.
4747

4848
### FHIR Requests Retry Settings
4949

50-
Retry is enabled by default for FHIR requests. The folllowing parameters are available for exponential back off retry algorithm.
50+
Retry is enabled by default for FHIR requests. The folllowing parameters are available for the exponential back off retry algorithm.
5151

5252
| Retry parameter | Value (default) | Description |
5353
| ----------------- | -------------------- | -------------------------------- |
@@ -79,9 +79,9 @@ Sample configuration JSON with default version and environment:
7979

8080
```
8181
{
82-
"client_id": "foo",
83-
"client_secret": "bar",
84-
"callback_url": "https://www.fake.com/",
82+
"client_id": "your_client_id",
83+
"client_secret": "your_client_secret",
84+
"callback_url": "https://www.example.com/",
8585
}
8686
8787
```
@@ -92,9 +92,9 @@ Example:
9292

9393
```
9494
{
95-
"client_id": "foo",
96-
"client_secret": "bar",
97-
"callback_url": "https://www.fake.com/",
95+
"client_id": "your_client_id",
96+
"client_secret": "your_client_secret",
97+
"callback_url": "https://www.example.com/",
9898
"version": "2",
9999
"environment": "PRODUCTION"
100100
}
@@ -111,9 +111,9 @@ There are three ways to configure the SDK when instantiating a `BlueButton` clas
111111
```python
112112
bb = BlueButton({
113113
"environment": "PRODUCTION",
114-
"client_id": "foo",
115-
"client_secret": "bar",
116-
"callback_url": "https://www.fake.com/callback",
114+
"client_id": "your_client_id",
115+
"client_secret": "your_client_secret",
116+
"callback_url": "https://www.example.com/callback",
117117
"version": 2,
118118
"retry_settings": {
119119
"total": 3,
@@ -134,9 +134,9 @@ There are three ways to configure the SDK when instantiating a `BlueButton` clas
134134
```json
135135
{
136136
"environment": "SANDBOX",
137-
"client_id": "foo",
138-
"client_secret": "bar",
139-
"callback_url": "https://www.fake.com/callback",
137+
"client_id": "your_client_id",
138+
"client_secret": "your_client_secret",
139+
"callback_url": "https://www.example.com/callback",
140140
"version": 2,
141141
"retry_settings": {
142142
"total": 3,
@@ -157,9 +157,9 @@ There are three ways to configure the SDK when instantiating a `BlueButton` clas
157157
- Example YAML in file:
158158
```yaml
159159
environment: "SANDBOX"
160-
client_id: "foo"
161-
client_secret: "bar"
162-
callback_url: "https://www.fake.com/callback"
160+
client_id: "id"
161+
client_secret: "your_client_secret"
162+
callback_url: "https://www.example.com/callback"
163163
version: 2
164164
```
165165

@@ -220,7 +220,7 @@ def authorization_callback():
220220
# patient info access granted
221221

222222
"""
223-
1. access token scope where demagraphic info included:
223+
1. access token scope where demographic info included:
224224
225225
scope: [
226226
"patient/Coverage.read",
@@ -251,16 +251,16 @@ def authorization_callback():
251251
eob_data = eob_data['response'].json()
252252
result['eob_data'] = eob_data
253253

254-
# fhir search response can contain large number of resources,
255-
# e.g. it is not unusual an EOB search of a beneficiary would result
256-
# in hundreds of EOB resources, by default they are chunked into pages
257-
# of 10 resources each, e.g. the above call bb.get_explaination_of_benefit_data(config)
258-
# return the 1st page of EOBs, in the format of a FHIR bundle resource
259-
# with a link section where page navigation urls with the link name as:
260-
# 'first', 'last', 'self', 'next', 'previous', which indicating the
261-
# pagination relation relative to the current page.
262-
263-
# Use bb.get_pages(data, config) to get all the pages
254+
# A FHIR search response can result in a large number of resources.
255+
# For example, an EOB search of a beneficiary could return hundreds
256+
# of resources. By default, search results are grouped into
257+
# pages with 10 resources each. For example,
258+
# bb.get_explaination_of_benefit_data(config) returns the
259+
# first page of resources as a FHIR bundle with a link section
260+
# of page navigation URLs. Pagination link names include
261+
# 'first,' 'last,' 'self,' next,' and 'previous.'
262+
# To get all the pages, use bb.get_pages(data, config).
263+
264264
eob_pages = bb.get_pages(eob_data, config)
265265
result['eob_pages'] = eob_pages['pages']
266266
auth_token = eob_pages['auth_token']
@@ -299,7 +299,7 @@ The [Blue Button 2.0 API](https://bluebutton.cms.gov/) provides Medicare enrolle
299299
## License<a name="license"></a>
300300
The CMS Blue Button 2.0 Python SDK is licensed under the Creative Commons Zero v1.0 Universal. For more details, see [License](https://github.com/CMSgov/cms-bb2-python-sdk/blob/main/LICENSE).
301301

302-
*Note: We do our best to keep our SDKs up to date with vulnerability patching, but you are responsible for conducting your own review and testing before implementation.*
302+
*Note: We do our best to keep our SDKs up to date with vulnerability patching and security testing, but you are responsible for your own review and testing before implementation.*
303303

304304
## Help and Support <a name="help"></a>
305305

0 commit comments

Comments
 (0)