All Classes and Interfaces
Class
Description
This class is used in RuleBuilder, as a way to provide a compartment permission additional resource search params that
are to be included as "in" the given compartment.
Helper class for working with FHIR Address element
Works like the normal
IncomingRequestAddressStrategy unless there's
an x-forwarded-host present, in which case that's used in place of the
server's address.This class is a base class for interceptors which can be used to
inspect requests and responses to determine whether the calling user
has permission to perform the given action.
Return type for
SearchNarrowingInterceptor.buildAuthorizedList(RequestDetails)This interceptor causes the server to reject invocations for HTTP methods
other than those supported by the server with an HTTP 405.
This class implements the Observation
$lastn operation.
This class is an abstraction for however primary keys are stored in the underlying storage engine.
This interceptor intercepts each incoming request and if it contains a FHIR resource, validates that resource.
This security interceptor checks any Binary resources that are being exposed to
a user and can forbid the user from accessing them based on the security context
found in
Binary.securityContext.identifier.Utility methods for working with
IBundleProviderBundle provider that uses named pages instead of counts
This interceptor examines a header on the incoming request and places it in
Resource.meta.source (R4 and above) or in an extension on Resource.meta
with the URL http://hapifhir.io/fhir/StructureDefinition/resource-meta-source (DSTU3).Users can define CDS Hooks extensions by extending this class.
A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resource
Represents a CDS Hooks Service Request
When populating the StructureDefinition links in a capability statement,
it can be useful to know the lowest common superclass for the profiles in use for a given resource name.
This is an
IInterceptorBroadcaster which combines multiple interceptor
broadcasters.Request object for
invalid reference
ca.uhn.fhir.interceptor.api.Pointcut#STORAGE_CONDITIONAL_URL_PREPROCESSRequest object for
invalid reference
ca.uhn.fhir.interceptor.api.Pointcut#STORAGE_CONDITIONAL_URL_PREPROCESSThe ConsentInterceptor can be used to apply arbitrary consent rules and data access policies
on responses from a FHIR server.
Consent Service that returns a fixed verdict.
Implementation of
IConsentService that forwards to another
implementation of IConsentService.Standardizes email addresses by removing whitespace, ISO control characters and applying lower-case to the values.
RESTful server behaviour for automatically adding profile tags
This interceptor looks for a URL parameter on requests called
_fhirpath and
replaces the resource being returned with a Parameters resource containing the results of
the given FHIRPath expression evaluated against the resource that would otherwise
have been returned.Tester that a resource matches a provided query filter.
Standardizes first name by capitalizing all characters following a separators (e.g.
This class is for holding headers for BaseJsonMessages.
Server address strategy which simply returns a hardcoded URL
This class is a simple implementation of the resource provider
interface that uses a HashMap to store all resources in memory.
Contract for validating addresses.
Adapt the InMemoryMatcher to support authorization filters in
FhirQueryRuleTester.Match outcomes.
Note: At this time, this interface is considered internal API to HAPI FHIR,
and is subject to change without warning.
Used by
AuthorizationInterceptor in order to allow user code to define authorization
rules.Allows user-supplied logic for authorization rules.
A request object to make this easier to extend.
This interface is intended to be implemented as the user-defined contract for
the
ConsentInterceptor.Something that produces a vote, along with static
tools for combining votes.
This is still an experimental API - It isn't meant for public consumption yet.
This class is the server specific equivalent to
IFhirVersionDetermines the server's base using the incoming request
Simplified model of indexed search parameter
This interceptor can be used to selectively block specific interactions/operations from
the server's capabilities.
Base class for
IServerInterceptor implementations.This object is an abstraction for a server response that is going to
return one or more resources to the user.
This interface is a parameter type for the
Pointcut.STORAGE_PRESHOW_RESOURCES
hook.Implementations of this interface represent a response back to the client from the server.
Describes the context for looking up individual search parameters or lists of search parameters.
Provides the server base for a given incoming request.
Provides methods to intercept requests and responses.
Deprecated.
Contract for standardizing textual primitives in the FHIR resources.
This interface isn't used by hapi-fhir-base, but is used by the
Web Testing UI
Standardizes last names by capitalizing all characters following a separators (e.g.
Server interceptor which logs each request using a defined format
For more details regarind the API refer to
https://www.loqate.com/resources/support/cleanse-api/international-batch-cleanse/
IConsentService combiner over several delegates with pluggable combination strategy
This is a generic implementation of the Observer Design Pattern.
Base class for an operation that has a resource type but not a resource body in the
request body
Standardizes phone numbers to fit 123-456-7890 pattern.
This is an intermediate record object that holds the offset and limit (count) the user requested for the page of results.
This interceptor uses the request tenant ID (as supplied to the server using
RestfulServer.setTenantIdentificationStrategy(ITenantIdentificationStrategy)
to indicate the partition ID.This interceptor intercepts each incoming request and if it contains a FHIR resource, validates that resource.
Holds all method bindings for an individual resource type
This Factory stores FHIR Resource Provider instance suppliers that will be registered on a FHIR Endpoint later.
Service to build a FHIR Bundle from a request and a Bundle Provider
This is a request object for selecting resources from a bundle provider and returning a bundle to the client
This interceptor detects when a request is coming from a browser, and automatically returns a response with syntax
highlighted (coloured) HTML for the response instead of just returning raw XML/JSON.
This is an intermediate record object that holds all the fields required to make the final bundle that will be returned to the client.
A builder for constructing ResponsePage objects.
This interceptor captures and makes
available the number of characters written (pre-compression if Gzip compression is being used) to the HTTP response
stream for FHIR responses.
Contains the results of the capture
This interceptor looks for coded data (
This interceptor leverages ConceptMap resources stored in the repository to automatically map
terminology from one CodeSystem to another at runtime, in resources that are being
returned by the server.
This interceptor intercepts each outgoing response and if it contains a FHIR resource, validates that resource.
This class is the central class for the HAPI FHIR Plain Server framework.
Implement rule based search result filtering as a ConsentService.
This interceptor can be used to automatically narrow the scope of searches in order to
automatically restrict the searches to specific compartments.
This interceptor allows a client to request that a Media resource be
served as the raw contents of the resource, assuming either:
The client explicitly requests the correct content type using the Accept header
The client explicitly requests raw output by adding the parameter
_output=data
Server FHIR Provider which serves the conformance statement for a RESTful server implementation
NOP implementation of
IServerOperationInterceptorPre-defined standardizers
This interceptor replaces the auto-generated CapabilityStatement that is generated
by the HAPI FHIR Server with a static hard-coded resource.
A default RequestDetails implementation that can be used for system calls to
Resource DAO methods when partitioning is enabled.
A default RestfulResponse that returns the body as an IBaseResource and ignores everything else.
Standardizes text literals by removing noise characters.
This object contains runtime information that is gathered and relevant to a single database transaction.
This class is a tenant identification strategy which assumes that a single path
element will be present between the server base URL and individual request.
This interceptor creates verbose server log entries containing the complete request and response payloads.
Hookannotation without needing to implement any interceptor