hapifhir · michaelabuckley · May 22, 2025 · Apr 22, 2025 · Apr 22, 2025 · Apr 22, 2025
diff --git a/...resources/ca/uhn/hapi/fhir/changelog/8_4_0/6889-normalize-out-resource-type-to-table.yaml b/...resources/ca/uhn/hapi/fhir/changelog/8_4_0/6889-normalize-out-resource-type-to-table.yaml
@@ -0,0 +1,15 @@
+---
+type: add
+issue: 6889
+title: "A new table `HFJ_RESOURCE_TYPE` has been introduced. This table stores all known resource types from all
+releases. It is pre-populated at server start up. New or custom resource types are added to this table on demand.
+A new column `HFJ_RESOURCE_TYPE_ID` has been added to the following tables.
+<ul>
+    <li>HFJ_RESOURCE</li>
+    <li>HFJ_RE_VER</li>
+    <li>HFJ_RES_TAG</li>
+    <li>HFJ_RES_HISTORY_TAG</li>
+    <li>HFJ_RES_VER_LINK</li>
+</ul>
+This column is used to store the resource type ID which references the `HFJ_RESOURCE_TYPE` table."
+
diff --git a/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/cache/IResourceTypeCacheSvc.java b/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/cache/IResourceTypeCacheSvc.java
@@ -0,0 +1,40 @@
+/*
+ * #%L
+ * HAPI FHIR JPA Server
+ * %%
+ * 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.jpa.cache;
+
+public interface IResourceTypeCacheSvc {
+	/**
+	 * Retrieves the resource type ID for the given resource type.
+	 * If the resource type does not exist, a new custom resource type will be created,
+	 * added to the database and cache, and its ID will be returned.
+	 *
+	 * @param theResType the resource type to retrieve or create
+	 * @return the resource type ID or throws an exception if the resource creation fails
+	 */
+	short getResourceTypeId(String theResType);
+
+	/**
+	 * Adds the given resource type and its corresponding ID to the cache.
+	 *
+	 * @param theResType the resource type to be added to the cache
+	 * @param theResTypeId the ID of the resource type to be added to the cache
+	 */
+	void addToCache(String theResType, Short theResTypeId);
+}
diff --git a/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/cache/ResourceTypeCacheSvcImpl.java b/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/cache/ResourceTypeCacheSvcImpl.java
@@ -0,0 +1,138 @@
+/*
+ * #%L
+ * HAPI FHIR JPA Server
+ * %%
+ * 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.jpa.cache;
+
+import ca.uhn.fhir.jpa.config.util.ResourceTypeUtil;
+import ca.uhn.fhir.jpa.dao.data.IResourceTypeDao;
+import ca.uhn.fhir.jpa.dao.tx.IHapiTransactionService;
+import ca.uhn.fhir.jpa.model.entity.ResourceTypeEntity;
+import ca.uhn.fhir.jpa.util.MemoryCacheService;
+import ca.uhn.fhir.rest.server.exceptions.InternalErrorException;
+import jakarta.annotation.PostConstruct;
+import org.apache.commons.collections4.CollectionUtils;
+import org.slf4j.Logger;
+import org.springframework.dao.DataIntegrityViolationException;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Propagation;
+
+import java.util.List;
+
+import static org.slf4j.LoggerFactory.getLogger;
+
+@Service
+public class ResourceTypeCacheSvcImpl implements IResourceTypeCacheSvc {
+	private static final Logger ourLog = getLogger(ResourceTypeCacheSvcImpl.class);
+
+	private final IHapiTransactionService myTransactionService;
+	private final IResourceTypeDao myResourceTypeDao;
+	private final MemoryCacheService myMemoryCacheService;
+
+	public ResourceTypeCacheSvcImpl(
+			IHapiTransactionService theTransactionService,
+			IResourceTypeDao theResourceTypeDao,
+			MemoryCacheService theMemoryCacheService) {
+		myTransactionService = theTransactionService;
+		myResourceTypeDao = theResourceTypeDao;
+		myMemoryCacheService = theMemoryCacheService;
+	}
+
+	@PostConstruct
+	public void start() {
+		initResourceTypes();
+		ourLog.info(
+				"Resource type cache size: {}",
+				myMemoryCacheService.getEstimatedSize(MemoryCacheService.CacheEnum.RES_TYPE_TO_RES_TYPE_ID));
+	}
+
+	@Override
+	public short getResourceTypeId(String theResType) {
+		Short resTypeId = myMemoryCacheService.get(
+				MemoryCacheService.CacheEnum.RES_TYPE_TO_RES_TYPE_ID, theResType, this::lookupResourceTypeId);
+
+		if (resTypeId == null) {
+			ourLog.info("Creating a new Resource Type [{}]", theResType);
+			ResourceTypeEntity entity = createResourceType(theResType);
+			resTypeId = entity.getResourceTypeId();
+			addToCache(theResType, resTypeId);
+		}
+		return resTypeId;
+	}
+
+	@Override
+	public void addToCache(String theResType, Short theResTypeId) {
+		myMemoryCacheService.putAfterCommit(
+				MemoryCacheService.CacheEnum.RES_TYPE_TO_RES_TYPE_ID, theResType, theResTypeId);
+	}
+
+	protected void initResourceTypes() {
+		myTransactionService
+				.withSystemRequestOnDefaultPartition()
+				.withPropagation(Propagation.REQUIRES_NEW)
+				.execute(() -> {
+					List<ResourceTypeEntity> resTypeEntities = myResourceTypeDao.findAll();
+					if (CollectionUtils.isEmpty(resTypeEntities)) {
+						List<ResourceTypeEntity> newEntities = ResourceTypeUtil.generateResourceTypes().stream()
+								.map(r -> {
+									ResourceTypeEntity entity = new ResourceTypeEntity();
+									entity.setResourceType(r);
+									return entity;
+								})
+								.toList();
+
+						myResourceTypeDao.saveAll(newEntities);
+						ourLog.info("Table HFJ_RESOURCE_TYPE is populated with {} entries.", newEntities.size());
+						resTypeEntities = newEntities;
+					}
+
+					// Populate the cache
+					resTypeEntities.forEach(r -> addToCache(r.getResourceType(), r.getResourceTypeId()));
+					return null;
+				});
+	}
+
+	protected ResourceTypeEntity createResourceType(String theResourceType) {
+		return myTransactionService
+				.withSystemRequestOnDefaultPartition()
+				.withPropagation(Propagation.REQUIRES_NEW)
+				.execute(() -> {
+					ResourceTypeEntity resTypeEntity = new ResourceTypeEntity();
+					resTypeEntity.setResourceType(theResourceType);
+					try {
+						resTypeEntity = myResourceTypeDao.save(resTypeEntity);
+						myResourceTypeDao.flush();
+					} catch (DataIntegrityViolationException e) {
+						if (e.getMessage().contains("Value too long for column")) {
+							throw new InternalErrorException("Resource type name is too long: " + theResourceType, e);
+						}
+						// This can happen if the resource type already exists in the database
+						ourLog.info("Resource type already exists: {}", theResourceType);
+						resTypeEntity = myResourceTypeDao.findByResourceType(theResourceType);
+					}
+
+					return resTypeEntity;
+				});
+	}
+
+	private Short lookupResourceTypeId(String theResourceType) {
+		return myTransactionService
+				.withSystemRequestOnDefaultPartition()
+				.execute(() -> myResourceTypeDao.findResourceIdByType(theResourceType));
+	}
+}
diff --git a/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/config/JpaConfig.java b/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/config/JpaConfig.java
@@ -43,8 +43,10 @@
 import ca.uhn.fhir.jpa.bulk.export.svc.BulkExportHelperService;
 import ca.uhn.fhir.jpa.bulk.imprt.api.IBulkDataImportSvc;
 import ca.uhn.fhir.jpa.bulk.imprt.svc.BulkDataImportSvcImpl;
+import ca.uhn.fhir.jpa.cache.IResourceTypeCacheSvc;
 import ca.uhn.fhir.jpa.cache.IResourceVersionSvc;
 import ca.uhn.fhir.jpa.cache.ISearchParamIdentityCacheSvc;
+import ca.uhn.fhir.jpa.cache.ResourceTypeCacheSvcImpl;
 import ca.uhn.fhir.jpa.cache.ResourceVersionSvcDaoImpl;
 import ca.uhn.fhir.jpa.dao.CacheTagDefinitionDao;
 import ca.uhn.fhir.jpa.dao.DaoSearchParamProvider;
@@ -62,6 +64,7 @@
 import ca.uhn.fhir.jpa.dao.data.IResourceLinkDao;
 import ca.uhn.fhir.jpa.dao.data.IResourceModifiedDao;
 import ca.uhn.fhir.jpa.dao.data.IResourceSearchUrlDao;
+import ca.uhn.fhir.jpa.dao.data.IResourceTypeDao;
 import ca.uhn.fhir.jpa.dao.data.ITagDefinitionDao;
 import ca.uhn.fhir.jpa.dao.expunge.ExpungeEverythingService;
 import ca.uhn.fhir.jpa.dao.expunge.ExpungeOperation;
@@ -75,6 +78,7 @@
 import ca.uhn.fhir.jpa.dao.index.IdHelperService;
 import ca.uhn.fhir.jpa.dao.index.SearchParamWithInlineReferencesExtractor;
 import ca.uhn.fhir.jpa.dao.tx.HapiTransactionService;
+import ca.uhn.fhir.jpa.dao.tx.IHapiTransactionService;
 import ca.uhn.fhir.jpa.dao.validation.SearchParameterDaoValidator;
 import ca.uhn.fhir.jpa.delete.DeleteConflictFinderService;
 import ca.uhn.fhir.jpa.delete.DeleteConflictService;
@@ -619,6 +623,14 @@ public ISearchParamIdentityCacheSvc searchParamIdentityCacheSvc(
 				myStorageSettings, theResourceIndexedSearchParamIdentityDao, theTxManager, theMemoryCacheService);
 	}

+	@Bean
+	public IResourceTypeCacheSvc resourceTypeCacheSvc(
+			@Autowired IHapiTransactionService theHapiTransactionService,
+			@Autowired IResourceTypeDao theResourceTypeDao,
+			@Autowired MemoryCacheService theMemoryCacheService) {
+		return new ResourceTypeCacheSvcImpl(theHapiTransactionService, theResourceTypeDao, theMemoryCacheService);
+	}
+
 	/* **************************************************************** *
 	 * Prototype Beans Below                                            *
 	 * **************************************************************** */

