Package ca.uhn.fhir.rest.annotation

Annotation Type Delete

@Retention(RUNTIME) @Target(METHOD) public @interface Delete
RESTful method annotation to be used for the FHIR delete method.

Delete is used to remove an existing resource, meaning that any attempts to do a non-version-specific read of that resource will fail.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<? extends IBaseResource>
    type
    The return type for this search method.
    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 Details

    • type

      Class<? extends IBaseResource> type
      The return type for this search method. This generally does not need to be populated for a server implementation, since servers will return only one resource per class, but generally does need to be populated for client implementations.
      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:
      ""