Package ca.uhn.fhir.rest.annotation

Annotation Types Summary

Annotation Type	Description
AddTags	RESTful method annotation to be used for the FHIR Tag Operations which have to do with adding tags.
At	Parameter annotation for the _at parameter, which indicates to the server that only results dated since the given instant will be returned.
ConditionalUrlParam	On the Update, Create and Delete operation methods, this annotation can be used to mark a String parameter which will be populated with the conditional "search" URL for the operation, if an incoming client invocation is a conditional operation.
Count	Parameter annotation for the _count parameter, which indicates to the server the maximum number of desired results.
Create
Delete	RESTful method annotation to be used for the FHIR delete method.
DeleteTags	RESTful method annotation to be used for the FHIR Tag Operations which have to do with deleting tags.
Destroy	ResourceProvider methods tagged with Destroy will be invoked when the RestfulServer is shut down.
Elements	On a method which returns resource(s), a parameter of type Set<String> with this annotation will be passed the contents of the _elements parameter
GetPage	INTERNAL API (do not use): REST method annotation for the method called when a client requests a page.
GraphQL	A method annotated with this annotation will be treated as a GraphQL implementation method
GraphQLQueryBody	This annotation should be placed on the parameter of a @GraphQL annotated method.
GraphQLQueryUrl	This annotation should be placed on the parameter of a @GraphQL annotated method.
History	RESTful method annotation to be used for the FHIR history method.
IdParam
IncludeParam	Method parameter which is used to indicate a parameter that will be populated with the "_include" (or "_revinclude") values for a search param.
Initialize	ResourceProvider methods tagged with Initialize will be invoked when the RestfulServer is starting up.
Metadata	RESTful method annotation used for a method which provides the FHIR "conformance" method.
Offset	Parameter annotation for the _offset parameter, which indicates to the server the offset of desired results.
Operation	RESTful method annotation used for a method which provides FHIR "operations".
OperationParam
OptionalParam	Parameter annotation which specifies a search parameter for a Search method.
PageIdParam	Parameter annotation which specifies the parameter to receive the ID of the page being requested.
Patch	RESTful method annotation to be used for the proposed FHIR PATCH method
RawParam	On a Search method, a parameter marked with this annotation will receive search parameters not captured by other parameters.
Read	RESTful method annotation to be used for the FHIR read and vread method.
RequiredParam	Parameter annotation which specifies a search parameter for a Search method.
ResourceParam	Denotes a parameter for a REST method which will contain the resource actually being created/updated/etc in an operation which contains a resource in the HTTP request.
Search	RESTful method annotation used for a method which provides the FHIR "search" method.
ServerBase	RESTful server method parameter annotation which indicates that the parameter should be injected with the HTTP server base.
Since	Parameter annotation for the _since parameter, which indicates to the server that only results dated since the given instant will be returned.
Sort	For searches, a parameter may be annotated with the Sort annotation.
Transaction	RESTful method annotation to be used for the FHIR transaction method.
TransactionParam	Parameter annotation for the "transaction" operation.
Update	RESTful method annotation to be used for the FHIR update method.
Validate	RESTful method annotation to be used for the FHIR validate method.
Validate.Mode	Validation mode parameter annotation for the validation mode parameter (only supported in FHIR DSTU2+).
Validate.Profile	Validation mode parameter annotation for the validation URI parameter (only supported in FHIR DSTU2+).