Skip to content

BFD-4489: Remove TIN from v1 & v2#2956

Draft
malessi wants to merge 11 commits intomasterfrom
alessio/BFD-4489__remove-itn-v1-v2
Draft

BFD-4489: Remove TIN from v1 & v2#2956
malessi wants to merge 11 commits intomasterfrom
alessio/BFD-4489__remove-itn-v1-v2

Conversation

@malessi
Copy link
Collaborator

@malessi malessi commented Jan 15, 2026

JIRA Ticket:
BFD-4489

What Does This PR Do?

This PR completely removes IncludeTaxNumbers from the resource provider and transformer layer of the BFD v1/v2 Server. Essentially, v1/v2 will now default to never including tax number information in any responses.

Note that not all tax number related code has been removed from v1/v2, only the minimally necessary amount of logic has been removed such that tax number information is not included in responses and tests continue to pass.

What Should Reviewers Watch For?

If you're reviewing this PR, please check for these things in particular:

What Security Implications Does This PR Have?

Please indicate if this PR does any of the following:

  • Adds any new software dependencies

  • Modifies any security controls

  • Adds new transmission or storage of data

  • Any other changes that could possibly affect security?

  • I have considered the above security implications as it relates to this PR. (If one or more of the above apply, it cannot be merged without the ISSO or team security engineer's (@sb-benohe) approval.)

  • I have created tests to sufficiently ensure the reliability of my code, if applicable. If this is a modification to an existing piece of code, I have audited the associated tests to ensure everything works as expected.

Validation

Have you fully verified and tested these changes? Is the acceptance criteria met? Please provide reproducible testing instructions, code snippets, or screenshots as applicable.

  • Running all unit, IT, and E2E tests, verifying that they all pass
  • Sending requests to a locally-running v1/v2 BFD Server specifying _IncludeTaxNumbers and includeTaxNumbers as a query parameter and IncludeTaxNumbers as a header, verifying that:
    • The request still receives a response
    • The response does not contain any tax number information
  • Generating the openapi.yaml document, verifying that IncludeTaxNumbers is no longer documented

shortDefinition = OpenAPIContentProvider.EOB_SERVICE_DATE_SHORT,
value = OpenAPIContentProvider.EOB_SERVICE_DATE_VALUE)
DateRangeParam serviceDate,
@OptionalParam(name = "includeTaxNumbers")
Copy link
Contributor

Choose a reason for hiding this comment

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

We need to leave the parameter alone, otherwise it will cause existing requests that supply this to fail.

Copy link
Contributor

Choose a reason for hiding this comment

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

(Sorry, we discussed this privately, but think I forgot to mention this when we were refining it)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yep, I recall us talking about this. I'll re-add this parameter to all of the relevant resource providers but leave it unused.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done in 20672d0. Verified by:

xh --verify no --cert ... \
  'https://localhost:6500/v2/fhir/ExplanationOfBenefit?patient=-88888888888888&includeTaxNumbers=false' \
  'accept: application/fhir+json'

and

xh --verify no --cert ... \
  'https://localhost:6500/v1/fhir/ExplanationOfBenefit?patient=-88888888888888&includeTaxNumbers=false' \
  'accept: application/fhir+json'

computeMDCKey(MDC_PREFIX, REQUEST_PREFIX, "clientSSL_DN");

/** MDC key for the http request header include tax numbers. */
public static final String HTTP_ACCESS_REQUEST_HEADER_TAX_NUMBERS =
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we leave this? Just because we may want to remove it later and it would be good to track who is actually supplying this still.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, I think that's probably a good idea. I'll revert this.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done in 48b71ba.

@malessi malessi marked this pull request as draft January 27, 2026 16:28
@bfd-sast
Copy link

bfd-sast bot commented Jan 27, 2026

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.

2 participants

Comments