Package ca.uhn.fhir.model.api.annotation

Annotation Type SearchParamDefinition

@Target(FIELD)
@Retention(RUNTIME)
public @interface SearchParamDefinition

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	name	The name for this parameter
String	path	The path for this parameter

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	compositeOf	If the parameter is of type "composite", this parameter lists the names of the parameters which this parameter is a composite of.
String	description	A description of this parameter
Compartment[]	providesMembershipIn	Indicates that this field indicates that resources linked to by this parameter (must be a reference parameter) place the resource in the given compartment.
Class<? extends IBaseResource>[]	target	For search params of type "reference", this can optionally be used to specify the resource type(s) that this parameter applies to.
String	type	The type for this parameter, e.g.

Element Details

name

String name

The name for this parameter

path

String path

The path for this parameter

description

String description

A description of this parameter

Default:

""

type

String type

The type for this parameter, e.g. "string", or "token"

Default:

"string"

compositeOf

String[] compositeOf

If the parameter is of type "composite", this parameter lists the names of the parameters which this parameter is a composite of. E.g. "name-value-token" is a composite of "name" and "value-token".

If the parameter is not a composite, this parameter must be empty

Default:

{}

target

Class<? extends IBaseResource>[] target

For search params of type "reference", this can optionally be used to specify the resource type(s) that this parameter applies to.

Default:

{}

providesMembershipIn

Compartment[] providesMembershipIn

Indicates that this field indicates that resources linked to by this parameter (must be a reference parameter) place the resource in the given compartment.

Default:

{}