diff --git a/_includes/build/best_practices_429.html b/_includes/build/best_practices_429.html new file mode 100644 index 0000000..33a8833 --- /dev/null +++ b/_includes/build/best_practices_429.html @@ -0,0 +1,8 @@ +
+

A status code of 429 indicates “Too Many Requests.” This can occur due to two reasons:

+
    +
  1. Making too many HTTP requests within a period of time
  2. +
  3. Trying to recreate jobs already marked as "In-Progress.” For reference, you can view both existing and past jobs using the /jobs endpoint. See Request Jobs History for more details.
  4. +
+

Regardless of the reason, you will see a Retry-After response in the header. Wait until the period of time specified in the header has passed before making any more requests. This makes sure your client can adapt without manual intervention, even if the rate-limiting parameters change.

+
\ No newline at end of file diff --git a/_includes/build/requesting_data_runouts.html b/_includes/build/requesting_data_runouts.html index e18ee8e..c18930b 100644 --- a/_includes/build/requesting_data_runouts.html +++ b/_includes/build/requesting_data_runouts.html @@ -61,9 +61,10 @@

Start a Job using 'runout' with /Group Explanation

If the request was successful, a 202 Accepted response code will be returned and the response will include a Content-Location header. The value of the Content-Location header indicates the location to check for job status and outcome. In the example header above, the number 42 in the URL represents the ID of the export job. The claims returned in the job will be filtered to have a serviceDate of 12/31/2020 or before.

-

- If you're already requesting data from one endpoint and try to request data from that endpoint again while the first request is processing, you'll receive a 429 Too Many Requests error. -

+

+ If you're already requesting data from one endpoint and try to request data from that endpoint again while the first request is processing, you'll receive a 429 Too Many Requests error. For guidance on how to handle 429 errors, refer to our best practices. +

+

Step 3: Check the job status

See Step 3: Check the job status in the Request Data section above.

diff --git a/_includes/data/data_dictionary.html b/_includes/data/data_dictionary.html index 74e2b44..d96cfbb 100644 --- a/_includes/data/data_dictionary.html +++ b/_includes/data/data_dictionary.html @@ -1,9 +1,9 @@

- BCDA provides CCLF to BCDA Data Dictionary to customers to facilitate their data mapping process. + BCDA provides the CCLF to BCDA Data Dictionary to customers to facilitate their data mapping process.

- The Data Dictionary was last updated in November 2023. + The Data Dictionary was last updated in March 2024.

Because BCDA delivers data in the FHIR format, data field names will be different from data fields delivered through CCLF files. In this spreadsheet, BCDA has provided a crosswalk between all CCLF data fields and their new locations within BCDA claims files. The BCDA Data Dictionary also provides supplementary context for each of the CCLF/BCDA data fields, including: diff --git a/assets/data/BCDA_Data_Dictionary.xlsx b/assets/data/BCDA_Data_Dictionary.xlsx index 236f62b..ad4a3c9 100644 Binary files a/assets/data/BCDA_Data_Dictionary.xlsx and b/assets/data/BCDA_Data_Dictionary.xlsx differ diff --git a/build.html b/build.html index 04a97f1..f6a7118 100644 --- a/build.html +++ b/build.html @@ -116,6 +116,20 @@ + + +

  • + + Best Practices + + +
  • @@ -266,6 +280,20 @@

    + +
    +

    + Best Practices +

    +
    +

    + Handling 429 status codes +

    +
    + {% include build/best_practices_429.html %} +
    +
    +
    \ No newline at end of file