Package org.hl7.fhir.dstu2016may.model

Class SearchParameter

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
    public class SearchParameter
extends DomainResource
    A search parameter that defines a named search item that can be used to search/filter on a resource.
    See Also:
    Serialized Form

    • Field Detail

      • url

        protected UriType url
        An absolute URL that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published.

      • name

        protected StringType name
        A free text natural language name identifying the search parameter.

      • experimental

        protected BooleanType experimental
        A flag to indicate that this search parameter definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

      • date

        protected DateTimeType date
        The date (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.

      • publisher

        protected StringType publisher
        The name of the individual or organization that published the search parameter.

      • useContext

        protected List<CodeableConcept> useContext
        The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of search parameters.

      • requirements

        protected StringType requirements
        The Scope and Usage that this search parameter was created to meet.

      • code

        protected CodeType code
        The code used in the URL or the parameter name in a parameters resource for this search parameter.

      • base

        protected CodeType base
        The base resource type that this search parameter refers to.

      • expression

        protected StringType expression
        A FluentPath expression that returns a set of elements for the search parameter.

      • xpath

        protected StringType xpath
        An XPath expression that returns a set of elements for the search parameter.

      • target

        protected List<CodeType> target
        Types of resource (if a resource is referenced).

      • SP_DESCRIPTION

        public static final String SP_DESCRIPTION
        Search parameter: description

        Description: Documentation for search parameter
        Type: string
        Path: SearchParameter.description

        See Also:
        Constant Field Values

      • DESCRIPTION

        public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
        Fluent Client search parameter constant for description

        Description: Documentation for search parameter
        Type: string
        Path: SearchParameter.description

      • SP_NAME

        public static final String SP_NAME
        Search parameter: name

        Description: Informal name for this search parameter
        Type: string
        Path: SearchParameter.name

        See Also:
        Constant Field Values

      • NAME

        public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
        Fluent Client search parameter constant for name

        Description: Informal name for this search parameter
        Type: string
        Path: SearchParameter.name

      • SP_CONTEXT

        public static final String SP_CONTEXT
        Search parameter: context

        Description: A use context assigned to the search parameter
        Type: token
        Path: SearchParameter.useContext

        See Also:
        Constant Field Values

      • CONTEXT

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
        Fluent Client search parameter constant for context

        Description: A use context assigned to the search parameter
        Type: token
        Path: SearchParameter.useContext

      • SP_TARGET

        public static final String SP_TARGET
        Search parameter: target

        Description: Types of resource (if a resource reference)
        Type: token
        Path: SearchParameter.target

        See Also:
        Constant Field Values

      • TARGET

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam TARGET
        Fluent Client search parameter constant for target

        Description: Types of resource (if a resource reference)
        Type: token
        Path: SearchParameter.target

      • SP_BASE

        public static final String SP_BASE
        Search parameter: base

        Description: The resource type this search parameter applies to
        Type: token
        Path: SearchParameter.base

        See Also:
        Constant Field Values

      • BASE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam BASE
        Fluent Client search parameter constant for base

        Description: The resource type this search parameter applies to
        Type: token
        Path: SearchParameter.base

      • CODE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
        Fluent Client search parameter constant for code

        Description: Code used in URL
        Type: token
        Path: SearchParameter.code

      • SP_TYPE

        public static final String SP_TYPE
        Search parameter: type

        Description: number | date | string | token | reference | composite | quantity | uri
        Type: token
        Path: SearchParameter.type

        See Also:
        Constant Field Values

      • TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
        Fluent Client search parameter constant for type

        Description: number | date | string | token | reference | composite | quantity | uri
        Type: token
        Path: SearchParameter.type

      • SP_URL

        public static final String SP_URL
        Search parameter: url

        Description: Absolute URL used to reference this search parameter
        Type: uri
        Path: SearchParameter.url

        See Also:
        Constant Field Values

      • URL

        public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
        Fluent Client search parameter constant for url

        Description: Absolute URL used to reference this search parameter
        Type: uri
        Path: SearchParameter.url

    • Method Detail

      • getUrlElement

        public UriType getUrlElement()
        Returns:
        url (An absolute URL that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

      • hasUrl

        public boolean hasUrl()

      • setUrlElement

        public SearchParameter setUrlElement​(UriType value)
        Parameters:
        value - url (An absolute URL that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

      • getUrl

        public String getUrl()
        Returns:
        An absolute URL that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published.

      • setUrl

        public SearchParameter setUrl​(String value)
        Parameters:
        value - An absolute URL that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published.

      • getNameElement

        public StringType getNameElement()
        Returns:
        name (A free text natural language name identifying the search parameter.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

      • hasName

        public boolean hasName()

      • setNameElement

        public SearchParameter setNameElement​(StringType value)
        Parameters:
        value - name (A free text natural language name identifying the search parameter.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

      • getName

        public String getName()
        Returns:
        A free text natural language name identifying the search parameter.

      • setName

        public SearchParameter setName​(String value)
        Parameters:
        value - A free text natural language name identifying the search parameter.

      • getExperimentalElement

        public BooleanType getExperimentalElement()
        Returns:
        experimental (A flag to indicate that this search parameter definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value

      • setExperimentalElement

        public SearchParameter setExperimentalElement​(BooleanType value)
        Parameters:
        value - experimental (A flag to indicate that this search parameter definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value

      • getExperimental

        public boolean getExperimental()
        Returns:
        A flag to indicate that this search parameter definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

      • setExperimental

        public SearchParameter setExperimental​(boolean value)
        Parameters:
        value - A flag to indicate that this search parameter definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

      • getDateElement

        public DateTimeType getDateElement()
        Returns:
        date (The date (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

      • hasDate

        public boolean hasDate()

      • setDateElement

        public SearchParameter setDateElement​(DateTimeType value)
        Parameters:
        value - date (The date (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

      • getDate

        public Date getDate()
        Returns:
        The date (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.

      • setDate

        public SearchParameter setDate​(Date value)
        Parameters:
        value - The date (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.

      • getPublisherElement

        public StringType getPublisherElement()
        Returns:
        publisher (The name of the individual or organization that published the search parameter.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value

      • setPublisherElement

        public SearchParameter setPublisherElement​(StringType value)
        Parameters:
        value - publisher (The name of the individual or organization that published the search parameter.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value

      • getPublisher

        public String getPublisher()
        Returns:
        The name of the individual or organization that published the search parameter.

      • setPublisher

        public SearchParameter setPublisher​(String value)
        Parameters:
        value - The name of the individual or organization that published the search parameter.

      • getUseContext

        public List<CodeableConcept> getUseContext()
        Returns:
        useContext (The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of search parameters.)

      • addUseContext

        public CodeableConcept addUseContext()
        Returns:
        useContext (The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of search parameters.)

      • getRequirementsElement

        public StringType getRequirementsElement()
        Returns:
        requirements (The Scope and Usage that this search parameter was created to meet.). This is the underlying object with id, value and extensions. The accessor "getRequirements" gives direct access to the value

      • setRequirementsElement

        public SearchParameter setRequirementsElement​(StringType value)
        Parameters:
        value - requirements (The Scope and Usage that this search parameter was created to meet.). This is the underlying object with id, value and extensions. The accessor "getRequirements" gives direct access to the value

      • getRequirements

        public String getRequirements()
        Returns:
        The Scope and Usage that this search parameter was created to meet.

      • getCodeElement

        public CodeType getCodeElement()
        Returns:
        code (The code used in the URL or the parameter name in a parameters resource for this search parameter.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value

      • hasCode

        public boolean hasCode()

      • setCodeElement

        public SearchParameter setCodeElement​(CodeType value)
        Parameters:
        value - code (The code used in the URL or the parameter name in a parameters resource for this search parameter.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value

      • getCode

        public String getCode()
        Returns:
        The code used in the URL or the parameter name in a parameters resource for this search parameter.

      • setCode

        public SearchParameter setCode​(String value)
        Parameters:
        value - The code used in the URL or the parameter name in a parameters resource for this search parameter.

      • getBaseElement

        public CodeType getBaseElement()
        Returns:
        base (The base resource type that this search parameter refers to.). This is the underlying object with id, value and extensions. The accessor "getBase" gives direct access to the value

      • hasBase

        public boolean hasBase()

      • setBaseElement

        public SearchParameter setBaseElement​(CodeType value)
        Parameters:
        value - base (The base resource type that this search parameter refers to.). This is the underlying object with id, value and extensions. The accessor "getBase" gives direct access to the value

      • getBase

        public String getBase()
        Returns:
        The base resource type that this search parameter refers to.

      • setBase

        public SearchParameter setBase​(String value)
        Parameters:
        value - The base resource type that this search parameter refers to.

      • getTypeElement

        public Enumeration<Enumerations.SearchParamType> getTypeElement()
        Returns:
        type (The type of value a search parameter refers to, and how the content is interpreted.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

      • hasType

        public boolean hasType()

      • getDescriptionElement

        public StringType getDescriptionElement()
        Returns:
        description (A description of the search parameters and how it used.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

      • setDescriptionElement

        public SearchParameter setDescriptionElement​(StringType value)
        Parameters:
        value - description (A description of the search parameters and how it used.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

      • getDescription

        public String getDescription()
        Returns:
        A description of the search parameters and how it used.

      • getExpressionElement

        public StringType getExpressionElement()
        Returns:
        expression (A FluentPath expression that returns a set of elements for the search parameter.). This is the underlying object with id, value and extensions. The accessor "getExpression" gives direct access to the value

      • setExpressionElement

        public SearchParameter setExpressionElement​(StringType value)
        Parameters:
        value - expression (A FluentPath expression that returns a set of elements for the search parameter.). This is the underlying object with id, value and extensions. The accessor "getExpression" gives direct access to the value

      • getExpression

        public String getExpression()
        Returns:
        A FluentPath expression that returns a set of elements for the search parameter.

      • setExpression

        public SearchParameter setExpression​(String value)
        Parameters:
        value - A FluentPath expression that returns a set of elements for the search parameter.

      • getXpathElement

        public StringType getXpathElement()
        Returns:
        xpath (An XPath expression that returns a set of elements for the search parameter.). This is the underlying object with id, value and extensions. The accessor "getXpath" gives direct access to the value

      • setXpathElement

        public SearchParameter setXpathElement​(StringType value)
        Parameters:
        value - xpath (An XPath expression that returns a set of elements for the search parameter.). This is the underlying object with id, value and extensions. The accessor "getXpath" gives direct access to the value

      • getXpath

        public String getXpath()
        Returns:
        An XPath expression that returns a set of elements for the search parameter.

      • setXpath

        public SearchParameter setXpath​(String value)
        Parameters:
        value - An XPath expression that returns a set of elements for the search parameter.

      • hasTarget

        public boolean hasTarget​(String value)
        Parameters:
        value - target (Types of resource (if a resource is referenced).)

      • getProperty

        public Base[] getProperty​(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • makeProperty

        public Base makeProperty​(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource