Package org.hl7.fhir.r5.model

Enum Enumerations.SearchModifierCode

java.lang.Object

java.lang.Enum<Enumerations.SearchModifierCode>

org.hl7.fhir.r5.model.Enumerations.SearchModifierCode

All Implemented Interfaces:

Serializable, Comparable<Enumerations.SearchModifierCode>

Enclosing class:

Enumerations

public static enum Enumerations.SearchModifierCode
extends Enum<Enumerations.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).
CODETEXT	Tests whether the textual display value in a resource (e.g., CodeableConcept.text, Coding.display, or Reference.display) matches the supplied parameter value.
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.
ITERATE	The search parameter indicates an inclusion directive (_include, _revinclude) that is applied to an included resource instead of the matching resource.
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
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, Identifier.type.text, or Reference.display.
TEXTADVANCED	Tests whether the value in a resource matches the supplied parameter value using advanced text handling that searches text associated with the code/value - e.g., 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 Enumerations.SearchModifierCode	fromCode(String codeString)
String	getDefinition()
String	getDisplay()
String	getSystem()
static boolean	isValidCode(String codeString)
String	toCode()
static Enumerations.SearchModifierCode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Enumerations.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 Enumerations.SearchModifierCode MISSING

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

EXACT

public static final Enumerations.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 Enumerations.SearchModifierCode CONTAINS

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

NOT

public static final Enumerations.SearchModifierCode NOT

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

TEXT

public static final Enumerations.SearchModifierCode TEXT

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

IN

public static final Enumerations.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 Enumerations.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 Enumerations.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 Enumerations.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 Enumerations.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 Enumerations.SearchModifierCode IDENTIFIER

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

OFTYPE

public static final Enumerations.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.

CODETEXT

public static final Enumerations.SearchModifierCode CODETEXT

Tests whether the textual display value in a resource (e.g., CodeableConcept.text, Coding.display, or Reference.display) matches the supplied parameter value.

TEXTADVANCED

public static final Enumerations.SearchModifierCode TEXTADVANCED

Tests whether the value in a resource matches the supplied parameter value using advanced text handling that searches text associated with the code/value - e.g., CodeableConcept.text, Coding.display, or Identifier.type.text.

ITERATE

public static final Enumerations.SearchModifierCode ITERATE

The search parameter indicates an inclusion directive (_include, _revinclude) that is applied to an included resource instead of the matching resource.

NULL

public static final Enumerations.SearchModifierCode NULL

added to help the parsers

Method Details

values

public static Enumerations.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 Enumerations.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 Enumerations.SearchModifierCode fromCode(String codeString)
                                                throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

isValidCode

public static boolean isValidCode(String codeString)

toCode

public String toCode()

getSystem

public String getSystem()

getDefinition

public String getDefinition()

getDisplay

public String getDisplay()