Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BCDA-8113: Escape export operator and fix credential rendering #199

Merged
merged 4 commits into from
May 14, 2024
Merged

BCDA-8113: Escape export operator and fix credential rendering #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7dc770b
static site updates to escape export
alex-dzeda May 10, 2024
7538c6d
add other files
alex-dzeda May 10, 2024
0d5f5b3
add note about escaping on powershell
alex-dzeda May 14, 2024
9f9dfdf
fix capitalization
alex-dzeda May 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _includes/build/bcda_v2.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ <h2>
</tr>
<tr>
<td>
<pre><code>curl -X GET "https://api.bcda.cms.gov/api/v2/Group/all/$export" \
<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>
<pre><code>curl -X GET "https://api.bcda.cms.gov/api/v1/Group/all/$export" \
<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}" \
Expand Down
6 changes: 3 additions & 3 deletions _includes/build/requesting_data_all_three.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,19 @@ <h4>Request Headers</h4>
<h4>cURL Commands to start a job</h4>
<ol>
<li>
<pre><code>curl -X GET "https://api.bcda.cms.gov/api/v2/Group/all/$export" \
<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 <span style="color: #046B99;">{access_token}</span>"</code></pre>
</li>
<li>
<pre><code>curl -X GET "https://api.bcda.cms.gov/api/v2/Group/all/$export?_type=ExplanationOfBenefit,Patient" \
<pre><code>curl -X GET "https://api.bcda.cms.gov/api/v2/Group/all/\$export?_type=ExplanationOfBenefit,Patient" \
-H "accept: application/fhir+json" \
-H "Prefer: respond-async" \
-H "Authorization: Bearer <span style="color: #046B99;">{access_token}</span>"</code></pre>
</li>
<li>
<pre><code>curl -X GET "https://api.bcda.cms.gov/api/v2/Group/all/$export?_type=Patient" \
<pre><code>curl -X GET "https://api.bcda.cms.gov/api/v2/Group/all/\$export?_type=Patient" \
-H "accept: application/fhir+json" \
-H "Prefer: respond-async" \
-H "Authorization: Bearer <span style="color: #046B99;">{access_token}</span>"</code></pre>
Expand Down
6 changes: 3 additions & 3 deletions _includes/build/requesting_data_runouts.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@ <h4>Request Headers</h4>
<h4>cURL Commands to start a job</h4>
<ol>
<li>
<pre><code>curl -X GET "https://api.bcda.cms.gov/api/v2/Group/runout/$export" \
<pre><code>curl -X GET "https://api.bcda.cms.gov/api/v2/Group/runout/\$export" \
-H "accept: application/fhir+json" \
-H "Prefer: respond-async" \
-H "Authorization: Bearer <span style="color: #046B99;">{access_token}</span>"</code></pre>
</li>
<li>
<pre><code>curl -X GET "https://api.bcda.cms.gov/api/v2/Group/runout/$export?_type=ExplanationOfBenefit,Patient" \
<pre><code>curl -X GET "https://api.bcda.cms.gov/api/v2/Group/runout/\$export?_type=ExplanationOfBenefit,Patient" \
-H "accept: application/fhir+json" \
-H "Prefer: respond-async" \
-H "Authorization: Bearer <span style="color: #046B99;">{access_token}</span>"</code></pre>
</li>
<li>
<pre><code>curl -X GET "https://api.bcda.cms.gov/api/v2/Group/runout/$export?_type=Patient" \
<pre><code>curl -X GET "https://api.bcda.cms.gov/api/v2/Group/runout/\$export?_type=Patient" \
-H "accept: application/fhir+json" \
-H "Prefer: respond-async" \
-H "Authorization: Bearer <span style="color: #046B99;">{access_token}</span>"</code></pre>
Expand Down
2 changes: 1 addition & 1 deletion _includes/build/requesting_filtered_data_since_Group.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ <h4>Request Headers</h4>
</code></pre>

<h4>cURL Command using the _since parameter within the /Group endpoint</h4>
<pre><code>curl -X GET "https://api.bcda.cms.gov/api/v2/Group/all/$export?_type=Patient&_since=2020-02-13T08:00:00.000-05:00" \
<pre><code>curl -X GET "https://api.bcda.cms.gov/api/v2/Group/all/\$export?_type=Patient&_since=2020-02-13T08:00:00.000-05:00" \
-H "Accept: application/fhir+json" \
-H "Prefer: respond-async" \
-H "Authorization: Bearer <span style="color: #046B99;">{access_token}</span>"</code></pre>
Expand Down
2 changes: 1 addition & 1 deletion _includes/build/requesting_filtered_data_since_Patient.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ <h4>Request Headers</h4>
</code></pre>

