SearchParameter (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 3.7.0 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.SearchParameter

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class SearchParameter
extends BaseResource
implements 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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SearchParameter.Contact
Block class for child element: SearchParameter.contact ()

Nested Classes
Modifier and Type	Class and Description
`static class`	`SearchParameter.Contact` Block class for child element: SearchParameter.contact ()

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`BASE` Fluent Client search parameter constant for base
`static TokenClientParam`	`CODE` Fluent Client search parameter constant for code
`static StringClientParam`	`DESCRIPTION` Fluent Client search parameter constant for description
`static StringClientParam`	`NAME` Fluent Client search parameter constant for name
`static String`	`SP_BASE` Search parameter constant for base
`static String`	`SP_CODE` Search parameter constant for code
`static String`	`SP_DESCRIPTION` Search parameter constant for description
`static String`	`SP_NAME` Search parameter constant for name
`static String`	`SP_TARGET` Search parameter constant for target
`static String`	`SP_TYPE` Search parameter constant for type
`static String`	`SP_URL` Search parameter constant for url
`static TokenClientParam`	`TARGET` Fluent Client search parameter constant for target
`static TokenClientParam`	`TYPE` Fluent Client search parameter constant for type
`static UriClientParam`	`URL` Fluent Client search parameter constant for url

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

SearchParameter()

Constructors
Constructor and Description
`SearchParameter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SearchParameter.Contact`	`addContact()` Adds and returns a new value for contact ()
`SearchParameter`	`addContact(SearchParameter.Contact theValue)` Adds a given new value for contact ()
`BoundCodeDt<ResourceTypeEnum>`	`addTarget()` Add a value for target ()
`BoundCodeDt<ResourceTypeEnum>`	`addTarget(ResourceTypeEnum theValue)` Add a value for target () using an enumerated type.
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`String`	`getBase()` Gets the value(s) for base ().
`BoundCodeDt<ResourceTypeEnum>`	`getBaseElement()` Gets the value(s) for base ().
`String`	`getCode()` Gets the value(s) for code ().
`CodeDt`	`getCodeElement()` Gets the value(s) for code ().
`List<SearchParameter.Contact>`	`getContact()` Gets the value(s) for contact ().
`SearchParameter.Contact`	`getContactFirstRep()` Gets the first repetition for contact (), creating it if it does not already exist.
`Date`	`getDate()` Gets the value(s) for date (when.recorded).
`DateTimeDt`	`getDateElement()` Gets the value(s) for date (when.recorded).
`String`	`getDescription()` Gets the value(s) for description ().
`StringDt`	`getDescriptionElement()` Gets the value(s) for description ().
`Boolean`	`getExperimental()` Gets the value(s) for experimental (class).
`BooleanDt`	`getExperimentalElement()` Gets the value(s) for experimental (class).
`String`	`getName()` Gets the value(s) for name ().
`StringDt`	`getNameElement()` Gets the value(s) for name ().
`String`	`getPublisher()` Gets the value(s) for publisher (who.witness).
`StringDt`	`getPublisherElement()` Gets the value(s) for publisher (who.witness).
`String`	`getRequirements()` Gets the value(s) for requirements (why).
`StringDt`	`getRequirementsElement()` Gets the value(s) for requirements (why).
`String`	`getResourceName()`
`String`	`getStatus()` Gets the value(s) for status (status).
`BoundCodeDt<ConformanceResourceStatusEnum>`	`getStatusElement()` Gets the value(s) for status (status).
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`List<BoundCodeDt<ResourceTypeEnum>>`	`getTarget()` Gets the value(s) for target ().
`BoundCodeDt<ResourceTypeEnum>`	`getTargetFirstRep()` Gets the first repetition for target (), creating it if it does not already exist.
`String`	`getType()` Gets the value(s) for type ().
`BoundCodeDt<SearchParamTypeEnum>`	`getTypeElement()` Gets the value(s) for type ().
`String`	`getUrl()` Gets the value(s) for url (id).
`UriDt`	`getUrlElement()` Gets the value(s) for url (id).
`String`	`getXpath()` Gets the value(s) for xpath ().
`StringDt`	`getXpathElement()` Gets the value(s) for xpath ().
`String`	`getXpathUsage()` Gets the value(s) for xpathUsage ().
`BoundCodeDt<XPathUsageTypeEnum>`	`getXpathUsageElement()` Gets the value(s) for xpathUsage ().
`boolean`	`isEmpty()`
`SearchParameter`	`setBase(BoundCodeDt<ResourceTypeEnum> theValue)` Sets the value(s) for base ()
`SearchParameter`	`setBase(ResourceTypeEnum theValue)` Sets the value(s) for base ()
`SearchParameter`	`setCode(CodeDt theValue)` Sets the value(s) for code ()
`SearchParameter`	`setCode(String theCode)` Sets the value for code ()
`SearchParameter`	`setContact(List<SearchParameter.Contact> theValue)` Sets the value(s) for contact ()
`SearchParameter`	`setDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for date (when.recorded)
`SearchParameter`	`setDate(DateTimeDt theValue)` Sets the value(s) for date (when.recorded)
`SearchParameter`	`setDateWithSecondsPrecision(Date theDate)` Sets the value for date (when.recorded)
`SearchParameter`	`setDescription(String theString)` Sets the value for description ()
`SearchParameter`	`setDescription(StringDt theValue)` Sets the value(s) for description ()
`SearchParameter`	`setExperimental(boolean theBoolean)` Sets the value for experimental (class)
`SearchParameter`	`setExperimental(BooleanDt theValue)` Sets the value(s) for experimental (class)
`SearchParameter`	`setName(String theString)` Sets the value for name ()
`SearchParameter`	`setName(StringDt theValue)` Sets the value(s) for name ()
`SearchParameter`	`setPublisher(String theString)` Sets the value for publisher (who.witness)
`SearchParameter`	`setPublisher(StringDt theValue)` Sets the value(s) for publisher (who.witness)
`SearchParameter`	`setRequirements(String theString)` Sets the value for requirements (why)
`SearchParameter`	`setRequirements(StringDt theValue)` Sets the value(s) for requirements (why)
`SearchParameter`	`setStatus(BoundCodeDt<ConformanceResourceStatusEnum> theValue)` Sets the value(s) for status (status)
`SearchParameter`	`setStatus(ConformanceResourceStatusEnum theValue)` Sets the value(s) for status (status)
`SearchParameter`	`setTarget(List<BoundCodeDt<ResourceTypeEnum>> theValue)` Sets the value(s) for target ()
`SearchParameter`	`setTarget(ResourceTypeEnum theValue)` Sets the value(s), and clears any existing value(s) for target ()
`SearchParameter`	`setType(BoundCodeDt<SearchParamTypeEnum> theValue)` Sets the value(s) for type ()
`SearchParameter`	`setType(SearchParamTypeEnum theValue)` Sets the value(s) for type ()
`SearchParameter`	`setUrl(String theUri)` Sets the value for url (id)
`SearchParameter`	`setUrl(UriDt theValue)` Sets the value(s) for url (id)
`SearchParameter`	`setXpath(String theString)` Sets the value for xpath ()
`SearchParameter`	`setXpath(StringDt theValue)` Sets the value(s) for xpath ()
`SearchParameter`	`setXpathUsage(BoundCodeDt<XPathUsageTypeEnum> theValue)` Sets the value(s) for xpathUsage ()
`SearchParameter`	`setXpathUsage(XPathUsageTypeEnum theValue)` Sets the value(s) for xpathUsage ()

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getMeta, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, hasFormatComment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getMeta, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId

- Field Detail
  - SP_URL
```
public static final String SP_URL
```
    Search parameter constant for url
    Description:
    Type: uri
    Path: SearchParameter.url
    
    See Also:
    
    Constant Field Values
  - URL
```
public static final UriClientParam URL
```
    Fluent Client search parameter constant for url
    Description:
    Type: uri
    Path: SearchParameter.url
  - SP_NAME
```
public static final String SP_NAME
```
    Search parameter constant for name
    Description:
    Type: string
    Path: SearchParameter.name
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final StringClientParam NAME
```
    Fluent Client search parameter constant for name
    Description:
    Type: string
    Path: SearchParameter.name
  - SP_BASE
```
public static final String SP_BASE
```
    Search parameter constant for base
    Description:
    Type: token
    Path: SearchParameter.base
    
    See Also:
    
    Constant Field Values
  - BASE
```
public static final TokenClientParam BASE
```
    Fluent Client search parameter constant for base
    Description:
    Type: token
    Path: SearchParameter.base
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter constant for type
    Description:
    Type: token
    Path: SearchParameter.type
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final TokenClientParam TYPE
```
    Fluent Client search parameter constant for type
    Description:
    Type: token
    Path: SearchParameter.type
  - SP_DESCRIPTION
```
public static final String SP_DESCRIPTION
```
    Search parameter constant for description
    Description:
    Type: string
    Path: SearchParameter.description
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
public static final StringClientParam DESCRIPTION
```
    Fluent Client search parameter constant for description
    Description:
    Type: string
    Path: SearchParameter.description
  - SP_TARGET
```
public static final String SP_TARGET
```
    Search parameter constant for target
    Description:
    Type: token
    Path: SearchParameter.target
    
    See Also:
    
    Constant Field Values
  - TARGET
```
public static final TokenClientParam TARGET
```
    Fluent Client search parameter constant for target
    Description:
    Type: token
    Path: SearchParameter.target
  - SP_CODE
```
public static final String SP_CODE
```
    Search parameter constant for code
    Description:
    Type: token
    Path: SearchParameter.code
    
    See Also:
    
    Constant Field Values
  - CODE
```
public static final TokenClientParam CODE
```
    Fluent Client search parameter constant for code
    Description:
    Type: token
    Path: SearchParameter.code
- Constructor Detail
  - SearchParameter
```
public SearchParameter()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getUrlElement
```
public 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(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 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(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 BoundCodeDt<ConformanceResourceStatusEnum> getStatusElement()
```
    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
  - setStatus
```
public SearchParameter setStatus(BoundCodeDt<ConformanceResourceStatusEnum> theValue)
```
    Sets the value(s) for status (status)
    Definition: The status of this search parameter definition
  - setStatus
```
public SearchParameter setStatus(ConformanceResourceStatusEnum theValue)
```
    Sets the value(s) for status (status)
    Definition: The status of this search parameter definition
  - getExperimentalElement
```
public 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(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 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(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.Contact> getContact()
```
    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
  - setContact
```
public SearchParameter setContact(List<SearchParameter.Contact> theValue)
```
    Sets the value(s) for contact ()
    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 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(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
  - 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
  - setDate
```
public SearchParameter setDate(Date theDate,
                               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
  - getRequirementsElement
```
public 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(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 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(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 BoundCodeDt<ResourceTypeEnum> getBaseElement()
```
    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(BoundCodeDt<ResourceTypeEnum> theValue)
```
    Sets the value(s) for base ()
    Definition: The base resource type that this search parameter refers to
  - setBase
```
public SearchParameter setBase(ResourceTypeEnum theValue)
```
    Sets the value(s) for base ()
    Definition: The base resource type that this search parameter refers to
  - getTypeElement
```
public BoundCodeDt<SearchParamTypeEnum> getTypeElement()
```
    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(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
  - setType
```
public SearchParameter setType(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 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(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 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(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 BoundCodeDt<XPathUsageTypeEnum> getXpathUsageElement()
```
    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(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<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)
  - setTarget
```
public SearchParameter setTarget(List<BoundCodeDt<ResourceTypeEnum>> theValue)
```
    Sets the value(s) for target ()
    Definition: Types of resource (if a resource is referenced)
  - addTarget
```
public BoundCodeDt<ResourceTypeEnum> addTarget(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 BoundCodeDt<ResourceTypeEnum> getTargetFirstRep()
```
    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 BoundCodeDt<ResourceTypeEnum> addTarget()
```
    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 IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class SearchParameter

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Field Detail

SP_URL

URL

SP_NAME

NAME

SP_BASE

BASE

SP_TYPE

TYPE

SP_DESCRIPTION

DESCRIPTION

SP_TARGET

TARGET

SP_CODE

CODE

Constructor Detail

SearchParameter

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getUrlElement

getUrl

setUrl

setUrl

getNameElement

getName

setName

setName

getStatusElement

getStatus

setStatus

setStatus

getExperimentalElement

getExperimental

setExperimental

setExperimental

getPublisherElement

getPublisher

setPublisher

setPublisher

getContact

setContact

addContact

addContact

getContactFirstRep

getDateElement

getDate

setDate

setDateWithSecondsPrecision

setDate

getRequirementsElement

getRequirements

setRequirements

setRequirements

getCodeElement

getCode

setCode

setCode

getBaseElement

getBase

setBase

setBase

getTypeElement

getType

setType

setType

getDescriptionElement

getDescription