Merge remote-tracking branch 'origin/issue/372_FHIR_Validation_Service'

hhund · hhund · commit adbfbbbf6314 · 2025-10-21T01:05:43.000+02:00
into develop_2
diff --git a/dsf-bpe/dsf-bpe-process-api-v2-impl/src/main/java/dev/dsf/bpe/v2/ProcessPluginApiFactory.java b/dsf-bpe/dsf-bpe-process-api-v2-impl/src/main/java/dev/dsf/bpe/v2/ProcessPluginApiFactory.java
@@ -24,6 +24,7 @@
 import dev.dsf.bpe.v2.service.ReadAccessHelper;
 import dev.dsf.bpe.v2.service.TargetProvider;
 import dev.dsf.bpe.v2.service.TaskHelper;
+import dev.dsf.bpe.v2.service.ValidationServiceProvider;
 import dev.dsf.bpe.v2.service.process.ProcessAuthorizationHelper;
 
 public class ProcessPluginApiFactory implements Supplier<ProcessPluginApi>
@@ -52,6 +53,7 @@ public ProcessPluginApi get()
 				fromParent(ObjectMapper.class), fromParent(OrganizationProvider.class),
 				fromParent(ProcessAuthorizationHelper.class), fromParent(QuestionnaireResponseHelper.class),
 				fromParent(ReadAccessHelper.class), fromParent(TaskHelper.class), fromParent(CompressionService.class),
-				fromParent(CryptoService.class), fromParent(TargetProvider.class), fromParent(DataLogger.class));
+				fromParent(CryptoService.class), fromParent(TargetProvider.class), fromParent(DataLogger.class),
+				fromParent(ValidationServiceProvider.class));
 	}
 }
diff --git a/dsf-bpe/dsf-bpe-process-api-v2-impl/src/main/java/dev/dsf/bpe/v2/ProcessPluginApiImpl.java b/dsf-bpe/dsf-bpe-process-api-v2-impl/src/main/java/dev/dsf/bpe/v2/ProcessPluginApiImpl.java
@@ -23,6 +23,7 @@
 import dev.dsf.bpe.v2.service.ReadAccessHelper;
 import dev.dsf.bpe.v2.service.TargetProvider;
 import dev.dsf.bpe.v2.service.TaskHelper;
+import dev.dsf.bpe.v2.service.ValidationServiceProvider;
 import dev.dsf.bpe.v2.service.process.ProcessAuthorizationHelper;
 
 public class ProcessPluginApiImpl implements ProcessPluginApi, InitializingBean
@@ -47,6 +48,7 @@ public class ProcessPluginApiImpl implements ProcessPluginApi, InitializingBean
 	private final CryptoService cryptoService;
 	private final TargetProvider targetProvider;
 	private final DataLogger dataLogger;
+	private final ValidationServiceProvider validationServiceProvider;
 
 	public ProcessPluginApiImpl(ProcessPluginDefinition processPluginDefinition, ProxyConfig proxyConfig,
 			EndpointProvider endpointProvider, FhirContext fhirContext, DsfClientProvider dsfClientProvider,
@@ -56,7 +58,7 @@ public ProcessPluginApiImpl(ProcessPluginDefinition processPluginDefinition, Pro
 			ProcessAuthorizationHelper processAuthorizationHelper,
 			QuestionnaireResponseHelper questionnaireResponseHelper, ReadAccessHelper readAccessHelper,
 			TaskHelper taskHelper, CompressionService compressionService, CryptoService cryptoService,
-			TargetProvider targetProvider, DataLogger dataLogger)
+			TargetProvider targetProvider, DataLogger dataLogger, ValidationServiceProvider validationServiceProvider)
 	{
 		this.processPluginDefinition = processPluginDefinition;
 		this.proxyConfig = proxyConfig;
@@ -78,6 +80,7 @@ public ProcessPluginApiImpl(ProcessPluginDefinition processPluginDefinition, Pro
 		this.cryptoService = cryptoService;
 		this.targetProvider = targetProvider;
 		this.dataLogger = dataLogger;
+		this.validationServiceProvider = validationServiceProvider;
 	}
 
 	@Override
@@ -103,6 +106,7 @@ public void afterPropertiesSet() throws Exception
 		Objects.requireNonNull(cryptoService, "cryptoService");
 		Objects.requireNonNull(targetProvider, "targetProvider");
 		Objects.requireNonNull(dataLogger, "dataLogger");
+		Objects.requireNonNull(validationServiceProvider, "validationServiceProvider");
 	}
 
 	@Override
