001/*-
002 * #%L
003 * HAPI FHIR Storage api
004 * %%
005 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 *
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package ca.uhn.fhir.jpa.searchparam.extractor;
021
022import ca.uhn.fhir.rest.api.server.RequestDetails;
023import ca.uhn.fhir.rest.api.server.storage.TransactionDetails;
024import org.hl7.fhir.instance.model.api.IBaseResource;
025
026public interface ISearchParamWithInlineReferencesExtractor {
027
028        /**
029         * Handle references within the resource that are match URLs, for example references like "Patient?identifier=foo".
030         * These match URLs are resolved and replaced with the ID of the
031         * matching resource.
032         */
033        void extractInlineReferences(
034                        RequestDetails theRequestDetails, IBaseResource theResource, TransactionDetails theTransactionDetails);
035}