Package ca.uhn.fhir.rest.annotation

Annotation Type Validate

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

Validate is used to accept a resource, and test whether it would be acceptable for storing (e.g. using an update or create method)

FHIR Version Note: The validate operation was defined as a type operation in DSTU1 using a URL syntax like http://example.com/Patient/_validate. In DSTU2, validation has been switched to being an extended operation using a URL syntax like http://example.com/Patient/$validate, with a n

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static @interface 
    Validate.Mode
    Validation mode parameter annotation for the validation mode parameter (only supported in FHIR DSTU2+).
    static @interface 
    Validate.Profile
    Validation mode parameter annotation for the validation URI parameter (only supported in FHIR DSTU2+).

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<? extends IBaseResource>
    type
    The return type for this 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 method. This generally does not need to be populated for a server implementation (using an IResourceProvider, since resource providers will return only one resource type 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:
      ""