Class SearchParameter

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class SearchParameter
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR SearchParameter Resource (conformance.behavior)

    Definition: A search parameter that defines a named search item that can be used to search/filter on a resource.

    Requirements:

    Profile Definition: http://hl7.org/fhir/profiles/SearchParameter

    See Also:
    Serialized Form
    • Field Detail

      • URL

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

        Description:
        Type: uri
        Path: SearchParameter.url

      • NAME

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

        Description:
        Type: string
        Path: SearchParameter.name

      • BASE

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

        Description:
        Type: token
        Path: SearchParameter.base

      • TYPE

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

        Description:
        Type: token
        Path: SearchParameter.type

      • DESCRIPTION

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

        Description:
        Type: string
        Path: SearchParameter.description

      • TARGET

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

        Description:
        Type: token
        Path: SearchParameter.target

      • CODE

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

        Description:
        Type: token
        Path: SearchParameter.code

    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getUrlElement

        public ca.uhn.fhir.model.primitive.UriDt getUrlElement()
        Gets the value(s) for url (id). creating it if it does not exist. Will not return null.

        Definition: 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

      • getUrl

        public String getUrl()
        Gets the value(s) for url (id). creating it if it does not exist. This method may return null.

        Definition: 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​(ca.uhn.fhir.model.primitive.UriDt theValue)
        Sets the value(s) for url (id)

        Definition: 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 theUri)
        Sets the value for url (id)

        Definition: 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 ca.uhn.fhir.model.primitive.StringDt getNameElement()
        Gets the value(s) for name (). creating it if it does not exist. Will not return null.

        Definition: A free text natural language name identifying the search parameter

      • getName

        public String getName()
        Gets the value(s) for name (). creating it if it does not exist. This method may return null.

        Definition: A free text natural language name identifying the search parameter

      • setName

        public SearchParameter setName​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for name ()

        Definition: A free text natural language name identifying the search parameter

      • setName

        public SearchParameter setName​(String theString)
        Sets the value for name ()

        Definition: A free text natural language name identifying the search parameter

      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<ConformanceResourceStatusEnumgetStatusElement()
        Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

        Definition: The status of this search parameter definition

      • getStatus

        public String getStatus()
        Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

        Definition: The status of this search parameter definition

      • getExperimentalElement

        public ca.uhn.fhir.model.primitive.BooleanDt getExperimentalElement()
        Gets the value(s) for experimental (class). creating it if it does not exist. Will not return null.

        Definition: 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

      • getExperimental

        public Boolean getExperimental()
        Gets the value(s) for experimental (class). creating it if it does not exist. This method may return null.

        Definition: 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​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for experimental (class)

        Definition: 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 theBoolean)
        Sets the value for experimental (class)

        Definition: 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

      • getPublisherElement

        public ca.uhn.fhir.model.primitive.StringDt getPublisherElement()
        Gets the value(s) for publisher (who.witness). creating it if it does not exist. Will not return null.

        Definition: The name of the individual or organization that published the search parameter

      • getPublisher

        public String getPublisher()
        Gets the value(s) for publisher (who.witness). creating it if it does not exist. This method may return null.

        Definition: The name of the individual or organization that published the search parameter

      • setPublisher

        public SearchParameter setPublisher​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for publisher (who.witness)

        Definition: The name of the individual or organization that published the search parameter

      • setPublisher

        public SearchParameter setPublisher​(String theString)
        Sets the value for publisher (who.witness)

        Definition: The name of the individual or organization that published the search parameter

      • getContact

        public List<SearchParameter.ContactgetContact()
        Gets the value(s) for contact (). creating it if it does not exist. Will not return null.

        Definition: Contacts to assist a user in finding and communicating with the publisher

      • addContact

        public SearchParameter.Contact addContact()
        Adds and returns a new value for contact ()

        Definition: Contacts to assist a user in finding and communicating with the publisher

      • addContact

        public SearchParameter addContact​(SearchParameter.Contact theValue)
        Adds a given new value for contact ()

        Definition: Contacts to assist a user in finding and communicating with the publisher

        Parameters:
        theValue - The contact to add (must not be null)
      • getContactFirstRep

        public SearchParameter.Contact getContactFirstRep()
        Gets the first repetition for contact (), creating it if it does not already exist.

        Definition: Contacts to assist a user in finding and communicating with the publisher

      • getDateElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getDateElement()
        Gets the value(s) for date (when.recorded). creating it if it does not exist. Will not return null.

        Definition: 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

      • getDate

        public Date getDate()
        Gets the value(s) for date (when.recorded). creating it if it does not exist. This method may return null.

        Definition: 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​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for date (when.recorded)

        Definition: 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 theDate,
                                       ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for date (when.recorded)

        Definition: 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

      • setDateWithSecondsPrecision

        public SearchParameter setDateWithSecondsPrecision​(Date theDate)
        Sets the value for date (when.recorded)

        Definition: 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

      • getRequirementsElement

        public ca.uhn.fhir.model.primitive.StringDt getRequirementsElement()
        Gets the value(s) for requirements (why). creating it if it does not exist. Will not return null.

        Definition: The Scope and Usage that this search parameter was created to meet

      • getRequirements

        public String getRequirements()
        Gets the value(s) for requirements (why). creating it if it does not exist. This method may return null.

        Definition: The Scope and Usage that this search parameter was created to meet

      • setRequirements

        public SearchParameter setRequirements​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for requirements (why)

        Definition: The Scope and Usage that this search parameter was created to meet

      • setRequirements

        public SearchParameter setRequirements​(String theString)
        Sets the value for requirements (why)

        Definition: The Scope and Usage that this search parameter was created to meet

      • getCodeElement

        public ca.uhn.fhir.model.primitive.CodeDt getCodeElement()
        Gets the value(s) for code (). creating it if it does not exist. Will not return null.

        Definition: The code used in the URL or the parameter name in a parameters resource for this search parameter

      • getCode

        public String getCode()
        Gets the value(s) for code (). creating it if it does not exist. This method may return null.

        Definition: The code used in the URL or the parameter name in a parameters resource for this search parameter

      • setCode

        public SearchParameter setCode​(ca.uhn.fhir.model.primitive.CodeDt theValue)
        Sets the value(s) for code ()

        Definition: The code used in the URL or the parameter name in a parameters resource for this search parameter

      • setCode

        public SearchParameter setCode​(String theCode)
        Sets the value for code ()

        Definition: The code used in the URL or the parameter name in a parameters resource for this search parameter

      • getBaseElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnumgetBaseElement()
        Gets the value(s) for base (). creating it if it does not exist. Will not return null.

        Definition: The base resource type that this search parameter refers to

      • getBase

        public String getBase()
        Gets the value(s) for base (). creating it if it does not exist. This method may return null.

        Definition: The base resource type that this search parameter refers to

      • setBase

        public SearchParameter setBase​(ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum> theValue)
        Sets the value(s) for base ()

        Definition: The base resource type that this search parameter refers to

      • getTypeElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<SearchParamTypeEnumgetTypeElement()
        Gets the value(s) for type (). creating it if it does not exist. Will not return null.

        Definition: The type of value a search parameter refers to, and how the content is interpreted

      • getType

        public String getType()
        Gets the value(s) for type (). creating it if it does not exist. This method may return null.

        Definition: The type of value a search parameter refers to, and how the content is interpreted

      • setType

        public SearchParameter setType​(ca.uhn.fhir.model.primitive.BoundCodeDt<SearchParamTypeEnum> theValue)
        Sets the value(s) for type ()

        Definition: The type of value a search parameter refers to, and how the content is interpreted

      • getDescriptionElement

        public ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()
        Gets the value(s) for description (). creating it if it does not exist. Will not return null.

        Definition: A description of the search parameters and how it used

      • getDescription

        public String getDescription()
        Gets the value(s) for description (). creating it if it does not exist. This method may return null.

        Definition: A description of the search parameters and how it used

      • setDescription

        public SearchParameter setDescription​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for description ()

        Definition: A description of the search parameters and how it used

      • setDescription

        public SearchParameter setDescription​(String theString)
        Sets the value for description ()

        Definition: A description of the search parameters and how it used

      • getXpathElement

        public ca.uhn.fhir.model.primitive.StringDt getXpathElement()
        Gets the value(s) for xpath (). creating it if it does not exist. Will not return null.

        Definition: An XPath expression that returns a set of elements for the search parameter

      • getXpath

        public String getXpath()
        Gets the value(s) for xpath (). creating it if it does not exist. This method may return null.

        Definition: An XPath expression that returns a set of elements for the search parameter

      • setXpath

        public SearchParameter setXpath​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for xpath ()

        Definition: An XPath expression that returns a set of elements for the search parameter

      • setXpath

        public SearchParameter setXpath​(String theString)
        Sets the value for xpath ()

        Definition: An XPath expression that returns a set of elements for the search parameter

      • getXpathUsageElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<XPathUsageTypeEnumgetXpathUsageElement()
        Gets the value(s) for xpathUsage (). creating it if it does not exist. Will not return null.

        Definition: How the search parameter relates to the set of elements returned by evaluating the xpath query

      • getXpathUsage

        public String getXpathUsage()
        Gets the value(s) for xpathUsage (). creating it if it does not exist. This method may return null.

        Definition: How the search parameter relates to the set of elements returned by evaluating the xpath query

      • setXpathUsage

        public SearchParameter setXpathUsage​(ca.uhn.fhir.model.primitive.BoundCodeDt<XPathUsageTypeEnum> theValue)
        Sets the value(s) for xpathUsage ()

        Definition: How the search parameter relates to the set of elements returned by evaluating the xpath query

      • setXpathUsage

        public SearchParameter setXpathUsage​(XPathUsageTypeEnum theValue)
        Sets the value(s) for xpathUsage ()

        Definition: How the search parameter relates to the set of elements returned by evaluating the xpath query

      • getTarget

        public List<ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum>> getTarget()
        Gets the value(s) for target (). creating it if it does not exist. Will not return null.

        Definition: Types of resource (if a resource is referenced)

      • addTarget

        public ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnumaddTarget​(ResourceTypeEnum theValue)
        Add a value for target () using an enumerated type. This is intended as a convenience method for situations where the FHIR defined ValueSets are mandatory or contain the desirable codes. If you wish to use codes other than those which are built-in, you may also use the addTarget() method.

        Definition: Types of resource (if a resource is referenced)

      • getTargetFirstRep

        public ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnumgetTargetFirstRep()
        Gets the first repetition for target (), creating it if it does not already exist.

        Definition: Types of resource (if a resource is referenced)

      • addTarget

        public ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnumaddTarget()
        Add a value for target ()

        Definition: Types of resource (if a resource is referenced)

      • setTarget

        public SearchParameter setTarget​(ResourceTypeEnum theValue)
        Sets the value(s), and clears any existing value(s) for target ()

        Definition: Types of resource (if a resource is referenced)

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource