Add support for response parameter issues for validate-code operation (#6360)

* Add support for response parameter issues for validate-code operation. Implement workaround for missing error for invalid codes by adding an issue when it is absent.

* address minor code review comments

* revert functionality of adding original code from remote validate-code call to the CodeValidationResult

* revert change to FhirInstanceValidatorR4Test

* Revert some of the code review addressal after responding.

* Remove populating message in success scenarios.

* Fix compilation failure in test after reverting method rename.

* Revert change to populate the code from the response again as it implies more refactoring.

---------

Co-authored-by: nathaniel.doef <[email protected]>

Author: 2 people

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

@@ -727,7 +727,7 @@ public CodeValidationResult setCode(String theCode) {
 			return this;
 		}
 
-		String getCodeSystemName() {
+		public String getCodeSystemName() {
 			return myCodeSystemName;
 		}
 

hapi-fhir-base/src/main/java/ca/uhn/fhir/util/ParametersUtil.java

@@ -43,6 +43,7 @@
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.List;
+import java.util.Objects;
 import java.util.Optional;
 import java.util.function.Function;
 import java.util.stream.Collectors;
@@ -58,20 +59,20 @@ public class ParametersUtil {
 	public static Optional<String> getNamedParameterValueAsString(
 			FhirContext theCtx, IBaseParameters theParameters, String theParameterName) {
 		Function<IPrimitiveType<?>, String> mapper = t -> defaultIfBlank(t.getValueAsString(), null);
-		return extractNamedParameters(theCtx, theParameters, theParameterName, mapper).stream()
+		return extractNamedParameterValues(theCtx, theParameters, theParameterName, mapper).stream()
 				.findFirst();
 	}
 
 	public static List<String> getNamedParameterValuesAsString(
 			FhirContext theCtx, IBaseParameters theParameters, String theParameterName) {
 		Function<IPrimitiveType<?>, String> mapper = t -> defaultIfBlank(t.getValueAsString(), null);
-		return extractNamedParameters(theCtx, theParameters, theParameterName, mapper);
+		return extractNamedParameterValues(theCtx, theParameters, theParameterName, mapper);
 	}
 
 	public static List<Integer> getNamedParameterValuesAsInteger(
 			FhirContext theCtx, IBaseParameters theParameters, String theParameterName) {
 		Function<IPrimitiveType<?>, Integer> mapper = t -> (Integer) t.getValue();
-		return extractNamedParameters(theCtx, theParameters, theParameterName, mapper);
+		return extractNamedParameterValues(theCtx, theParameters, theParameterName, mapper);
 	}
 
 	public static Optional<Integer> getNamedParameterValueAsInteger(
@@ -80,6 +81,19 @@ public static Optional<Integer> getNamedParameterValueAsInteger(
 				.findFirst();
 	}
 
+	/**
+	 * Returns the resource within a parameter.
+	 * @param theCtx thr FHIR context
+	 * @param theParameters the parameters instance where to look for the resource
+	 * @param theParameterName the parameter name
+	 * @return the resource
+	 */
+	public static Optional<IBaseResource> getNamedParameterResource(
+			FhirContext theCtx, IBaseParameters theParameters, String theParameterName) {
+		return extractNamedParameterResources(theCtx, theParameters, theParameterName).stream()
+				.findFirst();
+	}
+
 	public static Optional<IBase> getNamedParameter(
 			FhirContext theCtx, IBaseResource theParameters, String theParameterName) {
 		return getNamedParameters(theCtx, theParameters, theParameterName).stream()
@@ -153,7 +167,7 @@ public static Optional<Integer> getParameterPartValueAsInteger(
 				.map(t -> (Integer) t);
 	}
 
-	private static <T> List<T> extractNamedParameters(
+	private static <T> List<T> extractNamedParameterValues(
 			FhirContext theCtx,
 			IBaseParameters theParameters,
 			String theParameterName,
@@ -170,7 +184,25 @@ private static <T> List<T> extractNamedParameters(
 					.filter(t -> t instanceof IPrimitiveType<?>)
 					.map(t -> ((IPrimitiveType<?>) t))
 					.map(theMapper)
-					.filter(t -> t != null)
+					.filter(Objects::nonNull)
+					.forEach(retVal::add);
+		}
+		return retVal;
+	}
+
+	private static List<IBaseResource> extractNamedParameterResources(
+			FhirContext theCtx, IBaseParameters theParameters, String theParameterName) {
+		List<IBaseResource> retVal = new ArrayList<>();
+
+		List<IBase> namedParameters = getNamedParameters(theCtx, theParameters, theParameterName);
+		for (IBase nextParameter : namedParameters) {
+			BaseRuntimeElementCompositeDefinition<?> nextParameterDef =
+					(BaseRuntimeElementCompositeDefinition<?>) theCtx.getElementDefinition(nextParameter.getClass());
+			BaseRuntimeChildDefinition resourceChild = nextParameterDef.getChildByName("resource");
+			List<IBase> resourceValues = resourceChild.getAccessor().getValues(nextParameter);
+			resourceValues.stream()
+					.filter(IBaseResource.class::isInstance)
+					.map(t -> ((IBaseResource) t))
 					.forEach(retVal::add);
 		}
 		return retVal;

hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/changelog/7_6_0/6359-remote-terminology-validation-does-not-error-for-invalid-codes.yaml

@@ -0,0 +1,5 @@
+---
+type: fix
+issue: 6359
+title: "After upgrading org.hl7.fhir.core from 6.1.2.2 to 6.3.11, the $validate-code operation stopped returning an 
+error for invalid codes using remote terminology. This has been fixed."

hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/changelog/7_6_0/6359-support-for-out-parameter-issues-remote-terminology-validation.yaml

@@ -0,0 +1,5 @@
+---
+type: add
+issue: 6359
+title: "Remote Terminology validation has been enhanced to support output parameter `issues` for the $validate-code 
+operation."