Class SearchParamType

  • All Implemented Interfaces:
    Visitable

    @Generated("com.ibm.fhir.tools.CodeGenerator")
    public class SearchParamType
    extends Code
    • Field Detail

      • NUMBER

        public static final SearchParamType NUMBER
        Number

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

      • DATE

        public static final SearchParamType DATE
        Date/DateTime

        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 SearchParamType STRING
        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 SearchParamType TOKEN
        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 SearchParamType REFERENCE
        Reference

        A reference to another resource (Reference or canonical).

      • COMPOSITE

        public static final SearchParamType COMPOSITE
        Composite

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

      • QUANTITY

        public static final SearchParamType QUANTITY
        Quantity

        A search parameter that searches on a quantity.

      • URI

        public static final SearchParamType URI
        URI

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

      • SPECIAL

        public static final SearchParamType SPECIAL
        Special

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

    • Method Detail

      • of

        public static SearchParamType of​(String value)
        Factory method for creating SearchParamType objects from a passed string value.
        Parameters:
        value - A string that matches one of the allowed code values
        Throws:
        IllegalArgumentException - If the passed string cannot be parsed into an allowed code value
      • string

        public static String string​(String value)
        Inherited factory method for creating SearchParamType objects from a passed string value.
        Parameters:
        value - A string that matches one of the allowed code values
        Throws:
        IllegalArgumentException - If the passed string cannot be parsed into an allowed code value
      • code

        public static Code code​(String value)
        Inherited factory method for creating SearchParamType objects from a passed string value.
        Parameters:
        value - A string that matches one of the allowed code values
        Throws:
        IllegalArgumentException - If the passed string cannot be parsed into an allowed code value
      • equals

        public boolean equals​(Object obj)
        Overrides:
        equals in class Code
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Code