Resource Creation fails due to reference validation when endpoint validating and partitioning is enabled. (#6952)

epeartree · web-flow · commit 00b161849c14 · 2025-08-06T12:52:32.000Z
diff --git a/hapi-fhir-base/src/main/java/ca/uhn/fhir/util/ValidateUtil.java b/hapi-fhir-base/src/main/java/ca/uhn/fhir/util/ValidateUtil.java
@@ -28,7 +28,6 @@
 import static org.apache.commons.lang3.StringUtils.length;
 
 public class ValidateUtil {
-
 	/**
 	 * Throws {@link IllegalArgumentException} if theValue is less than or equal to theMinimum
 	 */
diff --git a/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/ValidationOptions.java b/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/ValidationOptions.java
@@ -29,9 +29,13 @@
 
 public class ValidationOptions {
 
-	private static ValidationOptions ourEmpty;
 	private Set<String> myProfiles;
 
+	/**
+	 * Context for the validation (a RequestDetails object)
+	 */
+	private Object myAppContext;
+
 	public ValidationOptions() {}
 
 	public Set<String> getProfiles() {
@@ -55,13 +59,22 @@ public ValidationOptions addProfileIfNotBlank(String theProfileUri) {
 		return this;
 	}
 
+	public ValidationOptions setAppContext(Object theContext) {
+		myAppContext = theContext;
+		return this;
+	}
+
+	/**
+	 * Returns the AppContext (RequestDetails) set to this options object.
+	 * Can be null.
+	 */
+	public Object getAppContext() {
+		return myAppContext;
+	}
+
 	public static ValidationOptions empty() {
-		ValidationOptions retVal = ourEmpty;
-		if (retVal == null) {
-			retVal = new ValidationOptions();
-			retVal.myProfiles = Collections.emptySet();
-			ourEmpty = retVal;
-		}
-		return retVal;
+		ValidationOptions retval = new ValidationOptions();
+		retval.myProfiles = Collections.emptySet();
+		return retval;
 	}
 }
diff --git a/hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/changelog/8_4_0/6951-validator-with-partitioning-fix.yaml b/hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/changelog/8_4_0/6951-validator-with-partitioning-fix.yaml
@@ -0,0 +1,8 @@
+---
+type: fix
+issue: 6951
+title: "Validators not passing the RequestDetails object through
+        would result in validation being unable to resolve
+        resource references when partitioning is used.
+        This has been resolved.
+"
diff --git a/hapi-fhir-server/src/main/java/ca/uhn/fhir/rest/server/interceptor/BaseValidatingInterceptor.java b/hapi-fhir-server/src/main/java/ca/uhn/fhir/rest/server/interceptor/BaseValidatingInterceptor.java
@@ -33,6 +33,7 @@
 import ca.uhn.fhir.validation.IValidatorModule;
 import ca.uhn.fhir.validation.ResultSeverityEnum;
 import ca.uhn.fhir.validation.SingleValidationMessage;
+import ca.uhn.fhir.validation.ValidationOptions;
 import ca.uhn.fhir.validation.ValidationResult;
 import org.apache.commons.lang3.Validate;
 import org.apache.commons.lang3.text.StrLookup;
@@ -121,7 +122,12 @@ public void setValidator(FhirValidator theValidator) {
 		myValidator = theValidator;
 	}
 
-	abstract ValidationResult doValidate(FhirValidator theValidator, T theRequest);
+	@Deprecated
+	public ValidationResult doValidate(FhirValidator theValidator, T theRequest) {
+		return doValidate(theValidator, theRequest, ValidationOptions.empty());
+	}
+
+	abstract ValidationResult doValidate(FhirValidator theValidator, T theRequest, ValidationOptions theOptions);
 
 	/**
 	 * Fail the request by throwing an {@link UnprocessableEntityException} as a result of a validation failure.
@@ -345,7 +351,9 @@ protected ValidationResult validate(T theRequest, RequestDetails theRequestDetai
 
 		ValidationResult validationResult;
 		try {
-			validationResult = doValidate(validator, theRequest);
+			ValidationOptions options = new ValidationOptions();
+			options.setAppContext(theRequestDetails);
+			validationResult = doValidate(validator, theRequest, options);
 		} catch (Exception e) {
 			if (myIgnoreValidatorExceptions) {
 				ourLog.warn("Validator threw an exception during validation", e);
diff --git a/hapi-fhir-server/src/main/java/ca/uhn/fhir/rest/server/interceptor/RequestValidatingInterceptor.java b/hapi-fhir-server/src/main/java/ca/uhn/fhir/rest/server/interceptor/RequestValidatingInterceptor.java
@@ -29,6 +29,7 @@
 import ca.uhn.fhir.rest.server.method.ResourceParameter;
 import ca.uhn.fhir.validation.FhirValidator;
 import ca.uhn.fhir.validation.ResultSeverityEnum;
+import ca.uhn.fhir.validation.ValidationOptions;
 import ca.uhn.fhir.validation.ValidationResult;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
@@ -54,8 +55,8 @@ public class RequestValidatingInterceptor extends BaseValidatingInterceptor<Stri
 	private boolean myAddValidationResultsToResponseOperationOutcome = true;
 
 	@Override
-	ValidationResult doValidate(FhirValidator theValidator, String theRequest) {
-		return theValidator.validateWithResult(theRequest);
+	ValidationResult doValidate(FhirValidator theValidator, String theRequest, ValidationOptions theOptions) {
+		return theValidator.validateWithResult(theRequest, theOptions);
 	}
 
 	@Hook(Pointcut.SERVER_INCOMING_REQUEST_POST_PROCESSED)
diff --git a/hapi-fhir-server/src/main/java/ca/uhn/fhir/rest/server/interceptor/ResponseValidatingInterceptor.java b/hapi-fhir-server/src/main/java/ca/uhn/fhir/rest/server/interceptor/ResponseValidatingInterceptor.java
@@ -26,6 +26,7 @@
 import ca.uhn.fhir.rest.server.exceptions.UnprocessableEntityException;
 import ca.uhn.fhir.validation.FhirValidator;
 import ca.uhn.fhir.validation.ResultSeverityEnum;
+import ca.uhn.fhir.validation.ValidationOptions;
 import ca.uhn.fhir.validation.ValidationResult;
 import org.apache.commons.lang3.Validate;
 import org.hl7.fhir.instance.model.api.IBaseResource;
@@ -61,8 +62,8 @@ public void addExcludeOperationType(RestOperationTypeEnum theOperationType) {
 	}
 
 	@Override
-	ValidationResult doValidate(FhirValidator theValidator, IBaseResource theRequest) {
-		return theValidator.validateWithResult(theRequest);
+	ValidationResult doValidate(FhirValidator theValidator, IBaseResource theRequest, ValidationOptions theOptions) {
+		return theValidator.validateWithResult(theRequest, theOptions);
 	}
 
 	@Hook(Pointcut.SERVER_OUTGOING_RESPONSE)
diff --git a/hapi-fhir-validation/src/main/java/org/hl7/fhir/common/hapi/validation/validator/ValidatorWrapper.java b/hapi-fhir-validation/src/main/java/org/hl7/fhir/common/hapi/validation/validator/ValidatorWrapper.java
@@ -6,6 +6,7 @@
 import ca.uhn.fhir.util.Logs;
 import ca.uhn.fhir.util.XmlUtil;
 import ca.uhn.fhir.validation.IValidationContext;
+import ca.uhn.fhir.validation.ValidationOptions;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 import com.google.gson.JsonArray;
@@ -203,7 +204,8 @@ public List<ValidationMessage> validate(
 			}
 
 			Manager.FhirFormat format = Manager.FhirFormat.JSON;
-			v.validate(null, messages, inputStream, format, profiles);
+			ValidationOptions options = theValidationContext.getOptions();
+			v.validate(options.getAppContext(), messages, inputStream, format, profiles);
 		} else {
 			throw new IllegalArgumentException(Msg.code(649) + "Unknown encoding: " + encoding);
 		}
diff --git a/hapi-fhir-validation/src/test/java/ca/uhn/fhir/rest/server/RequestValidatingInterceptorR4Test.java b/hapi-fhir-validation/src/test/java/ca/uhn/fhir/rest/server/RequestValidatingInterceptorR4Test.java
@@ -16,6 +16,7 @@
 import ca.uhn.fhir.rest.api.Constants;
 import ca.uhn.fhir.rest.api.MethodOutcome;
 import ca.uhn.fhir.rest.api.RequestTypeEnum;
+import ca.uhn.fhir.rest.api.server.RequestDetails;
 import ca.uhn.fhir.rest.param.StringParam;
 import ca.uhn.fhir.rest.server.exceptions.InternalErrorException;
 import ca.uhn.fhir.rest.server.interceptor.RequestValidatingInterceptor;
@@ -24,6 +25,7 @@
 import ca.uhn.fhir.test.utilities.server.RestfulServerExtension;
 import ca.uhn.fhir.util.TestUtil;
 import ca.uhn.fhir.util.UrlUtil;
+import ca.uhn.fhir.validation.FhirValidator;
 import ca.uhn.fhir.validation.IValidationContext;
 import ca.uhn.fhir.validation.IValidatorModule;
 import ca.uhn.fhir.validation.ResultSeverityEnum;
@@ -43,20 +45,30 @@
 import org.hl7.fhir.r4.model.IdType;
 import org.hl7.fhir.r4.model.Narrative;
 import org.hl7.fhir.r4.model.Patient;
+import org.hl7.fhir.r4.model.Reference;
+import org.hl7.fhir.r5.elementmodel.Element;
+import org.hl7.fhir.r5.utils.validation.IValidationPolicyAdvisor;
+import org.hl7.fhir.r5.utils.validation.IValidatorResourceFetcher;
+import org.hl7.fhir.r5.utils.validation.constants.ReferenceValidationPolicy;
 import org.hl7.fhir.utilities.xhtml.XhtmlNode;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Order;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
+import org.mockito.ArgumentCaptor;
 import org.mockito.Mockito;
 
 import java.io.IOException;
 import java.util.ArrayList;
+import java.util.EnumSet;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
 
 public class RequestValidatingInterceptorR4Test extends BaseValidationTestWithInlineMocks {
 	private static final org.slf4j.Logger ourLog = org.slf4j.LoggerFactory.getLogger(RequestValidatingInterceptorR4Test.class);
@@ -91,6 +103,31 @@ public void before() {
 		ourPort = ourServlet.getPort();
 	}
 
+	@Test
+	public void testCreateResource_whenResourceHasReference_willValidateRefWithRequestDetails() throws IOException {
+		ArgumentCaptor<Object> argumentCaptor = ArgumentCaptor.forClass(Object.class);
+
+		FhirValidator fhirValidator = createFhirValidatorWithReferenceChecking(argumentCaptor);
+
+		myInterceptor.setFailOnSeverity(null);
+		myInterceptor.setAddResponseHeaderOnSeverity(ResultSeverityEnum.INFORMATION);
+		myInterceptor.setValidator(fhirValidator);
+
+		Patient patient = new Patient();
+		patient.setManagingOrganization(new Reference("Organization/123"));
+		String encoded = ourCtx.newJsonParser().encodeResourceToString(patient);
+
+		HttpPost httpPost = new HttpPost("http://localhost:" + ourPort + "/Patient");
+		httpPost.setEntity(new StringEntity(encoded, ContentType.create(Constants.CT_FHIR_JSON, "UTF-8")));
+
+		HttpResponse status = ourClient.getClient().execute(httpPost);
+		IOUtils.closeQuietly(status.getEntity().getContent());
+
+		ourLog.info("Response was:\n{}", status);
+
+		assertThat(argumentCaptor.getValue()).isInstanceOf(RequestDetails.class);
+	}
+
 	@Test
 	public void testCreateJsonInvalidNoFailure() throws Exception {
 		myInterceptor.setFailOnSeverity(null);
@@ -544,6 +581,23 @@ public void testSearch() throws Exception {
 		assertEquals(true, ourLastRequestWasSearch);
 	}
 
+	private FhirValidator createFhirValidatorWithReferenceChecking(ArgumentCaptor<Object> theArgumentCaptor) throws IOException {
+		IValidatorResourceFetcher validatorResourceFetcher = mock(IValidatorResourceFetcher.class);
+		IValidationPolicyAdvisor policyAdvisor = mock(IValidationPolicyAdvisor.class);
+
+		FhirValidator fhirValidator = ourCtx.newValidator();
+		FhirInstanceValidator instanceValidatorModule = new FhirInstanceValidator(ourCtx);
+		instanceValidatorModule.setValidatorResourceFetcher(validatorResourceFetcher);
+		instanceValidatorModule.setValidatorPolicyAdvisor(policyAdvisor);
+		fhirValidator.registerValidatorModule(instanceValidatorModule);
+
+		when(validatorResourceFetcher.fetch(any(), theArgumentCaptor.capture(), anyString())).thenReturn(new Element("Organization").setType("Organization"));
+		when(policyAdvisor.policyForReference(any(), any(), any(), any(), any())).thenReturn(ReferenceValidationPolicy.CHECK_EXISTS);
+		when(policyAdvisor.policyForElement(any(), any(), any(), any(), any())).thenReturn(EnumSet.allOf(IValidationPolicyAdvisor.ElementValidationAction.class));
+
+		return fhirValidator;
+	}
+
 	public static class PatientProvider implements IResourceProvider {
 
 		public String ourLastGraphQlQueryGet;
