Add IPS Generator

azure-pipelines.yml

@@ -59,6 +59,8 @@ stages:
                   #                     module: hapi-fhir-jpaserver-base
                   -  name: hapi_fhir_jpaserver_elastic_test_utilities
                      module: hapi-fhir-jpaserver-elastic-test-utilities
+                  -  name: hapi_fhir_jpaserver_ips
+                     module: hapi-fhir-jpaserver-ips
                   -  name: hapi_fhir_jpaserver_mdm
                      module: hapi-fhir-jpaserver-mdm
                   -  name: hapi_fhir_jpaserver_model

hapi-fhir-base/src/main/java/ca/uhn/fhir/fhirpath/IFhirPath.java

@@ -22,6 +22,7 @@
 
 import org.hl7.fhir.instance.model.api.IBase;
 
+import javax.annotation.Nonnull;
 import java.util.List;
 import java.util.Optional;
 
@@ -52,4 +53,15 @@ public interface IFhirPath {
 	 * Parses the expression and throws an exception if it can not parse correctly
 	 */
 	void parse(String theExpression) throws Exception;
+
+
+	/**
+	 * This method can be used optionally to supply an evaluation context for the
+	 * FHIRPath evaluator instance. The context can be used to supply data needed by
+	 * specific functions, e.g. allowing the <code>resolve()</code> function to
+	 * fetch referenced resources.
+	 *
+	 * @since 6.4.0
+	 */
+	void setEvaluationContext(@Nonnull IFhirPathEvaluationContext theEvaluationContext);
 }

hapi-fhir-base/src/main/java/ca/uhn/fhir/fhirpath/IFhirPathEvaluationContext.java

@@ -0,0 +1,41 @@
+package ca.uhn.fhir.fhirpath;
+
+/*-
+ * #%L
+ * HAPI FHIR - Core Library
+ * %%
+ * Copyright (C) 2014 - 2023 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%
+ */
+
+import org.hl7.fhir.instance.model.api.IBase;
+import org.hl7.fhir.instance.model.api.IIdType;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+public interface IFhirPathEvaluationContext {
+
+	/**
+	 * Evaluates the <code>resolve()</code> function and returns the target
+	 * of the resolution.
+	 *
+	 * @param theReference The reference
+	 * @param theContext The entity containing the reference. Note that this will be <code>null</code> for FHIR versions R4 and below.
+	 */
+	default IBase resolveReference(@Nonnull IIdType theReference, @Nullable IBase theContext) {
+		return null;
+	}
+}

hapi-fhir-base/src/main/java/ca/uhn/fhir/model/api/Include.java

@@ -37,7 +37,7 @@
  * upgrading servers.
  * </p>
  * <p>
