Package ca.uhn.fhir.rest.annotation
Annotation Type AddTags
RESTful method annotation to be used for the FHIR Tag
Operations which have to do with adding tags.
-
To add tag(s) to the given resource
instance, this annotation should contain a
type()
attribute specifying the resource type, and the method should have a parameter of typeIdDt
annotated with theIdParam
annotation, as well as a parameter of typeTagList
. Note that thisTagList
parameter does not need to contain a complete list of tags for the resource, only a list of tags to be added. Server implementations must not remove tags based on this operation. Note that for a server implementation, thetype()
annotation is optional if the method is defined in a resource provider, since the type is implied. -
To add tag(s) on the server to 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 typeIdDt
annotated with theinvalid reference
VersionIdParam
IdDt
annotated with theIdParam
annotation, as well as a parameter of typeTagList
. Note that thisTagList
parameter does not need to contain a complete list of tags for the resource, only a list of tags to be added. Server implementations must not remove tags based on this operation. Note that for a server implementation, thetype()
annotation is optional if the method is defined in a resource provider, since the type is implied.
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionClass
<? extends IBaseResource> If set to a type other than the default (which isIResource
, this method is expected to return a TagList containing only tags which are specific to the given resource type.This method allows the return type for this method to be specified in a non-type-specific way, using the text name of the resource, e.g.
-
Element Details
-
type
Class<? extends IBaseResource> typeIf set to a type other than the default (which isIResource
, this method is expected to return a TagList containing only tags which are specific to the given resource type.- Default:
org.hl7.fhir.instance.model.api.IBaseResource.class
-
typeName
This method allows the return type for this method to be specified in a non-type-specific way, using the text name of the resource, e.g. "Patient". This attribute should be populate, ortype()
should be, but not both.- Since:
- 5.4.0
- Default:
""
-