@@ -224,4 +228,10 @@ public DataLogger getDataLogger()
 	{
 		return dataLogger;
 	}
+
+	@Override
+	public ValidationServiceProvider getValidationServiceProvider()
+	{
+		return validationServiceProvider;
+	}
 }
diff --git a/dsf-bpe/dsf-bpe-process-api-v2-impl/src/main/java/dev/dsf/bpe/v2/service/ValidationServiceProviderImpl.java b/dsf-bpe/dsf-bpe-process-api-v2-impl/src/main/java/dev/dsf/bpe/v2/service/ValidationServiceProviderImpl.java
@@ -0,0 +1,75 @@
+package dev.dsf.bpe.v2.service;
+
+import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
+import java.util.function.Predicate;
+
+import org.hl7.fhir.r4.model.Bundle;
+import org.hl7.fhir.r4.model.Resource;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.InitializingBean;
+
+import ca.uhn.fhir.context.FhirContext;
+import ca.uhn.fhir.validation.ValidationResult;
+import dev.dsf.bpe.v2.service.validation.FhirPackageIdentifier;
+import dev.dsf.bpe.v2.service.validation.ValidationService;
+
+public class ValidationServiceProviderImpl implements ValidationServiceProvider, InitializingBean
+{
+	private static final Logger logger = LoggerFactory.getLogger(ValidationServiceProviderImpl.class);
+
+	private final boolean enabled;
+	private final FhirContext fhirContext;
+
+	public ValidationServiceProviderImpl(boolean enabled, FhirContext fhirContext)
+	{
+		this.enabled = enabled;
+		this.fhirContext = fhirContext;
+	}
+
+	@Override
+	public void afterPropertiesSet() throws Exception
+	{
+		Objects.requireNonNull(fhirContext, "fhirContext");
+	}
+
+	@Override
+	public Optional<ValidationService> getValidationService(Predicate<FhirPackageIdentifier> filter,
+			FhirPackageIdentifier... identifiers)
+	{
+		if (!enabled)
+			return Optional.empty();
+		else
+		{
+			// TODO implement validation, add needed HAPI dependencies
+
+			return Optional.of(new ValidationService()
+			{
+				@Override
+				public Bundle validateEntries(Bundle bundle)
+				{
+					logger.warn("Bundle validation not implemented, returning bundle as is");
+
+					return bundle;
+				}
+
+				@Override
+				public ValidationResult validate(Resource resource, String profileUrl)
+				{
+					return validate(resource);
+				}
+
+				@Override
+				public ValidationResult validate(Resource resource)
+				{
+					logger.warn(
+							"Resource validation not implemented, returning successful validation result without messages");
+
+					return new ValidationResult(fhirContext, List.of());
+				}
+			});
+		}
+	}
+}
diff --git a/dsf-bpe/dsf-bpe-process-api-v2-impl/src/main/java/dev/dsf/bpe/v2/spring/ApiServiceConfig.java b/dsf-bpe/dsf-bpe-process-api-v2-impl/src/main/java/dev/dsf/bpe/v2/spring/ApiServiceConfig.java
@@ -17,6 +17,7 @@
 import dev.dsf.bpe.api.config.BpeProxyConfig;
 import dev.dsf.bpe.api.config.DsfClientConfig;
 import dev.dsf.bpe.api.config.FhirClientConfigs;
+import dev.dsf.bpe.api.config.FhirValidationConfig;
 import dev.dsf.bpe.api.listener.ListenerFactory;
 import dev.dsf.bpe.api.listener.ListenerFactoryImpl;
 import dev.dsf.bpe.api.service.BpeMailService;
@@ -66,6 +67,8 @@
 import dev.dsf.bpe.v2.service.TargetProviderImpl;
 import dev.dsf.bpe.v2.service.TaskHelper;
 import dev.dsf.bpe.v2.service.TaskHelperImpl;
+import dev.dsf.bpe.v2.service.ValidationServiceProvider;
+import dev.dsf.bpe.v2.service.ValidationServiceProviderImpl;
 import dev.dsf.bpe.v2.service.detector.CombinedDetectors;
 import dev.dsf.bpe.v2.service.detector.NdJsonDetector;
 import dev.dsf.bpe.v2.service.process.ProcessAuthorizationHelper;
@@ -90,6 +93,9 @@ public class ApiServiceConfig
 	@Autowired
 	private BpeProxyConfig proxyConfig;
 
+	@Autowired
+	private FhirValidationConfig validationConfig;
+
 	@Autowired
 	private BuildInfoProvider buildInfoProvider;
 
@@ -306,4 +312,10 @@ public DataLogger dataLogger()
 	{
 		return new DataLoggerImpl(fhirContext());
 	}
+
+	@Bean
+	public ValidationServiceProvider validationServiceProvider()
+	{
+		return new ValidationServiceProviderImpl(validationConfig.isEnabled(), fhirContext());
+	}
 }
diff --git a/dsf-bpe/dsf-bpe-process-api-v2/src/main/java/dev/dsf/bpe/v2/ProcessPluginApi.java b/dsf-bpe/dsf-bpe-process-api-v2/src/main/java/dev/dsf/bpe/v2/ProcessPluginApi.java
@@ -22,6 +22,7 @@
 import dev.dsf.bpe.v2.service.ReadAccessHelper;
 import dev.dsf.bpe.v2.service.TargetProvider;
 import dev.dsf.bpe.v2.service.TaskHelper;
+import dev.dsf.bpe.v2.service.ValidationServiceProvider;
 import dev.dsf.bpe.v2.service.process.ProcessAuthorizationHelper;
 import dev.dsf.bpe.v2.variables.Variables;
 
@@ -72,4 +73,6 @@ public interface ProcessPluginApi
 	TargetProvider getTargetProvider();
 
 	DataLogger getDataLogger();
+
+	ValidationServiceProvider getValidationServiceProvider();
 }
diff --git a/dsf-bpe/dsf-bpe-process-api-v2/src/main/java/dev/dsf/bpe/v2/service/ValidationServiceProvider.java b/dsf-bpe/dsf-bpe-process-api-v2/src/main/java/dev/dsf/bpe/v2/service/ValidationServiceProvider.java
@@ -0,0 +1,36 @@
+package dev.dsf.bpe.v2.service;
+
+import java.util.Optional;
+import java.util.function.Predicate;
+
+import dev.dsf.bpe.v2.service.validation.FhirPackageIdentifier;
+import dev.dsf.bpe.v2.service.validation.ValidationService;
+
+public interface ValidationServiceProvider
+{
+	/**
+	 * Returns a {@link ValidationService} configured for the given FHIR package <b>identifiers</b> and their
+	 * dependencies.
+	 *
+	 * @param identifiers
+	 *            not <code>null</code>, not empty
+	 * @return {@link Optional#empty()} if resource validation is disabled for the DSF instance
+	 */
+	default Optional<ValidationService> getValidationService(FhirPackageIdentifier... identifiers)
+	{
+		return getValidationService(_ -> true, identifiers);
+	}
+
+	/**
+	 * Returns a {@link ValidationService} configured for the given FHIR package <b>identifiers</b> and their
+	 * dependencies. Excludes packages when the given <b>filter</b> returns <code>false</code>.
+	 *
+	 * @param filter
+	 *            not <code>null</code>, packages are only included if allowed by this filter
+	 * @param identifiers
+	 *            not <code>null</code>, not empty
+	 * @return {@link Optional#empty()} if resource validation is disabled for the DSF instance
+	 */
+	Optional<ValidationService> getValidationService(Predicate<FhirPackageIdentifier> filter,
+			FhirPackageIdentifier... identifiers);
+}
diff --git a/dsf-bpe/dsf-bpe-process-api-v2/src/main/java/dev/dsf/bpe/v2/service/validation/FhirPackageIdentifier.java b/dsf-bpe/dsf-bpe-process-api-v2/src/main/java/dev/dsf/bpe/v2/service/validation/FhirPackageIdentifier.java
@@ -0,0 +1,10 @@
+package dev.dsf.bpe.v2.service.validation;
+
+public record FhirPackageIdentifier(String name, String version)
+{
+	@Override
+	public String toString()
+	{
+		return name + "|" + version;
+	}
+}
diff --git a/dsf-bpe/dsf-bpe-process-api-v2/src/main/java/dev/dsf/bpe/v2/service/validation/ValidationService.java b/dsf-bpe/dsf-bpe-process-api-v2/src/main/java/dev/dsf/bpe/v2/service/validation/ValidationService.java
@@ -0,0 +1,41 @@
+package dev.dsf.bpe.v2.service.validation;
+
+import org.hl7.fhir.r4.model.Bundle;
+import org.hl7.fhir.r4.model.OperationOutcome;
+import org.hl7.fhir.r4.model.Resource;
+
+import ca.uhn.fhir.validation.ValidationResult;
+
+public interface ValidationService
+{
+	/**
+	 * Validates against profiles self reported by the given <b>resource</b>.
+	 *
+	 * @param resource
+	 *            not <code>null</code>
+	 * @return validation results
+	 */
+	ValidationResult validate(Resource resource);
+
+	/**
+	 * Validates the given <b>resource</b> against the given <b>profileUrl</b>.
+	 *
+	 * @param resource
+	 *            not <code>null</code>
+	 * @param profileUrl
+	 *            not <code>null</code>, not blank
+	 * @return validation results
+	 */
+	ValidationResult validate(Resource resource, String profileUrl);
+
+	/**
+	 * Validates all bundle entries with a <code>entry.resource</code> against self reported profiles. Validation result
+	 * is added as a {@link OperationOutcome} resource to the corresponding <code>entry.response.outcome</code>
+	 * property.
+	 *
+	 * @param bundle
+	 *            not <code>null</code>
+	 * @return given bundle with added <code>entry.response.outcome</code> properties
+	 */
+	Bundle validateEntries(Bundle bundle);
+}
diff --git a/dsf-bpe/dsf-bpe-process-api/src/main/java/dev/dsf/bpe/api/config/FhirValidationConfig.java b/dsf-bpe/dsf-bpe-process-api/src/main/java/dev/dsf/bpe/api/config/FhirValidationConfig.java
@@ -0,0 +1,6 @@
+package dev.dsf.bpe.api.config;
+
+public interface FhirValidationConfig
+{
+	boolean isEnabled();
+}
diff --git a/dsf-bpe/dsf-bpe-server/src/main/java/dev/dsf/bpe/plugin/ProcessPluginApiFactory.java b/dsf-bpe/dsf-bpe-server/src/main/java/dev/dsf/bpe/plugin/ProcessPluginApiFactory.java
@@ -18,6 +18,7 @@
 import dev.dsf.bpe.api.config.BpeProxyConfig;
 import dev.dsf.bpe.api.config.DsfClientConfig;
 import dev.dsf.bpe.api.config.FhirClientConfigs;
+import dev.dsf.bpe.api.config.FhirValidationConfig;
 import dev.dsf.bpe.api.plugin.ProcessPluginApiBuilder;
 import dev.dsf.bpe.api.plugin.ProcessPluginFactory;
 import dev.dsf.bpe.api.service.BpeMailService;
@@ -32,21 +33,24 @@ public class ProcessPluginApiFactory implements InitializingBean
 	private final DsfClientConfig dsfClientConfig;
 	private final FhirClientConfigs fhirClientConfigs;
 	private final BpeProxyConfig bpeProxyConfig;
+	private final FhirValidationConfig fhirValidationConfig;
 	private final BuildInfoProvider buildInfoProvider;
 	private final BpeMailService bpeMailService;
 	private final BpeOidcClientProvider bpeOidcClientProvider;
 	private final ProcessPluginApiClassLoaderFactory classLoaderFactory;
 	private final String serverBaseUrl;
 
 	public ProcessPluginApiFactory(ConfigurableEnvironment environment, DsfClientConfig dsfClientConfig,
-			FhirClientConfigs fhirClientConfigs, BpeProxyConfig bpeProxyConfig, BuildInfoProvider buildInfoProvider,
+			FhirClientConfigs fhirClientConfigs, BpeProxyConfig bpeProxyConfig,
+			FhirValidationConfig fhirValidationConfig, BuildInfoProvider buildInfoProvider,
 			BpeMailService bpeMailService, BpeOidcClientProvider bpeOidcClientProvider,
 			ProcessPluginApiClassLoaderFactory classLoaderFactory, String serverBaseUrl)
 	{
 		this.environment = environment;
 		this.dsfClientConfig = dsfClientConfig;
 		this.fhirClientConfigs = fhirClientConfigs;
 		this.bpeProxyConfig = bpeProxyConfig;
+		this.fhirValidationConfig = fhirValidationConfig;
 		this.buildInfoProvider = buildInfoProvider;
 		this.bpeMailService = bpeMailService;
 		this.bpeOidcClientProvider = bpeOidcClientProvider;
@@ -61,6 +65,7 @@ public void afterPropertiesSet() throws Exception
 		Objects.requireNonNull(dsfClientConfig, "dsfClientConfig");
 		Objects.requireNonNull(fhirClientConfigs, "fhirClientConfigs");
 		Objects.requireNonNull(bpeProxyConfig, "bpeProxyConfig");
+		Objects.requireNonNull(fhirValidationConfig, "fhirValidationConfig");
 		Objects.requireNonNull(buildInfoProvider, "buildInfoProvider");
 		Objects.requireNonNull(bpeMailService, "bpeMailService");
 		Objects.requireNonNull(bpeOidcClientProvider, "bpeOidcClientProvider");
@@ -98,6 +103,7 @@ private ApplicationContext createApiApplicationContext(int apiVersion, ClassLoad
 			factory.registerSingleton("dsfClientConfig", dsfClientConfig);
 			factory.registerSingleton("fhirClientConfigs", fhirClientConfigs);
 			factory.registerSingleton("bpeProxyConfig", bpeProxyConfig);
+			factory.registerSingleton("fhirValidationConfig", fhirValidationConfig);
 			factory.registerSingleton("buildInfoReader", buildInfoProvider);
 			factory.registerSingleton("bpeMailService", bpeMailService);
 			factory.registerSingleton("bpeOidcClientProvider", bpeOidcClientProvider);
diff --git a/dsf-bpe/dsf-bpe-server/src/main/java/dev/dsf/bpe/spring/config/PluginFactoryConfig.java b/dsf-bpe/dsf-bpe-server/src/main/java/dev/dsf/bpe/spring/config/PluginFactoryConfig.java
@@ -21,6 +21,7 @@
 
 import dev.dsf.bpe.api.config.BpeProxyConfig;
 import dev.dsf.bpe.api.config.DsfClientConfig;
+import dev.dsf.bpe.api.config.FhirValidationConfig;
 import dev.dsf.bpe.api.plugin.ProcessPluginFactory;
 import dev.dsf.bpe.api.service.BpeMailService;
 import dev.dsf.bpe.api.service.BuildInfoProvider;
@@ -208,9 +209,18 @@ public void send(String subject, MimeBodyPart body, Consumer<MimeMessage> messag
 			}
 		};
 
+		FhirValidationConfig fhirValidationConfig = new FhirValidationConfig()
+		{
+			@Override
+			public boolean isEnabled()
+			{
+				return propertiesConfig.getFhirValidationEnabled();
+			}
+		};
+
 		return new ProcessPluginApiFactory((ConfigurableEnvironment) environment, clientConfig,
-				fhirClientConnectionsConfig.fhirClientConfigs(), proxyConfig, buildInfoProvider, bpeMailService,
-				oidcClientProviderConfig.bpeOidcClientProvider(), pluginApiClassLoaderFactory(),
+				fhirClientConnectionsConfig.fhirClientConfigs(), proxyConfig, fhirValidationConfig, buildInfoProvider,
+				bpeMailService, oidcClientProviderConfig.bpeOidcClientProvider(), pluginApiClassLoaderFactory(),
 				propertiesConfig.getDsfServerBaseUrl());
 	}
 
