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.

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-7446 - update content-type header for OperationOutcome responses to fhir+json #873

Merged
merged 3 commits into from
Oct 12, 2023

Conversation

alex-dzeda
Copy link
Contributor

🎫 Ticket

https://jira.cms.gov/browse/BCDA-7446

🛠 Changes

Changed Content-Type header for OperationOutcome error responses from application/json to application/fhir+json in both v1+v2 of the BCDA API

ℹ️ Context for reviewers

From: https://build.fhir.org/ig/HL7/bulk-data/export.html#response---error-status-1
According to the Bulk FHIR Export IG, OperationOutcome responses should respond with Content-Type of application/fhir+json. This is a one line change that will enhance the conformance of the BCDA application with respect to the bulk FHIR IG.
image

✅ Acceptance Validation

Unit test on requests.api updated to check for the applicable content-type header in the case of an OperationOutcome response.

🔒 Security Implications

  • This PR adds a new software dependency or dependencies.
  • This PR modifies or invalidates one or more of our security controls.
  • This PR stores or transmits data that was not stored or transmitted before.
  • This PR requires additional review of its security implications for other reasons.

If any security implications apply, add Jason Ashbaugh (GitHub username: StewGoin) as a reviewer and do not merge this PR without his approval.

@codecov-commenter
Copy link

Codecov Report

Merging #873 (a9658b1) into master (e047997) will increase coverage by 0.03%.
The diff coverage is 100.00%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #873      +/-   ##
==========================================
+ Coverage   79.21%   79.24%   +0.03%     
==========================================
  Files          92       92              
  Lines       10435    10436       +1     
==========================================
+ Hits         8266     8270       +4     
+ Misses       1638     1636       -2     
+ Partials      531      530       -1     
Files Coverage Δ
bcda/responseutils/v2/writer.go 90.07% <100.00%> (+0.03%) ⬆️
bcda/responseutils/writer.go 90.11% <100.00%> (ø)

... and 2 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e047997...a9658b1. Read the comment docs.

Copy link
Contributor

@kyeah kyeah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thank you! Can you add the Jira ticket ID in the PR title? :)

@alex-dzeda alex-dzeda changed the title update content-type header for OperationOutcome responses to fhir+json BCDA-7446 - update content-type header for OperationOutcome responses to fhir+json Oct 10, 2023
@alex-dzeda
Copy link
Contributor Author

Will be merged for next release; keeping it out of main until there's been at least a few days of commenting on google group post.

@alex-dzeda alex-dzeda merged commit 1234392 into master Oct 12, 2023
1 check passed
@alex-dzeda alex-dzeda deleted the alex/bcda-fhircontenttype branch October 12, 2023 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants