Search Param UrlLookup and TypeLookup mismatch fix by jestradaMS · Pull Request #5386 · microsoft/fhir-server

jestradaMS · 2026-02-12T23:20:55Z

Description

This pull request addresses a concurrency bug in the FHIR search parameter definition logic and makes related improvements to ensure the consistency and correctness of search parameter handling. The primary change is to ensure that a single canonical instance of each SearchParameterInfo is used across all lookups, preventing issues where updates to search parameter status would not propagate correctly. Additionally, there are minor adjustments to test configurations and a correction to a search parameter type in R5.

Concurrency and Consistency Improvements:

Refactored SearchParameterDefinitionBuilder to use a ConcurrentDictionary<string, SearchParameterInfo> for the URI dictionary and ensure atomic creation and retrieval of SearchParameterInfo instances via GetOrAdd. This guarantees that both UrlLookup and TypeLookup reference the same object, preventing inconsistencies due to race conditions. [1] [2] [3]
Updated the BuildSearchParameterDefinition method and its recursive calls to accept and use the shared uriDictionary, ensuring canonicalization throughout the search parameter inheritance chain. [1] [2] [3]
Modified the logic for adding search parameters to the type lookup so that it always uses the canonical instance from the URI dictionary, ensuring that status and other updates are visible everywhere. [1] [2]

FHIR Search Parameter Type Correction:

Changed the type of the Resource-type search parameter from "special" to "token" in the R5 search parameters JSON, aligning with system support and maintaining compatibility with previous FHIR versions.

Test Configuration Adjustments:

Increased the delay between polling attempts in the reindex E2E tests from 1 second to 5 seconds, likely to reduce flakiness or rate limiting issues.
Raised the initial collection throughput for Cosmos DB in integration tests from 1500 to 5000, potentially to improve test reliability or performance.

Related issues

Addresses AB#183574

Testing

Describe how this change was tested.

FHIR Team Checklist

Update the title of the PR to be succinct and less than 65 characters
Add a milestone to the PR for the sprint that it is merged (i.e. add S47)
Tag the PR with the type of update: Bug, Build, Dependencies, Enhancement, New-Feature or Documentation
Tag the PR with Open source, Azure API for FHIR (CosmosDB or common code) or Azure Healthcare APIs (SQL or common code) to specify where this change is intended to be released.
Tag the PR with Schema Version backward compatible or Schema Version backward incompatible or Schema Version unchanged if this adds or updates Sql script which is/is not backward compatible with the code.
When changing or adding behavior, if your code modifies the system design or changes design assumptions, please create and include an ADR.
CI is green before merge
Review squash-merge requirements

Semver Change (docs)

Patch|Skip|Feature|Breaking (reason)

… statuses across UrlLookup and TypeLookup

src/Microsoft.Health.Fhir.Core/Features/Definition/SearchParameterDefinitionManager.cs

…xTests

…ved performance

…to streamline search parameter status updates

jestradaMS · 2026-02-13T18:50:36Z

/azp run

azure-pipelines · 2026-02-13T18:50:47Z

Azure Pipelines successfully started running 1 pipeline(s).

…ures

SergeyGaluzo · 2026-02-13T21:52:02Z

src/Microsoft.Health.Fhir.Core/Features/Definition/SearchParameterDefinitionBuilder.cs