- * Note on thrwead safety: This class is not thread safe.
+ * Note on thread safety: This class is not thread safe.
  * </p>
  */
 public class Include implements Serializable {

hapi-fhir-base/src/main/java/ca/uhn/fhir/narrative/BaseThymeleafNarrativeGenerator.java

@@ -22,17 +22,21 @@
 
 import ca.uhn.fhir.context.FhirContext;
 import ca.uhn.fhir.i18n.Msg;
+import ca.uhn.fhir.narrative2.BaseNarrativeGenerator;
+import ca.uhn.fhir.narrative2.INarrativeTemplate;
 import ca.uhn.fhir.narrative2.NarrativeTemplateManifest;
 import ca.uhn.fhir.narrative2.ThymeleafNarrativeGenerator;
 import ca.uhn.fhir.rest.server.exceptions.InternalErrorException;
+import org.hl7.fhir.instance.model.api.IBase;
 import org.hl7.fhir.instance.model.api.IBaseResource;
+import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
 import java.util.List;
 
 public abstract class BaseThymeleafNarrativeGenerator extends ThymeleafNarrativeGenerator {
 
-	private boolean myInitialized;
+	private volatile boolean myInitialized;
 
 	/**
 	 * Constructor
@@ -43,11 +47,21 @@ protected BaseThymeleafNarrativeGenerator() {
 
 	@Override
 	public boolean populateResourceNarrative(FhirContext theFhirContext, IBaseResource theResource) {
+		initializeIfNecessary();
+		super.populateResourceNarrative(theFhirContext, theResource);
+		return false;
+	}
+
+	@Override
+	public String generateResourceNarrative(FhirContext theFhirContext, IBaseResource theResource) {
+		initializeIfNecessary();
+		return super.generateResourceNarrative(theFhirContext, theResource);
+	}
+
+	protected void initializeIfNecessary() {
 		if (!myInitialized) {
 			initialize();
 		}
-		super.populateResourceNarrative(theFhirContext, theResource);
-		return false;
 	}
 
 	protected abstract List<String> getPropertyFile();

hapi-fhir-base/src/main/java/ca/uhn/fhir/narrative/CustomThymeleafNarrativeGenerator.java

@@ -32,16 +32,30 @@ public class CustomThymeleafNarrativeGenerator extends BaseThymeleafNarrativeGen
 	/**
 	 * Create a new narrative generator
 	 * 
-	 * @param thePropertyFile
+	 * @param theNarrativePropertyFiles
 	 *            The name of the property file, in one of the following formats:
 	 *            <ul>
 	 *            <li>file:/path/to/file/file.properties</li>
 	 *            <li>classpath:/com/package/file.properties</li>
 	 *            </ul>
 	 */
-	public CustomThymeleafNarrativeGenerator(String... thePropertyFile) {
+	public CustomThymeleafNarrativeGenerator(String... theNarrativePropertyFiles) {
 		super();
-		setPropertyFile(thePropertyFile);
+		setPropertyFile(theNarrativePropertyFiles);
+	}
+
+	/**
+	 * Create a new narrative generator
+	 *
+	 * @param theNarrativePropertyFiles
+	 *            The name of the property file, in one of the following formats:
+	 *            <ul>
+	 *            <li>file:/path/to/file/file.properties</li>
+	 *            <li>classpath:/com/package/file.properties</li>
+	 *            </ul>
+	 */
+	public CustomThymeleafNarrativeGenerator(List<String> theNarrativePropertyFiles) {
+		this(theNarrativePropertyFiles.toArray(new String[0]));
 	}
 
 	/**

hapi-fhir-base/src/main/java/ca/uhn/fhir/narrative/INarrativeGenerator.java

@@ -35,4 +35,8 @@ public interface INarrativeGenerator {
 	 */
 	boolean populateResourceNarrative(FhirContext theFhirContext, IBaseResource theResource);
 
+	/**
+	 * Generates the narrative for the given resource and returns it as a string
+	 */
+	String generateResourceNarrative(FhirContext theFhirContext, IBaseResource theResource);
 }

hapi-fhir-base/src/main/java/ca/uhn/fhir/narrative2/BaseNarrativeGenerator.java

@@ -31,6 +31,8 @@
 import org.hl7.fhir.instance.model.api.IBase;
 import org.hl7.fhir.instance.model.api.IBaseResource;
 import org.hl7.fhir.instance.model.api.INarrative;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.util.Collections;
 import java.util.EnumSet;
@@ -64,7 +66,18 @@ public boolean populateResourceNarrative(FhirContext theFhirContext, IBaseResour
 		return false;
 	}
 
-	private List<INarrativeTemplate> getTemplateForElement(FhirContext theFhirContext, IBase theElement) {
+	@Override
+	public String generateResourceNarrative(FhirContext theFhirContext, IBaseResource theResource) {
+		List<INarrativeTemplate> templates = getTemplateForElement(theFhirContext, theResource);
+		if (templates.size() > 0) {
+			String narrative = applyTemplate(theFhirContext, templates.get(0), (IBase)theResource);
+			return cleanWhitespace(narrative);
+		}
+
+		return null;
+	}
+
+	protected List<INarrativeTemplate> getTemplateForElement(FhirContext theFhirContext, IBase theElement) {
 		return myManifest.getTemplateByElement(theFhirContext, getStyle(), theElement);
 	}
 

hapi-fhir-base/src/main/java/ca/uhn/fhir/narrative2/INarrativeTemplateManifest.java

@@ -23,13 +23,17 @@
 import ca.uhn.fhir.context.FhirContext;
 import org.hl7.fhir.instance.model.api.IBase;
 
+import javax.annotation.Nonnull;
+import java.util.Collection;
 import java.util.EnumSet;
 import java.util.List;
 
 public interface INarrativeTemplateManifest {
-	List<INarrativeTemplate> getTemplateByResourceName(FhirContext theFhirContext, EnumSet<TemplateTypeEnum> theStyles, String theResourceName);
+	List<INarrativeTemplate> getTemplateByResourceName(@Nonnull FhirContext theFhirContext, @Nonnull EnumSet<TemplateTypeEnum> theStyles, @Nonnull String theResourceName, @Nonnull Collection<String> theProfiles);
 
-	List<INarrativeTemplate> getTemplateByName(FhirContext theFhirContext, EnumSet<TemplateTypeEnum> theStyles, String theName);
+	List<INarrativeTemplate> getTemplateByName(@Nonnull FhirContext theFhirContext, @Nonnull EnumSet<TemplateTypeEnum> theStyles, @Nonnull String theName);
 
-	List<INarrativeTemplate> getTemplateByElement(FhirContext theFhirContext, EnumSet<TemplateTypeEnum> theStyles, IBase theElementValue);
+	List<INarrativeTemplate> getTemplateByElement(@Nonnull FhirContext theFhirContext, @Nonnull EnumSet<TemplateTypeEnum> theStyles, @Nonnull IBase theElementValue);
+
+	List<INarrativeTemplate> getTemplateByFragmentName(@Nonnull FhirContext theFhirContext, @Nonnull EnumSet<TemplateTypeEnum> theStyles, @Nonnull String theFragmentName);
 }

hapi-fhir-base/src/main/java/ca/uhn/fhir/narrative2/NarrativeTemplate.java

@@ -32,10 +32,11 @@
 public class NarrativeTemplate implements INarrativeTemplate {
 
 	private String myTemplateFileName;
-	private Set<String> myAppliesToProfiles = new HashSet<>();
-	private Set<String> myAppliesToResourceTypes = new HashSet<>();
-	private Set<String> myAppliesToDataTypes = new HashSet<>();
-	private Set<Class<? extends IBase>> myAppliesToClasses = new HashSet<>();
+	private final Set<String> myAppliesToProfiles = new HashSet<>();
+	private final Set<String> myAppliesToResourceTypes = new HashSet<>();
+	private final Set<String> myAppliesToDataTypes = new HashSet<>();
+	private final Set<Class<? extends IBase>> myAppliesToClasses = new HashSet<>();
+	private final Set<String> myAppliesToFragmentNames = new HashSet<>();
 	private TemplateTypeEnum myTemplateType = TemplateTypeEnum.THYMELEAF;
 	private String myContextPath;
 	private String myTemplateName;
@@ -44,6 +45,14 @@ public Set<String> getAppliesToDataTypes() {
 		return Collections.unmodifiableSet(myAppliesToDataTypes);
 	}
 
+	public Set<String> getAppliesToFragmentNames() {
+		return Collections.unmodifiableSet(myAppliesToFragmentNames);
+	}
+
+	void addAppliesToFragmentName(String theAppliesToFragmentName) {
+		myAppliesToFragmentNames.add(theAppliesToFragmentName);
+	}
+
 	@Override
 	public String getContextPath() {
 		return myContextPath;