Package org.hl7.fhir.r4.model.codesystems

Enum Class SearchModifierCode

java.lang.Object
java.lang.Enum<SearchModifierCode>
org.hl7.fhir.r4.model.codesystems.SearchModifierCode
All Implemented Interfaces:
Serializable, Comparable<SearchModifierCode>, Constable
public enum SearchModifierCode extends Enum<SearchModifierCode>

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • 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
    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. the modifier is not actually :type, but :Patient etc.).

  • Method Summary

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

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, 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 SearchModifierCode MISSING
      The search parameter returns resources that have a value or not.

    • EXACT

      public static final 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 SearchModifierCode CONTAINS
      The search parameter returns resources that include the supplied parameter value anywhere within the field being searched.

    • NOT

      public static final SearchModifierCode NOT
      The search parameter returns resources that do not contain a match.

    • TEXT

      public static final 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 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 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 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 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 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 SearchModifierCode IDENTIFIER
      The search parameter applies to the identifier on the resource, not the reference.

    • OFTYPE

      public static final 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 SearchModifierCode NULL
      added to help the parsers

  • Method Details

    • values

      public static SearchModifierCode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SearchModifierCode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • fromCode

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