ca.uhn.fhir.rest.annotation

Annotation Type GetTags

@Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface GetTags

RESTful method annotation to be used for the FHIR Tag Operations which have to do with getting tags.

• To return a global list of all tags on the server, this annotation should not contain a type() attribute, and the method should not have an ID or Version ID parameter. On server implementations, the method must be defined in a plain provider.
• To return a list of all tags on the server for the given resource type, this annotation should contain a type() attribute specifying the resource type, and the method should not have an ID or Version ID parameter. Note that for a server implementation, the type() annotation is optional if the method is defined in a resource provider, since the type is implied.
• To return a list of all tags on the server for the given resource instance, this annotation should contain a type() attribute specifying the resource type, and the method should have a parameter of type IdDt annotated with the IdParam annotation. Note that for a server implementation, the type() annotation is optional if the method is defined in a resource provider, since the type is implied.
• To return a list of all tags on the server for the given version of the resource instance, this annotation should contain a type() attribute specifying the resource type, and the method should have a parameter of type IdDt annotated with the VersionIdParam annotation, and a parameter of type IdDt annotated with the IdParam annotation. Note that for a server implementation, the type() annotation is optional if the method is defined in a resource provider, since the type is implied.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends IResource>	type If set to a type other than the default (which is IResource , this method is expected to return a TagList containing only tags which are specific to the given resource type.

Element Detail

type

public abstract Class<? extends IResource> type

If set to a type other than the default (which is IResource , this method is expected to return a TagList containing only tags which are specific to the given resource type.

Default:

ca.uhn.fhir.model.api.IResource.class