Package ca.uhn.fhir.rest.annotation

Annotation Type AddTags

  • @Target(METHOD)
@Retention(RUNTIME)
public @interface 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 type IdDt annotated with the IdParam annotation, as well as a parameter of type TagList. Note that this TagList 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, the type() 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 type IdDt annotated with the VersionIdParam annotation, and a parameter of type IdDt annotated with the IdParam annotation, as well as a parameter of type TagList. Note that this TagList 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, 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 Description
      Class<? extends IBaseResource> 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.
      String 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.

    • Element Detail

      • type

        Class<? extends IBaseResource> 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:
        org.hl7.fhir.instance.model.api.IBaseResource.class

      • typeName

        String 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, or type() should be, but not both.
        Since:
        5.4.0
        Default:
        ""