<h4>cURL Command using the _since parameter within the /Patient endpoint</h4>
<pre><code>curl -X GET "https://api.bcda.cms.gov/api/v2/Patient/$export?_type=Patient&_since=2020-02-13T08:00:00.000-05:00" \
<pre><code>curl -X GET "https://api.bcda.cms.gov/api/v2/Patient/\$export?_type=Patient&_since=2020-02-13T08:00:00.000-05:00" \
-H "Accept: application/fhir+json" \
-H "Prefer: respond-async" \
-H "Authorization: Bearer <span style="color: #046B99;">{access_token}</span>"</code></pre>
Expand Down
4 changes: 2 additions & 2 deletions _includes/guide/bcda_v2.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ <h2>
</tr>
<tr>
<td>
<pre><code>curl -X GET "https://sandbox.bcda.cms.gov/api/v2/Group/all/$export" \
<pre><code>curl -X GET "https://sandbox.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>
<pre><code>curl -X GET "https://sandbox.bcda.cms.gov/api/v1/Group/all/$export" \
<pre><code>curl -X GET "https://sandbox.bcda.cms.gov/api/v1/Group/all/\$export" \
-H "accept: application/fhir+json" \
-H "Prefer: respond-async" \
-H "Authorization: Bearer {access_token}" \
Expand Down
6 changes: 3 additions & 3 deletions _includes/guide/try_the_api.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
All requests for BCDA data follow this four step process, as do other APIs following the Bulk FHIR specifications.
</p>
<p>
For more detail for each of these steps and specific information for retrieving production data, see the <a href=/build.html target="_self" class="in-text__link"> Building Your Application</a> page. For this short demo, follow along in your Terminal window or through an application such as Postman.
For more detail for each of these steps and specific information for retrieving production data, see the <a href=/build.html target="_self" class="in-text__link"> Building Your Application</a> page. For this short demo, follow along in your Terminal window or through an application such as Postman. PowerShell users will need to replace backslash characters \ with backticks ` to properly escape the $export operation.
</p>

<h2>
Expand Down Expand Up @@ -74,7 +74,7 @@ <h3>
Sample cURL Command to Submit Credentials for an Access Token
</h3>
<pre><code>curl -d "" -X POST "https://sandbox.bcda.cms.gov/auth/token" \
--user {{site.data.credentials.extra_small.client_id}}:{{site.data.credentials.extra_small.client_secret}} \
--user {{site.data.credentials.sandbox.extra_small.client_id}}:{{site.data.credentials.sandbox.extra_small.client_secret}} \
-H "accept: application/json"</code></pre>

<h3>
Expand Down Expand Up @@ -110,7 +110,7 @@ <h2>
<h3>
Sample cURL Command to Start a Job
</h3>
<pre><code>curl -X GET "https://sandbox.bcda.cms.gov/api/v2/Group/all/$export" \
<pre><code>curl -X GET "https://sandbox.bcda.cms.gov/api/v2/Group/all/\$export" \
-H "accept: application/fhir+json" \
-H "Prefer: respond-async" \
-H "Authorization: Bearer <span style="color: #046B99;">{access_token}</span>" \
Expand Down
2 changes: 1 addition & 1 deletion _includes/partial/faq.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
</div>
<p>Access to the Claim and ClaimResponse resources is handled within BCDA on a per ACO (Accountable Care Organization) ID level. There are no required changes to credentials for those REACH ACOs who would like access to the V2 endpoint. The BCDA V2 service supports the same functionality as V1 API endpoints in both the sandbox and production API environments. All V2 endpoints should work as described in the existing BCDA documentation. To transition from V1 to your BCDA V2 endpoints, replace ‘v1’ in the API call URLs with ‘v2’, as in the cURL example below:
</p>
<pre><code>curl -X GET "https://sandbox.bcda.cms.gov/api/v1/Patient/$export" \
<pre><code>curl -X GET "https://sandbox.bcda.cms.gov/api/v1/Patient/\$export" \
-H "accept: application/fhir+json" \
-H "Prefer: respond-async" \
-H "Authorization: Bearer <span style="color: #046B99;">{access_token}</span>" \
Expand Down
Loading