fhir_r4_path library
Classes
- AcceptLanguageHeader
- BaseWorkerContext
- A base implementation for worker context with caching
-
CachedCanonicalResource<
T extends CanonicalResource> -
A simple cached wrapper around a fully loaded
CanonicalResource. - CacheEntry
- Represents an entry in the terminology cache.
- CacheToken
- Represents a token used for caching.
- CanonicalResourceCache
- A canonical resource manager that eagerly loads and caches resources.
- ClassTypeInfo
- ClientLogger
- A logger class to handle client requests and responses in different formats.
- CodeInValueSetResult
- The result of checking a code against a value set
- ElementDefinitionMatch
- ExecutionContext
- ExecutionTypeContext
- ExpressionNode
- ExpressionNodeWithOffset
- FHIRConstant
- FHIRLexer
- FHIRPathConstant
- FHIRPathEngine
- FhirToolingClient
- Simplified FHIR client for terminology validation operations.
- FunctionDetails
- ICoding
- Utility Class to see if a resource has coding fields
- IEvaluationContext
- if the fhir path expressions are allowed to use constants beyond those defined in the specification the application can implement them by providing a constant resolver
- IValidationContextResourceLoader
- Interface for a resource loader in the validation context. Allows partially loaded resources to be fully resolved when needed.
- LanguagePreference
- LoggingService
- A logging service to log messages and debug information.
- NamedCache
- Represents a named cache.
- OnlineResourceCache
- An online-capable extension of CanonicalResourceCache. Falls back to HTTP GET when a resource isn't cached locally.
- PackageVersion
- ProfiledType
- ResourceCache
- A cache for FHIR resources.
- SourceLocation
- TerminologyCache
- A two-level cache for managing terminology operations.
- TerminologyClient
- A stub for terminology client for external services
- TerminologyServiceErrorClass
- Classifies different types of errors that can occur during terminology services operations.
-
TerminologyServiceErrorClassCopyWithImpl<
T> -
The generated implementation of the copyWith helper for Element.
The call method uses parameters of type Object? with a default value of
fhirSentinelso that omitted parameters retain the sentinel value while explicit nulls do not. - TypeConvertor
-
Extension to convert a String to
FhirBase64Binary - TypeDetails
- ValidationContextCarrier
- ValidationContextCarrier provides additional resources or context that may be relevant during validation. It allows resources to be resolved dynamically if they become necessary.
- ValidationContextResourceProxy
-
Proxy for a validation context resource. This can either represent
a fully resolved
Resourceor a partially resolvedElementwith a loader. - ValidationOptions
- A class representing validation options for FHIR validation processes.
- ValidationResult
- Represents the result of a validation operation, including its outcome and related metadata.
- ValidatorFetcher
- ValidatorFetcher is a utility class that fetches and validates resources
- ValueSetCacheToken
- A token to identify a cached expansion
- ValueSetChecker
- A simple value set checker that only checks for membership
- ValueSetExpander
- Interface for a value set expander
- ValueSetExpanderSimple
- A simple in-memory ValueSet expander
- ValueSetExpansionOutcome
- The result of a ValueSet expansion
- VersionUtilities
- WorkerContext
Enums
- CollectionStatus
- ExpressionNodeKind
- FhirPublication
- FpEquality
- FpFunction
- FpOperation
- LogCategory
- Enum to represent log categories.
Extensions
- FhirPathElementDefinitionExtension on ElementDefinition
-
Extension on
ElementDefinitionto provide additional functionality - FhirPathIntExtension on int
- Extension methods for the int class.
-
FhirPathResourceExtension
on Map<
String, dynamic> -
The FHIRPath engine's
inContextfunction. - ValueSetExpansionExtensions on WorkerContext
- Extension for WorkerContext to handle ValueSet expansion
Constants
- NS_SYSTEM_TYPE → const String
Functions
-
executeFhirPath(
{required FhirBase? context, required ExpressionNode parsedFhirPath, required String pathExpression, FhirBase? resource, FhirBase? rootResource, Map< String, dynamic> ? environment}) → Future<List< FhirBase> > - Execute the FHIRPath as pre-parsed by parseFhirPath.
-
isSystemVariable(
String name) → bool -
isWhitespace(
dynamic value) → bool -
parseFhirPath(
String pathExpression) → Future< ExpressionNode> - Parse a FHIRPath for repeated use with different inputs later.
-
walkFhirPath(
{required FhirBase? context, required String pathExpression, FhirBase? resource, FhirBase? rootResource, Map< String, dynamic> ? environment}) → Future<List< FhirBase> > - Start here! This is where the fun begins. This is a bit confusing, so we'll explain the arguments that can be passed.
Exceptions / Errors
- ETooCostly
- Exception for when a ValueSet is too costly to expand
- FHIRLexerException
- Represents an error that occurred during the lexing phase of FHIRPath parsing.
- FhirPathDeprecatedExpressionException
- The FHIRPath expression is using elements that have been deprecated.
- FhirPathEvaluationException
- The evaluation of the expression failed with the given parameters.
- FhirPathException
- Something went wrong while parsing or executing a FHIRPath expression.
- FhirPathInvalidExpressionException
- The overall syntax of the expression is incorrect.
- NoTerminologyServiceException
- Exception thrown when a terminology service is not available.
- PathEngineError
- An error that occurs during FHIRPath evaluation.
- PathEngineException
- An exception that occurs during FHIRPath evaluation.