ca.uhn.fhir.rest.annotation

Annotation Type Read

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

RESTful method annotation to be used for the FHIR read and vread method.

If this method has a parameter annotated with the IdParam annotation and a parameter annotated with the VersionIdParam annotation, the method will be treated as a vread method. If the method has only a parameter annotated with the IdParam annotation, it will be treated as a read operation. the

If you wish for your server to support both read and vread operations, you will need two methods annotated with this annotation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends IBaseResource>	type The return type for this method.
boolean	version If set to true (default is false), this method supports vread operation as well as read

Element Detail

type

public abstract Class<? extends IBaseResource> type

The return type for this method. This generally does not need to be populated for IResourceProvider in a server implementation, but often does need to be populated in client implementations using IBasicClient or IRestfulClient, or in plain providers on a server.

This value also does not need to be populated if the return type for a method annotated with this annotation is sufficient to determine the type of resource provided. E.g. if the method returns Patient or List<Patient>, the server/client will automatically determine that the Patient resource is the return type, and this value may be left blank.

Default:

org.hl7.fhir.instance.model.api.IBaseResource.class

version

public abstract boolean version

If set to true (default is false), this method supports vread operation as well as read

Default:

false