Improve error message for export operations in batch/transaction bundles by tranhoangtu-it · Pull Request #5475 · microsoft/fhir-server

tranhoangtu-it · 2026-03-30T20:10:50Z

Summary

When users include a $export operation in a batch or transaction bundle, the server previously returned a cryptic error: "Value supplied for the 'Accept' header is not supported." This occurs because the internal bundle routing cannot set the required Accept and Prefer headers that export operations depend on.

Changes

BundleHandler.cs: Added early detection of $export URLs in bundle entries. Returns a clear RequestNotValidException with an informative error message before the request enters the routing pipeline.
Resources.resx / Resources.Designer.cs: Added new resource string ExportOperationNotSupportedInBundle.

New error message

Export operations ($export) are not supported within batch or transaction bundles. Please submit export requests as standalone operations.

This returns HTTP 400 with OperationOutcome.issue.code = "invalid", which aligns with the FHIR specification for invalid request parameters.

Test plan

Submit a bundle with $export entry → receives clear error message
Submit a bundle without $export → processes normally (no regression)
Standalone $export requests → continue to work as before

Third contribution as a certified HL7 FHIR Implementer. Also building FHIRBridge — an open-source FHIR integration toolkit.

…t#1459) When a $export operation is included in a batch or transaction bundle, the server previously returned a cryptic "Accept header is not supported" error because the internal routing couldn't set the required export-specific headers. Now detects $export URLs early in bundle entry processing and returns a clear error: "Export operations ($export) are not supported within batch or transaction bundles."

tranhoangtu-it · 2026-03-30T20:11:06Z

Required metadata labels:

Enhancement (type — improved error message)
Open source only (release target)
No-PaaS-breaking-change
No-ADR

Copilot

Pull request overview

Improves the server’s response when a $export operation is included inside a batch/transaction Bundle, replacing a downstream “unsupported Accept header” failure with an explicit, user-friendly validation error before routing.

Changes:

Add an early guard in bundle request generation to detect $export URLs and fail fast with a clearer exception.
Introduce a new localized resource string for the error message.
Regenerate the resources designer accessor for the new string.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.

File	Description
`src/Microsoft.Health.Fhir.Shared.Api/Features/Resources/Bundle/BundleHandler.cs`	Adds early detection of `$export` in bundle entry request URLs and throws a validation exception with a clearer message.
`src/Microsoft.Health.Fhir.Core/Resources.resx`	Adds `ExportOperationNotSupportedInBundle` string used by the new validation path.
`src/Microsoft.Health.Fhir.Core/Resources.Designer.cs`	Adds the strongly-typed accessor for the new resource string.

Files not reviewed (1)

src/Microsoft.Health.Fhir.Core/Resources.Designer.cs: Language not supported

Copilot · 2026-03-30T20:14:15Z

src/Microsoft.Health.Fhir.Shared.Api/Features/Resources/Bundle/BundleHandler.cs

+            if (requestUrl != null && requestUrl.Contains("$export", StringComparison.OrdinalIgnoreCase))
+            {
+                throw new RequestNotValidException(Core.Resources.ExportOperationNotSupportedInBundle);


The $export detection uses requestUrl.Contains("$export", ...), which will also match query-string values (e.g., Patient?name=$export) and can falsely reject non-export requests. Consider parsing requestUrl as a Uri and checking only the path segments for a segment equal to $export (after unescaping), rather than searching the full URL string.

Suggested change

if (requestUrl != null && requestUrl.Contains("$export", StringComparison.OrdinalIgnoreCase))

{

throw new RequestNotValidException(Core.Resources.ExportOperationNotSupportedInBundle);

if (!string.IsNullOrEmpty(requestUrl))

{

Uri exportDetectionUri = new Uri(LocalHost, requestUrl);

string exportDetectionPath = exportDetectionUri.GetComponents(UriComponents.Path, UriFormat.Unescaped);

bool hasExportPathSegment = exportDetectionPath

.Split(new[] { '/' }, StringSplitOptions.RemoveEmptyEntries)

.Any(segment => segment.Equals("$export", StringComparison.OrdinalIgnoreCase));

if (hasExportPathSegment)

{

throw new RequestNotValidException(Core.Resources.ExportOperationNotSupportedInBundle);

}

Copilot · 2026-03-30T20:14:15Z

src/Microsoft.Health.Fhir.Shared.Api/Features/Resources/Bundle/BundleHandler.cs

+            if (requestUrl != null && requestUrl.Contains("$export", StringComparison.OrdinalIgnoreCase))
+            {
+                throw new RequestNotValidException(Core.Resources.ExportOperationNotSupportedInBundle);
+            }


This throws RequestNotValidException with the default issue type (invalid). Since the message explicitly says the operation is not supported (and the linked issue asks for Not Supported), pass OperationOutcomeConstants.IssueType.NotSupported (or use an exception type that sets it) so OperationOutcome.issue.code matches the semantics.

Copilot · 2026-03-30T20:14:16Z

src/Microsoft.Health.Fhir.Shared.Api/Features/Resources/Bundle/BundleHandler.cs

+            // Export operations are not supported within bundles (batch or transaction).
+            // Return a clear error instead of the cryptic Accept header error that occurs
+            // when the internal routing fails to set required export headers.
+            if (requestUrl != null && requestUrl.Contains("$export", StringComparison.OrdinalIgnoreCase))
+            {
+                throw new RequestNotValidException(Core.Resources.ExportOperationNotSupportedInBundle);
+            }


There are existing xUnit tests for bundle handling under src/Microsoft.Health.Fhir.Shared.Api.UnitTests/Features/Resources/Bundle/, but this new $export-in-bundle guard is not covered. Add a unit test that submits a batch/transaction bundle containing an entry with a $export URL and asserts the thrown exception/OperationOutcome contains the new resource message (and the intended issue type).

@tranhoangtu-it could you add a unit test for this in BundleHandlerTests.cs?

… type - Split URL on '?' to check path only, avoiding false positive on query strings like Patient?name=$export - Use OperationOutcomeConstants.IssueType.NotSupported per issue requirement and FHIR spec for unsupported operations

tranhoangtu-it · 2026-03-30T20:42:03Z

Addressed Copilot review:

False positive on query strings — Now splits URL on ? and only checks the path component. Patient?name=$export no longer triggers the guard.
Issue type — Changed to OperationOutcomeConstants.IssueType.NotSupported per the issue requirement and FHIR spec (the operation is not supported in this context, not invalid).
Unit test — Will add in follow-up.

Copilot

Pull request overview

Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.

Files not reviewed (1)

src/Microsoft.Health.Fhir.Core/Resources.Designer.cs: Language not supported

Copilot · 2026-04-02T16:02:11Z

src/Microsoft.Health.Fhir.Shared.Api/Features/Resources/Bundle/BundleHandler.cs

+                string path = requestUrl.Split('?')[0];
+                if (path.Contains("$export", StringComparison.OrdinalIgnoreCase))


Local variable path declared here conflicts with the existing string path = ... later in GenerateRequest (C# disallows redeclaring a local from an enclosing scope), which will cause a build error (CS0136). Rename this variable (e.g., requestPath) or reuse the later URI-parsed path for the $export check to avoid duplicate parsing.

Suggested change

string path = requestUrl.Split('?')[0];

if (path.Contains("$export", StringComparison.OrdinalIgnoreCase))

string requestPath = requestUrl.Split('?')[0];

if (requestPath.Contains("$export", StringComparison.OrdinalIgnoreCase))

Copilot · 2026-04-02T16:02:12Z

src/Microsoft.Health.Fhir.Shared.Api/Features/Resources/Bundle/BundleHandler.cs

+                    throw new RequestNotValidException(
+                        Core.Resources.ExportOperationNotSupportedInBundle,
+                        OperationOutcomeConstants.IssueType.NotSupported);
+                }


PR description states this should return OperationOutcome.issue.code = "invalid", but the code throws RequestNotValidException with IssueType.NotSupported (which maps to not-supported). Either update the PR description/test plan to reflect not-supported, or change the issue type here to Invalid if that’s the intended behavior.

Copilot · 2026-04-02T16:02:12Z

src/Microsoft.Health.Fhir.Shared.Api/Features/Resources/Bundle/BundleHandler.cs

+            // Export operations are not supported within bundles (batch or transaction).
+            // Return a clear error instead of the cryptic Accept header error that occurs
+            // when the internal routing fails to set required export headers.
+            // Check the path component only to avoid false positives from query string values.
+            if (requestUrl != null)
+            {
+                string path = requestUrl.Split('?')[0];
+                if (path.Contains("$export", StringComparison.OrdinalIgnoreCase))
+                {
+                    throw new RequestNotValidException(
+                        Core.Resources.ExportOperationNotSupportedInBundle,
+                        OperationOutcomeConstants.IssueType.NotSupported);
+                }
+            }


There is an existing unit test (BundleHandlerTests.GivenABundleWithAnExportPost_WhenProcessed_ThenItIsProcessedCorrectly) that currently expects /$export inside a batch bundle to succeed. With this new guard, that test will fail and should be updated (and replaced with assertions that a bundle containing $export returns the new ExportOperationNotSupportedInBundle message and not-supported issue type).

tranhoangtu-it requested a review from a team as a code owner March 30, 2026 20:10

Copilot AI review requested due to automatic review settings March 30, 2026 20:10

Copilot started reviewing on behalf of tranhoangtu-it March 30, 2026 20:11 View session

Copilot AI reviewed Mar 30, 2026

View reviewed changes

LTA-Thinking added the External Author PR is written by an author external to Microsoft label Mar 30, 2026

tranhoangtu-it requested review from LTA-Thinking and Copilot April 2, 2026 15:58

Copilot started reviewing on behalf of tranhoangtu-it April 2, 2026 15:58 View session

Copilot AI reviewed Apr 2, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve error message for export operations in batch/transaction bundles#5475

Improve error message for export operations in batch/transaction bundles#5475
tranhoangtu-it wants to merge 2 commits intomicrosoft:mainfrom
tranhoangtu-it:fix/export-batch-error-message

tranhoangtu-it commented Mar 30, 2026

Uh oh!

tranhoangtu-it commented Mar 30, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 30, 2026

Uh oh!

Copilot AI Mar 30, 2026

Uh oh!

Copilot AI Mar 30, 2026

Uh oh!

LTA-Thinking Apr 1, 2026

Uh oh!

tranhoangtu-it commented Mar 30, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 2, 2026

Uh oh!

Copilot AI Apr 2, 2026

Uh oh!

Copilot AI Apr 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

-            if (requestUrl != null && requestUrl.Contains("$export", StringComparison.OrdinalIgnoreCase))
-            {
-                throw new RequestNotValidException(Core.Resources.ExportOperationNotSupportedInBundle);
+            if (!string.IsNullOrEmpty(requestUrl))
+            {
+                Uri exportDetectionUri = new Uri(LocalHost, requestUrl);
+                string exportDetectionPath = exportDetectionUri.GetComponents(UriComponents.Path, UriFormat.Unescaped);
+                bool hasExportPathSegment = exportDetectionPath
+                    .Split(new[] { '/' }, StringSplitOptions.RemoveEmptyEntries)
+                    .Any(segment => segment.Equals("$export", StringComparison.OrdinalIgnoreCase));
+                if (hasExportPathSegment)
+                {
+                    throw new RequestNotValidException(Core.Resources.ExportOperationNotSupportedInBundle);
+                }

		string path = requestUrl.Split('?')[0];
		if (path.Contains("$export", StringComparison.OrdinalIgnoreCase))

Conversation

tranhoangtu-it commented Mar 30, 2026

Summary

Changes

New error message

Test plan

Uh oh!

tranhoangtu-it commented Mar 30, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

LTA-Thinking Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

tranhoangtu-it commented Mar 30, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants