ca.uhn.fhir.model.api.annotation

Annotation Type SearchParamDefinition

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

Required Element Summary

Required Elements

Modifier and Type	Required Element and 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 and 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 Detail

name

public abstract String name

The name for this parameter

path

public abstract String path

The path for this parameter

description

public abstract String description

A description of this parameter

Default:

""

type

public abstract String type

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

Default:

"string"

compositeOf

public abstract 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

public abstract 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

public abstract 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:

{}