@@ -357,30 +353,45 @@ private static HashSet<SearchParameterInfo> BuildSearchParameterDefinition(
            var searchParameterDictionary = new ConcurrentDictionary<string, ConcurrentQueue<SearchParameterInfo>>();
            foreach (SearchParameterInfo searchParam in results)


Consider changing searchParam name here instead of changing it in many places below

SergeyGaluzo · 2026-02-13T21:54:08Z

src/Microsoft.Health.Fhir.Core/Features/Definition/SearchParameterDefinitionBuilder.cs

+                // URL http://hl7.org/fhir/SearchParameter/Resource-type with type Special,
+                // while ResourceTypeSearchParameter uses the same URL with type Token.
+                // Choosing the wrong type causes parser failures for _type queries.
+                SearchParameterInfo canonicalParam = searchParam;


Consider using name that closer identifies what search param origin is. Like searchParamFromUriLookup

SergeyGaluzo · 2026-02-13T22:01:45Z

src/Microsoft.Health.Fhir.Core/Features/Definition/SearchParameterDefinitionBuilder.cs

+                // while ResourceTypeSearchParameter uses the same URL with type Token.
+                // Choosing the wrong type causes parser failures for _type queries.
+                SearchParameterInfo canonicalParam = searchParam;
+                if (searchParam.Url != null &&


Is searchParam valid at this point? If so, why do we check that Uri is not null?

SergeyGaluzo · 2026-02-14T00:10:15Z

How about changing our lookup data structures such that it is impossible to get different instances of SearchParameterInfo (SPI) by design?
Imagine that TypeLookup does not have SPI at the bottom but only Uri string. In all the cases when we need to get SPI from TypeLookup we would just need to do extra lookup in UriLookup. There is no way get incorrect data in SPI's from TypeLookup and UriLookup because SPI is "stored" in a single place by definition.

SergeyGaluzo · 2026-02-14T22:23:32Z

This PR solves atomicity of cache writes for UriLookup. We still don't maintain other 2 data structures (TypeLookup and hash lookup) atomically with UriLookup. It would be interesting to know the reasons for cache components to be out of sync. Is it racing writes or incorrect write workflow?. Please keep in mind that we most likely should remove racing writes and will keep all updates single directional and single threaded (from the database to cache) to have identical logic across all VMs.

test/Microsoft.Health.Fhir.Shared.Tests.E2E/Rest/Reindex/ReindexTests.cs

build/jobs/provision-deploy.yml

samples/templates/default-azuredeploy-docker.json

…roving canonical parameter lookup

…tests

…N files and update SearchParameterDefinitionBuilder to inject _type for missing definitions.

…improved readability

Adding comment to SearchParameterDefinitionDebuilder for R5 vs. R4 difference on Resource-Type search parameter

Add ApplyStatusToAllMatchingObjects method to update search parameter…

c8be4cb

… statuses across UrlLookup and TypeLookup

jestradaMS requested a review from a team as a code owner February 12, 2026 23:20

jestradaMS changed the title ~~[DO NOT REVIEW] UrlLookup and TypeLookup mismatch fix~~ [DO NOT REVIEW] Search Param UrlLookup and TypeLookup mismatch fix Feb 12, 2026

jestradaMS changed the title ~~[DO NOT REVIEW] Search Param UrlLookup and TypeLookup mismatch fix~~ Search Param UrlLookup and TypeLookup mismatch fix Feb 12, 2026

github-advanced-security bot found potential problems Feb 12, 2026

View reviewed changes

src/Microsoft.Health.Fhir.Core/Features/Definition/SearchParameterDefinitionManager.cs Fixed Show fixed Hide fixed

jestradaMS added this to the FY26\Q3\2Wk\2Wk17 milestone Feb 13, 2026

jestradaMS added 7 commits February 12, 2026 18:45

Merge branch 'main' into users/jestrada/searchparamlookupobjectfix

6c9c74c

Reducing WaitForJobCompletionAsync dealy to 10 seconds for E2E Reinde…

0027e85

…xTests

Update Cosmos DB throughput configuration and add autoscale settings

5a1d980

Increase SQL SKU capacity and initial collection throughput for impro…

454bc98

…ved performance

Remove ApplyStatusToAllMatchingObjects method from multiple managers …

9ef4fe1

…to streamline search parameter status updates

Removing changes to status manager

c8917f1

removing white psace change

1df08d3

jestradaMS added 2 commits February 13, 2026 12:54

Reduce delay duration in reindex job polling to improve test efficiency

3a2d81a

Fix canonical parameter lookup to match types and prevent parser fail…

9f361d8

…ures

SergeyGaluzo reviewed Feb 13, 2026

View reviewed changes

SergeyGaluzo reviewed Feb 14, 2026

View reviewed changes

test/Microsoft.Health.Fhir.Shared.Tests.E2E/Rest/Reindex/ReindexTests.cs Show resolved Hide resolved

SergeyGaluzo reviewed Feb 15, 2026

View reviewed changes

build/jobs/provision-deploy.yml Show resolved Hide resolved

SergeyGaluzo reviewed Feb 15, 2026

View reviewed changes

samples/templates/default-azuredeploy-docker.json Show resolved Hide resolved

jestradaMS added 9 commits February 16, 2026 16:10

Merge branch 'main' into users/jestrada/searchparamlookupobjectfix

9d902fc

Fix R4 search parameter definition by injecting missing _type and imp…

5951bb7

…roving canonical parameter lookup

Merge branch 'main' into users/jestrada/searchparamlookupobjectfix

5f12a12

Fix R4 search parameter handling by conditionally injecting _type in …

7fd7487

…tests

Fixing comment

1f58c8d

Remove redundant _type search parameter definition from R4 and R5 JSO…

01cc7c7

…N files and update SearchParameterDefinitionBuilder to inject _type for missing definitions.

Add missing line breaks in SearchParameterDefinitionBuilderTests for …

1d57516

…improved readability

removing white space

fff9b4b

Add Resource-type search parameter definition to R4 and R5 JSON files

cd242cf

Adding comment to SearchParameterDefinitionDebuilder for R5 vs. R4 difference on Resource-Type search parameter

jestradaMS marked this pull request as draft February 19, 2026 15:44

jestradaMS closed this Feb 19, 2026

jestradaMS deleted the users/jestrada/searchparamlookupobjectfix branch February 19, 2026 19:34

jestradaMS mentioned this pull request Feb 19, 2026

Refactor Search Parameter Info Management #5400

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Search Param UrlLookup and TypeLookup mismatch fix#5386

Search Param UrlLookup and TypeLookup mismatch fix#5386
jestradaMS wants to merge 19 commits intomainfrom
users/jestrada/searchparamlookupobjectfix

jestradaMS commented Feb 12, 2026 •

edited

Loading

Uh oh!

Uh oh!

jestradaMS commented Feb 13, 2026

Uh oh!

azure-pipelines bot commented Feb 13, 2026

Uh oh!

SergeyGaluzo Feb 13, 2026

Uh oh!

SergeyGaluzo Feb 13, 2026

Uh oh!

SergeyGaluzo Feb 13, 2026 •

edited

Loading

Uh oh!

SergeyGaluzo commented Feb 14, 2026 •

edited

Loading

Uh oh!

SergeyGaluzo commented Feb 14, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		@@ -357,30 +353,45 @@ private static HashSet<SearchParameterInfo> BuildSearchParameterDefinition(
		var searchParameterDictionary = new ConcurrentDictionary<string, ConcurrentQueue<SearchParameterInfo>>();
		foreach (SearchParameterInfo searchParam in results)

Conversation

jestradaMS commented Feb 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related issues

Testing

FHIR Team Checklist

Semver Change (docs)

Uh oh!

Uh oh!

jestradaMS commented Feb 13, 2026

Uh oh!

azure-pipelines bot commented Feb 13, 2026

Uh oh!

SergeyGaluzo Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

SergeyGaluzo Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

SergeyGaluzo Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SergeyGaluzo commented Feb 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SergeyGaluzo commented Feb 14, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jestradaMS commented Feb 12, 2026 •

edited

Loading

SergeyGaluzo Feb 13, 2026 •

edited

Loading

SergeyGaluzo commented Feb 14, 2026 •

edited

Loading