71180rel group list 2 (#7159)

* Revert "7082 add ability to filter everything (#7083)"

This reverts commit f565711.

* initial changes

* omit list and group from patient compartment

* spotless

* fixing things that might have to be tossed

* updating hapi to allow omitting some SP from security compartments

* fixing tests

* adding test for delete

* spotless

* git status

* cleanup

* fixing some tests

* test fix

* review fixes

* more review fixes

* review fixes

* version bump

* merging in master

* spotless

* fixing bug

* review fixes 2

* fixing tests

* spotless

* filtering for patient export

* spotless

* fix

* fixing the link

* version change

* adding version

* release version change

* review fix

* spotless

* remove the version

* commit to force build

---------

Co-authored-by: leif stawnyczy <[email protected]>

Author: TipzCM

hapi-deployable-pom/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		 <groupId>ca.uhn.hapi.fhir</groupId>
 		 <artifactId>hapi-fhir</artifactId>
-		 <version>8.3.16-SNAPSHOT</version>
+		 <version>8.3.17-SNAPSHOT</version>
 
 		 <relativePath>../pom.xml</relativePath>
 	 </parent>

hapi-fhir-android/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-deployable-pom</artifactId>
-		<version>8.3.16-SNAPSHOT</version>
+		<version>8.3.17-SNAPSHOT</version>
 
 		<relativePath>../hapi-deployable-pom/pom.xml</relativePath>
 	</parent>

hapi-fhir-base/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-deployable-pom</artifactId>
-		<version>8.3.16-SNAPSHOT</version>
+		<version>8.3.17-SNAPSHOT</version>
 
 		<relativePath>../hapi-deployable-pom/pom.xml</relativePath>
 	</parent>

hapi-fhir-base/src/main/java/ca/uhn/fhir/context/ModelScanner.java

@@ -30,7 +30,6 @@
 import ca.uhn.fhir.model.api.IValueSetEnumBinder;
 import ca.uhn.fhir.model.api.annotation.Block;
 import ca.uhn.fhir.model.api.annotation.Child;
-import ca.uhn.fhir.model.api.annotation.Compartment;
 import ca.uhn.fhir.model.api.annotation.DatatypeDef;
 import ca.uhn.fhir.model.api.annotation.ResourceDef;
 import ca.uhn.fhir.model.api.annotation.SearchParamDefinition;
@@ -39,6 +38,7 @@
 import ca.uhn.fhir.rest.api.Constants;
 import ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum;
 import ca.uhn.fhir.util.ReflectionUtil;
+import ca.uhn.fhir.util.SearchParameterUtil;
 import jakarta.annotation.Nonnull;
 import org.hl7.fhir.instance.model.api.IBase;
 import org.hl7.fhir.instance.model.api.IBaseBackboneElement;
@@ -63,7 +63,6 @@
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
-import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
@@ -393,7 +392,6 @@ private void scanResourceForSearchParams(
 			Class<? extends IBaseResource> theClass, RuntimeResourceDefinition theResourceDef) {
 
 		Map<String, RuntimeSearchParam> nameToParam = new HashMap<>();
-		Map<Field, SearchParamDefinition> compositeFields = new LinkedHashMap<>();
 
 		/*
 		 * Make sure we pick up fields in interfaces too.. This ensures that we
@@ -420,39 +418,8 @@ private void scanResourceForSearchParams(
 					throw new ConfigurationException(Msg.code(1721) + "Search param " + searchParam.name()
 							+ " has an invalid type: " + searchParam.type());
 				}
-				Set<String> providesMembershipInCompartments;
-				providesMembershipInCompartments = new HashSet<>();
-				for (Compartment next : searchParam.providesMembershipIn()) {
-					if (paramType != RestSearchParameterTypeEnum.REFERENCE) {
-						StringBuilder b = new StringBuilder();
-						b.append("Search param ");
-						b.append(searchParam.name());
-						b.append(" on resource type ");
-						b.append(theClass.getName());
-						b.append(" provides compartment membership but is not of type 'reference'");
-						ourLog.warn(b.toString());
-						continue;
-					}
-					String name = next.name();
-
-					// As of 2021-12-28 the R5 structures incorrectly have this prefix
-					if (name.startsWith("Base FHIR compartment definition for ")) {
-						name = name.substring("Base FHIR compartment definition for ".length());
-					}
-					providesMembershipInCompartments.add(name);
-				}
-
-				/**
-				 * In the base FHIR R4 specification, the Device resource is not a part of the Patient compartment.
-				 * However, it is a patient-specific resource that most users expect to be, and several derivative
-				 * specifications including g(10) testing expect it to be, and the fact that it is not has led to many
-				 * bug reports in HAPI FHIR. As of HAPI FHIR 8.0.0 it is being manually added in response to those
-				 * requests.
-				 * See https://github.com/hapifhir/hapi-fhir/issues/6536 for more information.
-				 */
-				if (searchParam.name().equals("patient") && searchParam.path().equals("Device.patient")) {
-					providesMembershipInCompartments.add("Patient");
-				}
+				Set<String> providesMembershipInCompartments =
+						SearchParameterUtil.getMembershipCompartmentsForSearchParameter(theClass, searchParam);
 
 				List<RuntimeSearchParam.Component> components = null;
 				if (paramType == RestSearchParameterTypeEnum.COMPOSITE) {

hapi-fhir-base/src/main/java/ca/uhn/fhir/context/RuntimeResourceDefinition.java

@@ -200,13 +200,8 @@ public void sealAndInitialize(
 
 		myNameToSearchParam = Collections.unmodifiableMap(myNameToSearchParam);
 
-		ArrayList<RuntimeSearchParam> searchParams = new ArrayList<RuntimeSearchParam>(myNameToSearchParam.values());
-		Collections.sort(searchParams, new Comparator<RuntimeSearchParam>() {
-			@Override
-			public int compare(RuntimeSearchParam theArg0, RuntimeSearchParam theArg1) {
-				return theArg0.getName().compareTo(theArg1.getName());
-			}
-		});
+		ArrayList<RuntimeSearchParam> searchParams = new ArrayList<>(myNameToSearchParam.values());
+		Collections.sort(searchParams, Comparator.comparing(RuntimeSearchParam::getName));
 		mySearchParams = Collections.unmodifiableList(searchParams);
 
 		Map<String, List<RuntimeSearchParam>> compartmentNameToSearchParams = new HashMap<>();

hapi-fhir-base/src/main/java/ca/uhn/fhir/interceptor/auth/CompartmentSearchParameterModifications.java

@@ -0,0 +1,106 @@
+/*-
+ * #%L
+ * HAPI FHIR - Server Framework
+ * %%
+ * Copyright (C) 2014 - 2025 Smile CDR, Inc.
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package ca.uhn.fhir.interceptor.auth;
+
+import jakarta.annotation.Nonnull;
+
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * This class is used in RuleBuilder, as a way to allow adding or removing certain Search Parameters
+ * to the compartment.
+ * For example, if you were to add as additional SPs
+ * [device -> ["patient", "subject"]
+ * and apply it to compartment Patient/123, then any device with Patient/123 as its patient would be considered "in"
+ * the compartment, despite the fact that device is technically not part of the compartment definition for patient.
+ */
+public class CompartmentSearchParameterModifications {
+
+	/**
+	 * Construct compartment modifications from resource type and sets of SP names to add or omit respectively.
+	 * @param theResourceType the resource type the SPs are based on
+	 * @param theAdditionalSPs the additional SP names
+	 * @param theOmittedSps the omitted SP names
+	 * @return
+	 */
+	public static CompartmentSearchParameterModifications fromAdditionalAndOmittedSPNames(
+			@Nonnull String theResourceType,
+			@Nonnull Set<String> theAdditionalSPs,
+			@Nonnull Set<String> theOmittedSps) {
+		CompartmentSearchParameterModifications modifications = new CompartmentSearchParameterModifications();
+		theAdditionalSPs.forEach(spName -> {
+			modifications.addSPToIncludeInCompartment(theResourceType, spName);
+		});
+		theOmittedSps.forEach(spName -> {
+			modifications.addSPToOmitFromCompartment(theResourceType, spName);
+		});
+		return modifications;
+	}
+
+	public static CompartmentSearchParameterModifications fromAdditionalCompartmentParamNames(
+			String theResourceType, @Nonnull Set<String> theAdditionalCompartmentParamNames) {
+		return fromAdditionalAndOmittedSPNames(theResourceType, theAdditionalCompartmentParamNames, Set.of());
+	}
+
+	private final Map<String, Set<String>> myAdditionalResourceTypeToParameterCodeMap;
+
+	private final Map<String, Set<String>> myOmittedResourceTypeToParameterCodeMap;
+
+	public CompartmentSearchParameterModifications() {
+		myAdditionalResourceTypeToParameterCodeMap = new HashMap<>();
+		myOmittedResourceTypeToParameterCodeMap = new HashMap<>();
+	}
+
+	/**
+	 * Add an SP, normally included in the compartment, that will be omitted
+	 * hereafter.
+	 * @param theResourceType the resource type on which the SP exists
+	 * @param theSPName the name of the search parameter
+	 */
+	public void addSPToOmitFromCompartment(String theResourceType, String theSPName) {
+		myOmittedResourceTypeToParameterCodeMap
+				.computeIfAbsent(theResourceType.toLowerCase(), (key) -> new HashSet<>())
+				.add(theSPName);
+	}
+
+	/**
+	 * Add an SP, not in the compartment, that will now be included hereafter
+	 * @param theResourceType the resource type on which the SP exists
+	 * @param theSPName the name of the search parameter
+	 */
+	public void addSPToIncludeInCompartment(String theResourceType, String theSPName) {
+		myAdditionalResourceTypeToParameterCodeMap
+				.computeIfAbsent(theResourceType.toLowerCase(), (key) -> new HashSet<>())
+				.add(theSPName);
+	}
+
+	public Set<String> getAdditionalSearchParamNamesForResourceType(@Nonnull String theResourceType) {
+		return myAdditionalResourceTypeToParameterCodeMap.computeIfAbsent(
+				theResourceType.toLowerCase(), (key) -> new HashSet<>());
+	}
+
+	public Set<String> getOmittedSPNamesForResourceType(String theResourceType) {
+		return myOmittedResourceTypeToParameterCodeMap.computeIfAbsent(
+				theResourceType.toLowerCase(), (key) -> new HashSet<>());
+	}
+}

hapi-fhir-base/src/main/java/ca/uhn/fhir/svcs/ISearchLimiterSvc.java

@@ -1,52 +0,0 @@
-/*-
- * #%L
- * HAPI FHIR - Core Library
- * %%
- * Copyright (C) 2014 - 2025 Smile CDR, Inc.
- * %%
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * #L%
- */
-package ca.uhn.fhir.svcs;
-
-import jakarta.annotation.Nonnull;
-
-import java.util.Collection;
-
-public interface ISearchLimiterSvc {
-
-	/**
-	 * Add a resource type to omit from all search results for the named operation.
-	 * @param theOperationName operation name (eg: $everything, $export, etc)
-	 * @param theResourceType the resource name to omit (eg: Group, List, etc)
-	 */
-	void addOmittedResourceType(@Nonnull String theOperationName, @Nonnull String theResourceType);
-
-	/**
-	 * Get all omitted resources for the named operation.
-	 */
-	Collection<String> getResourcesToOmitForOperationSearches(@Nonnull String theOperationName);
-
-	/**
-	 * Remove the resource type from the omission criteria.
-	 * @param theOperationName the operation name
-	 * @param theResourceType the resource type to remove
-	 */
-	void removeOmittedResourceType(@Nonnull String theOperationName, @Nonnull String theResourceType);
-
-	/**
-	 * Remove all omitted resource types for the operation.
-	 * @param theOperationName the operation name
-	 */
-	void removeAllResourcesForOperation(String theOperationName);
-}