Package org.hl7.fhir.r4.model

Enum Enumerations.SearchParamType

java.lang.Object

java.lang.Enum<Enumerations.SearchParamType>

org.hl7.fhir.r4.model.Enumerations.SearchParamType

All Implemented Interfaces:

Serializable, Comparable<Enumerations.SearchParamType>

Enclosing class:

Enumerations

public static enum Enumerations.SearchParamType
extends Enum<Enumerations.SearchParamType>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPOSITE	A composite search parameter that combines a search on two values together.
DATE	Search parameter is on a date/time.
NULL	added to help the parsers
NUMBER	Search parameter SHALL be a number (a whole number, or a decimal).
QUANTITY	A search parameter that searches on a quantity.
REFERENCE	A reference to another resource (Reference or canonical).
SPECIAL	Special logic applies to this parameter per the description of the search parameter.
STRING	Search parameter is a simple string, like a name part.
TOKEN	Search parameter on a coded element or identifier.
URI	A search parameter that searches on a URI (RFC 3986).

Method Summary

Modifier and Type	Method	Description
static Enumerations.SearchParamType	fromCode(String codeString)
String	getDefinition()
String	getDisplay()
String	getSystem()
String	toCode()
static Enumerations.SearchParamType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Enumerations.SearchParamType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NUMBER

public static final Enumerations.SearchParamType NUMBER

Search parameter SHALL be a number (a whole number, or a decimal).

DATE

public static final Enumerations.SearchParamType DATE

Search parameter is on a date/time. The date format is the standard XML format, though other formats may be supported.

STRING

public static final Enumerations.SearchParamType STRING

Search parameter is a simple string, like a name part. Search is case-insensitive and accent-insensitive. May match just the start of a string. String parameters may contain spaces.

TOKEN

public static final Enumerations.SearchParamType TOKEN

Search parameter on a coded element or identifier. May be used to search through the text, display, code and code/codesystem (for codes) and label, system and key (for identifier). Its value is either a string or a pair of namespace and value, separated by a "|", depending on the modifier used.

REFERENCE

public static final Enumerations.SearchParamType REFERENCE

A reference to another resource (Reference or canonical).

COMPOSITE

public static final Enumerations.SearchParamType COMPOSITE

A composite search parameter that combines a search on two values together.

QUANTITY

public static final Enumerations.SearchParamType QUANTITY

A search parameter that searches on a quantity.

URI

public static final Enumerations.SearchParamType URI

A search parameter that searches on a URI (RFC 3986).

SPECIAL

public static final Enumerations.SearchParamType SPECIAL

Special logic applies to this parameter per the description of the search parameter.

NULL

public static final Enumerations.SearchParamType NULL

added to help the parsers

Method Detail

values

public static Enumerations.SearchParamType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Enumerations.SearchParamType c : Enumerations.SearchParamType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Enumerations.SearchParamType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromCode

public static Enumerations.SearchParamType fromCode(String codeString)
                                             throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

toCode

public String toCode()

getSystem

public String getSystem()

getDefinition

public String getDefinition()

getDisplay

public String getDisplay()