diff --git a/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/config/util/ResourceTypeUtil.java b/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/config/util/ResourceTypeUtil.java
@@ -0,0 +1,39 @@
+/*-
+ * #%L
+ * HAPI FHIR JPA Server
+ * %%
+ * 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.jpa.config.util;
+
+import ca.uhn.fhir.context.FhirContext;
+import ca.uhn.fhir.context.FhirVersionEnum;
+
+import java.util.List;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+public final class ResourceTypeUtil {
+
+	public static List<String> generateResourceTypes() {
+		return Stream.of(FhirVersionEnum.DSTU2, FhirVersionEnum.DSTU3, FhirVersionEnum.R4, FhirVersionEnum.R5)
+				.map(FhirContext::forVersion)
+				.flatMap(c -> c.getResourceTypes().stream())
+				.distinct()
+				.sorted()
+				.collect(Collectors.toList());
+	}
+}
diff --git a/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/dao/BaseHapiFhirDao.java b/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/dao/BaseHapiFhirDao.java
@@ -37,6 +37,7 @@
 import ca.uhn.fhir.jpa.api.model.DaoMethodOutcome;
 import ca.uhn.fhir.jpa.api.svc.IIdHelperService;
 import ca.uhn.fhir.jpa.api.svc.ISearchCoordinatorSvc;
+import ca.uhn.fhir.jpa.cache.IResourceTypeCacheSvc;
 import ca.uhn.fhir.jpa.dao.data.IResourceHistoryTableDao;
 import ca.uhn.fhir.jpa.dao.data.IResourceLinkDao;
 import ca.uhn.fhir.jpa.dao.data.IResourceTableDao;
@@ -106,6 +107,7 @@
 import jakarta.persistence.EntityManager;
 import jakarta.persistence.PersistenceContext;
 import jakarta.persistence.PersistenceContextType;
+import org.apache.commons.collections4.CollectionUtils;
 import org.apache.commons.lang3.NotImplementedException;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.Validate;
@@ -236,6 +238,9 @@ public abstract class BaseHapiFhirDao<T extends IBaseResource> extends BaseStora
 	@Autowired
 	protected CacheTagDefinitionDao cacheTagDefinitionDao;

+	@Autowired
+	protected IResourceTypeCacheSvc myResourceTypeCacheSvc;
+
 	protected final CodingSpy myCodingSpy = new CodingSpy();

 	@VisibleForTesting
@@ -490,6 +495,9 @@ protected EncodedResource populateResourceIntoEntity(
 		if (theEntity.getResourceType() == null) {
 			theEntity.setResourceType(toResourceName(theResource));
 		}
+		if (theEntity.getResourceTypeId() == null && theResource != null) {
+			theEntity.setResourceTypeId(myResourceTypeCacheSvc.getResourceTypeId(toResourceName(theResource)));
+		}

 		byte[] resourceBinary;
 		String resourceText;
@@ -993,6 +1001,10 @@ public ResourceTable updateEntity(
 						theRequest,
 						thePerformIndexing);

+				if (CollectionUtils.isNotEmpty(newParams.myLinks)) {
+					setTargetResourceTypeIdForResourceLinks(newParams.myLinks);
+				}
+
 				// Actually persist the ResourceTable and ResourceHistoryTable entities
 				changed = populateResourceIntoEntity(theTransactionDetails, theRequest, theResource, entity, true);

@@ -1718,6 +1730,11 @@ public void setJpaStorageResourceParserForUnitTest(IJpaStorageResourceParser the
 		myJpaStorageResourceParser = theJpaStorageResourceParser;
 	}

+	@VisibleForTesting
+	public void setResourceTypeCacheSvc(IResourceTypeCacheSvc theResourceTypeCacheSvc) {
+		myResourceTypeCacheSvc = theResourceTypeCacheSvc;
+	}
+
 	@SuppressWarnings("unchecked")
 	public static String parseContentTextIntoWords(FhirContext theContext, IBaseResource theResource) {

@@ -1806,4 +1823,11 @@ private enum CreateOrUpdateByMatch {
 		CREATE,
 		UPDATE
 	}
+
+	private void setTargetResourceTypeIdForResourceLinks(Collection<ResourceLink> resourceLinks) {
+		resourceLinks.stream()
+				.filter(link -> link.getTargetResourceType() != null)
+				.forEach(link -> link.setTargetResourceTypeId(
+						myResourceTypeCacheSvc.getResourceTypeId(link.getTargetResourceType())));
+	}
 }
diff --git a/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/dao/BaseHapiFhirResourceDao.java b/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/dao/BaseHapiFhirResourceDao.java
@@ -433,6 +433,7 @@ private DaoMethodOutcome doCreateForPostOrPut(

 		ResourceTable entity = new ResourceTable();
 		entity.setResourceType(toResourceName(theResource));
+		entity.setResourceTypeId(myResourceTypeCacheSvc.getResourceTypeId(toResourceName(theResource)));

 		RequestPartitionId targetWritePartitionId = myRequestPartitionHelperService.determineCreatePartitionForRequest(
 				theRequest, theResource, entity.getResourceType());

diff --git a/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/dao/data/IResourceTypeDao.java b/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/dao/data/IResourceTypeDao.java
@@ -0,0 +1,36 @@
+/*
+ * #%L
+ * HAPI FHIR JPA Server
+ * %%
+ * 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.jpa.dao.data;
+
+import ca.uhn.fhir.jpa.model.entity.ResourceTypeEntity;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.Query;
+import org.springframework.data.repository.query.Param;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface IResourceTypeDao extends JpaRepository<ResourceTypeEntity, Integer>, IHapiFhirJpaRepository {
+
+	@Query(value = "SELECT t FROM ResourceTypeEntity t WHERE t.myResourceType = :resType")
+	ResourceTypeEntity findByResourceType(@Param("resType") String theResType);
+
+	@Query(value = "SELECT t.myResourceTypeId FROM ResourceTypeEntity t WHERE t.myResourceType = :resType")
+	Short findResourceIdByType(@Param("resType") String theResType);
+}