BCDA-7331: Update cURL commands to use V2 and other recommended options #185
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
greg-pf
commented
Sep 21, 2023
_includes/build/bcda_v2.html
Outdated
Comment on lines
17
to
36
| <tr> | ||
| <th>Sample cURL Command in BCDA V1:</th> | ||
| <th>Sample cURL Command in BCDA V2:</th> | ||
| <th>Sample cURL Command in BCDA V1:</th> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <code>curl -X GET 'https://api.bcda.cms.gov/api/v1/Patient/$export' \ | ||
| -H "accept: application/fhir+json" \ | ||
| -H "Prefer: respond-async" \ | ||
| -H "Authorization: Bearer {access_token}"</code> | ||
| <pre><code>curl -X GET 'https://api.bcda.cms.gov/api/v2/Group/all/$export' \ | ||
| -H "accept: application/fhir+json" \ | ||
| -H "Prefer: respond-async" \ | ||
| -H "Authorization: Bearer {access_token}" | ||
| -v</code></pre> | ||
| </td> | ||
| <td> | ||
| <code>curl -X GET 'https://api.bcda.cms.gov/api/v2/Patient/$export' \ | ||
| -H "accept: application/fhir+json" \ | ||
| -H "Prefer: respond-async" \ | ||
| -H "Authorization: Bearer {access_token}"</code> | ||
| </td> | ||
| <pre><code>curl -X GET 'https://api.bcda.cms.gov/api/v1/Group/all/$export' \ | ||
| -H "accept: application/fhir+json" \ | ||
| -H "Prefer: respond-async" \ | ||
| -H "Authorization: Bearer {access_token}" | ||
| -v</code></pre> | ||
| </td> | ||
| </tr> |
There was a problem hiding this comment.
There are a couple things changed here that might get lost in the squashed commits
- Put V2 commands in the left column, and V1 in the right
- Update commands to use
/Group/allinstead of/Patient - Format the commands so they are easier to read
Old:
New:
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🎫 Ticket
https://jira.cms.gov/browse/BCDA-7331
🛠 Changes
/Group/allin our general guidanceℹ️ Context for reviewers
Some changes to align with recommended use of the API. Encourage use of BCDA V2 over V1 and the /Group endpoint over the /Patient endpoint. There are some other very minor changes to content to align with the updated code samples, but a more comprehensive review of the guidance is planned in BCDA-7330
✅ Acceptance Validation
Executed the new sandbox curl commands locally and inspected static site visually on stage.bcda.cms.gov
🔒 Security Implications
If any security implications apply, add Jason Ashbaugh (GitHub username: StewGoin) as a reviewer and do not merge this PR without his approval.