Package org.hl7.fhir.r4.model

Enum SearchParameter.SearchModifierCode

java.lang.Object

java.lang.Enum<SearchParameter.SearchModifierCode>

org.hl7.fhir.r4.model.SearchParameter.SearchModifierCode

All Implemented Interfaces:

Serializable, Comparable<SearchParameter.SearchModifierCode>

Enclosing class:

SearchParameter

public static enum SearchParameter.SearchModifierCode
extends Enum<SearchParameter.SearchModifierCode>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABOVE	The search parameter tests whether the value in a resource subsumes the specified value (is-a, or hierarchical relationships).
BELOW	The search parameter tests whether the value in a resource is subsumed by the specified value (is-a, or hierarchical relationships).
CONTAINS	The search parameter returns resources that include the supplied parameter value anywhere within the field being searched.
EXACT	The search parameter returns resources that have a value that exactly matches the supplied parameter (the whole string, including casing and accents).
IDENTIFIER	The search parameter applies to the identifier on the resource, not the reference.
IN	The search parameter is a URI (relative or absolute) that identifies a value set, and the search parameter tests whether the coding is in the specified value set.
MISSING	The search parameter returns resources that have a value or not.
NOT	The search parameter returns resources that do not contain a match.
NOTIN	The search parameter is a URI (relative or absolute) that identifies a value set, and the search parameter tests whether the coding is not in the specified value set.
NULL	added to help the parsers with the generic types
OFTYPE	The search parameter has the format system|code|value, where the system and code refer to an Identifier.type.coding.system and .code, and match if any of the type codes match.
TEXT	The search parameter is processed as a string that searches text associated with the code/value - either CodeableConcept.text, Coding.display, or Identifier.type.text.
TYPE	The search parameter only applies to the Resource Type specified as a modifier (e.g.

Method Summary

Modifier and Type	Method	Description
static SearchParameter.SearchModifierCode	fromCode(String codeString)
String	getDefinition()
String	getDisplay()
String	getSystem()
String	toCode()
static SearchParameter.SearchModifierCode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SearchParameter.SearchModifierCode[]	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 Details

MISSING

public static final SearchParameter.SearchModifierCode MISSING

The search parameter returns resources that have a value or not.

EXACT

public static final SearchParameter.SearchModifierCode EXACT

The search parameter returns resources that have a value that exactly matches the supplied parameter (the whole string, including casing and accents).

CONTAINS

public static final SearchParameter.SearchModifierCode CONTAINS

The search parameter returns resources that include the supplied parameter value anywhere within the field being searched.

NOT

public static final SearchParameter.SearchModifierCode NOT

The search parameter returns resources that do not contain a match.

TEXT

public static final SearchParameter.SearchModifierCode TEXT

The search parameter is processed as a string that searches text associated with the code/value - either CodeableConcept.text, Coding.display, or Identifier.type.text.

IN

public static final SearchParameter.SearchModifierCode IN

The search parameter is a URI (relative or absolute) that identifies a value set, and the search parameter tests whether the coding is in the specified value set.

NOTIN

public static final SearchParameter.SearchModifierCode NOTIN

The search parameter is a URI (relative or absolute) that identifies a value set, and the search parameter tests whether the coding is not in the specified value set.

BELOW

public static final SearchParameter.SearchModifierCode BELOW

The search parameter tests whether the value in a resource is subsumed by the specified value (is-a, or hierarchical relationships).

ABOVE

public static final SearchParameter.SearchModifierCode ABOVE

The search parameter tests whether the value in a resource subsumes the specified value (is-a, or hierarchical relationships).

TYPE

public static final SearchParameter.SearchModifierCode TYPE

The search parameter only applies to the Resource Type specified as a modifier (e.g. the modifier is not actually :type, but :Patient etc.).

IDENTIFIER

public static final SearchParameter.SearchModifierCode IDENTIFIER

The search parameter applies to the identifier on the resource, not the reference.

OFTYPE

public static final SearchParameter.SearchModifierCode OFTYPE

The search parameter has the format system|code|value, where the system and code refer to an Identifier.type.coding.system and .code, and match if any of the type codes match. All 3 parts must be present.

NULL

public static final SearchParameter.SearchModifierCode NULL

added to help the parsers with the generic types

Method Details

values

public static SearchParameter.SearchModifierCode[] values()

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

Returns:

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

valueOf

public static SearchParameter.SearchModifierCode 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 SearchParameter.SearchModifierCode 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()