diff --git a/dsf-bpe/dsf-bpe-server/src/main/java/dev/dsf/bpe/spring/config/PropertiesConfig.java b/dsf-bpe/dsf-bpe-server/src/main/java/dev/dsf/bpe/spring/config/PropertiesConfig.java
@@ -250,6 +250,10 @@ public class PropertiesConfig extends AbstractCertificateConfig implements Initi
 	@Value("${dev.dsf.bpe.process.fhir.server.retry.sleep:PT5S}")
 	private String fhirServerRetryDelay;
 
+	@Documentation(description = "Set to true to enable FHIR validation feature for process plugins, not implemented for DSF version 2.0.x")
+	@Value("${dev.dsf.bpe.process.fhir.validation.enabled:false}")
+	private boolean fhirValidationEnabled;
+
 	@Documentation(description = "Mail service sender address", example = "sender@localhost")
 	@Value("${dev.dsf.bpe.mail.fromAddress:}")
 	private String mailFromAddress;
@@ -921,4 +925,9 @@ public ProxyConfig proxyConfig()
 	{
 		return new ProxyConfigImpl(proxyUrl, proxyUsername, proxyPassword, proxyNoProxy);
 	}
+
+	public boolean getFhirValidationEnabled()
+	{
+		return fhirValidationEnabled;
+	}
 }
diff --git a/dsf-fhir/dsf-fhir-validation/src/main/java/dev/dsf/fhir/validation/StructureDefinitionReader.java b/dsf-fhir/dsf-fhir-validation/src/main/java/dev/dsf/fhir/validation/StructureDefinitionReader.java
