001/*-
002 * #%L
003 * HAPI FHIR - Core Library
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.fhirpath;
021
022import jakarta.annotation.Nonnull;
023import jakarta.annotation.Nullable;
024import org.hl7.fhir.instance.model.api.IBase;
025import org.hl7.fhir.instance.model.api.IIdType;
026
027import java.util.List;
028
029public interface IFhirPathEvaluationContext {
030
031        /**
032         * Evaluates the <code>resolve()</code> function and returns the target
033         * of the resolution.
034         *
035         * @param theReference The reference
036         * @param theContext The entity containing the reference. Note that this will be <code>null</code> for FHIR versions R4 and below.
037         */
038        default IBase resolveReference(@Nonnull IIdType theReference, @Nullable IBase theContext) {
039                return null;
040        }
041
042        /**
043         *
044         * @param appContext
045         * @param name The name of the constant(s) to be resolved
046         * @param beforeContext
047         * @return
048         */
049        default List<IBase> resolveConstant(Object appContext, String name, boolean beforeContext) {
050                return null;
051        }
052}