Package ca.uhn.fhir.fhirpath

Interface IFhirPath

public interface IFhirPath

Method Summary

Modifier and Type	Method	Description
<T extends IBase> List<T>	evaluate(IBase theInput, String thePath, Class<T> theReturnType)	Apply the given FhirPath expression against the given input and return all results in a list
<T extends IBase> Optional<T>	evaluateFirst(IBase theInput, String thePath, Class<T> theReturnType)	Apply the given FhirPath expression against the given input and return the first match (if any)
void	parse(String theExpression)	Parses the expression and throws an exception if it can not parse correctly
void	setEvaluationContext(IFhirPathEvaluationContext theEvaluationContext)	This method can be used optionally to supply an evaluation context for the FHIRPath evaluator instance.

Method Details

evaluate

<T extends IBase> List<T> evaluate(IBase theInput,
 String thePath,
 Class<T> theReturnType)

Apply the given FhirPath expression against the given input and return all results in a list

Parameters:

theInput - The input object (generally a resource or datatype)

thePath - The fluent path expression

theReturnType - The type to return (in order to avoid casting)

evaluateFirst

<T extends IBase> Optional<T> evaluateFirst(IBase theInput,
 String thePath,
 Class<T> theReturnType)

Apply the given FhirPath expression against the given input and return the first match (if any)

Parameters:

theInput - The input object (generally a resource or datatype)

thePath - The fluent path expression

theReturnType - The type to return (in order to avoid casting)

parse

void parse(String theExpression)
    throws Exception

Parses the expression and throws an exception if it can not parse correctly

Throws:

Exception

setEvaluationContext

void setEvaluationContext(@Nonnull
 IFhirPathEvaluationContext theEvaluationContext)

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 resolve() function to fetch referenced resources.

Since:

6.4.0