Package org.hl7.fhir

Class SearchParameter

java.lang.Object

org.hl7.fhir.Resource

org.hl7.fhir.DomainResource

org.hl7.fhir.SearchParameter

All Implemented Interfaces:

org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2

public class SearchParameter
extends DomainResource
implements org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2

If the element is present, it must have either a @value, an @id, or extensions

Java class for SearchParameter complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="SearchParameter">
   <complexContent>
     <extension base="{http://hl7.org/fhir}DomainResource">
       <sequence>
         <element name="url" type="{http://hl7.org/fhir}uri"/>
         <element name="name" type="{http://hl7.org/fhir}string"/>
         <element name="status" type="{http://hl7.org/fhir}ConformanceResourceStatus" minOccurs="0"/>
         <element name="experimental" type="{http://hl7.org/fhir}boolean" minOccurs="0"/>
         <element name="date" type="{http://hl7.org/fhir}dateTime" minOccurs="0"/>
         <element name="publisher" type="{http://hl7.org/fhir}string" minOccurs="0"/>
         <element name="contact" type="{http://hl7.org/fhir}SearchParameter.Contact" maxOccurs="unbounded" minOccurs="0"/>
         <element name="useContext" type="{http://hl7.org/fhir}CodeableConcept" maxOccurs="unbounded" minOccurs="0"/>
         <element name="requirements" type="{http://hl7.org/fhir}string" minOccurs="0"/>
         <element name="code" type="{http://hl7.org/fhir}code"/>
         <element name="base" type="{http://hl7.org/fhir}code"/>
         <element name="type" type="{http://hl7.org/fhir}SearchParamType"/>
         <element name="description" type="{http://hl7.org/fhir}string"/>
         <element name="expression" type="{http://hl7.org/fhir}string" minOccurs="0"/>
         <element name="xpath" type="{http://hl7.org/fhir}string" minOccurs="0"/>
         <element name="xpathUsage" type="{http://hl7.org/fhir}XPathUsageType" minOccurs="0"/>
         <element name="target" type="{http://hl7.org/fhir}code" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected Code	base
protected Code	code
protected List<SearchParameterContact>	contact
protected DateTime	date
protected String	description
protected Boolean	experimental
protected String	expression
protected String	name
protected String	publisher
protected String	requirements
protected ConformanceResourceStatus	status
protected List<Code>	target
protected SearchParamType	type
protected Uri	url
protected List<CodeableConcept>	useContext
protected String	xpath
protected XPathUsageType	xpathUsage

Fields inherited from class org.hl7.fhir.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.Resource

id, implicitRules, language, meta

Constructor Summary

Constructors

Constructor	Description
SearchParameter()

Method Summary

Modifier and Type	Method	Description
StringBuilder	append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
StringBuilder	appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
boolean	equals(Object object)
boolean	equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)
Code	getBase()	Gets the value of the base property.
Code	getCode()	Gets the value of the code property.
List<SearchParameterContact>	getContact()	Gets the value of the contact property.
DateTime	getDate()	Gets the value of the date property.
String	getDescription()	Gets the value of the description property.
Boolean	getExperimental()	Gets the value of the experimental property.
String	getExpression()	Gets the value of the expression property.
String	getName()	Gets the value of the name property.
String	getPublisher()	Gets the value of the publisher property.
String	getRequirements()	Gets the value of the requirements property.
ConformanceResourceStatus	getStatus()	Gets the value of the status property.
List<Code>	getTarget()	Gets the value of the target property.
SearchParamType	getType()	Gets the value of the type property.
Uri	getUrl()	Gets the value of the url property.
List<CodeableConcept>	getUseContext()	Gets the value of the useContext property.
String	getXpath()	Gets the value of the xpath property.
XPathUsageType	getXpathUsage()	Gets the value of the xpathUsage property.
int	hashCode()
int	hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)
void	setBase(Code value)	Sets the value of the base property.
void	setCode(Code value)	Sets the value of the code property.
void	setContact(List<SearchParameterContact> value)
void	setDate(DateTime value)	Sets the value of the date property.
void	setDescription(String value)	Sets the value of the description property.
void	setExperimental(Boolean value)	Sets the value of the experimental property.
void	setExpression(String value)	Sets the value of the expression property.
void	setName(String value)	Sets the value of the name property.
void	setPublisher(String value)	Sets the value of the publisher property.
void	setRequirements(String value)	Sets the value of the requirements property.
void	setStatus(ConformanceResourceStatus value)	Sets the value of the status property.
void	setTarget(List<Code> value)
void	setType(SearchParamType value)	Sets the value of the type property.
void	setUrl(Uri value)	Sets the value of the url property.
void	setUseContext(List<CodeableConcept> value)
void	setXpath(String value)	Sets the value of the xpath property.
void	setXpathUsage(XPathUsageType value)	Sets the value of the xpathUsage property.
String	toString()
SearchParameter	withBase(Code value)
SearchParameter	withCode(Code value)
SearchParameter	withContact(Collection<SearchParameterContact> values)
SearchParameter	withContact(SearchParameterContact... values)
SearchParameter	withContained(Collection<ResourceContainer> values)
SearchParameter	withContained(ResourceContainer... values)
SearchParameter	withDate(DateTime value)
SearchParameter	withDescription(String value)
SearchParameter	withExperimental(Boolean value)
SearchParameter	withExpression(String value)
SearchParameter	withExtension(Collection<Extension> values)
SearchParameter	withExtension(Extension... values)
SearchParameter	withId(Id value)
SearchParameter	withImplicitRules(Uri value)
SearchParameter	withLanguage(Code value)
SearchParameter	withMeta(Meta value)
SearchParameter	withModifierExtension(Collection<Extension> values)
SearchParameter	withModifierExtension(Extension... values)
SearchParameter	withName(String value)
SearchParameter	withPublisher(String value)
SearchParameter	withRequirements(String value)
SearchParameter	withStatus(ConformanceResourceStatus value)
SearchParameter	withTarget(Collection<Code> values)
SearchParameter	withTarget(Code... values)
SearchParameter	withText(Narrative value)
SearchParameter	withType(SearchParamType value)
SearchParameter	withUrl(Uri value)
SearchParameter	withUseContext(Collection<CodeableConcept> values)
SearchParameter	withUseContext(CodeableConcept... values)
SearchParameter	withXpath(String value)
SearchParameter	withXpathUsage(XPathUsageType value)

Methods inherited from class org.hl7.fhir.DomainResource

getContained, getExtension, getModifierExtension, getText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.Resource

getId, getImplicitRules, getLanguage, getMeta, setId, setImplicitRules, setLanguage, setMeta

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

url

protected Uri url

name

protected String name

status

protected ConformanceResourceStatus status

experimental

protected Boolean experimental

date

protected DateTime date

publisher

protected String publisher

contact

protected List<SearchParameterContact> contact

useContext

protected List<CodeableConcept> useContext

requirements

protected String requirements

code

protected Code code

base

protected Code base

type

protected SearchParamType type

description

protected String description

expression

protected String expression

xpath

protected String xpath

xpathUsage

protected XPathUsageType xpathUsage

target

protected List<Code> target

Constructor Details

SearchParameter

public SearchParameter()

Method Details

getUrl

public Uri getUrl()

Gets the value of the url property.

Returns:

possible object is Uri

setUrl

public void setUrl(Uri value)

Sets the value of the url property.

Parameters:

value - allowed object is Uri

getName

public String getName()

Gets the value of the name property.

Returns:

possible object is String

setName

public void setName(String value)

Sets the value of the name property.

Parameters:

value - allowed object is String

getStatus

public ConformanceResourceStatus getStatus()

Gets the value of the status property.

Returns:

possible object is ConformanceResourceStatus

setStatus

public void setStatus(ConformanceResourceStatus value)

Sets the value of the status property.

Parameters:

value - allowed object is ConformanceResourceStatus

getExperimental

public Boolean getExperimental()

Gets the value of the experimental property.

Returns:

possible object is Boolean

setExperimental

public void setExperimental(Boolean value)

Sets the value of the experimental property.

Parameters:

value - allowed object is Boolean

getDate

public DateTime getDate()

Gets the value of the date property.

Returns:

possible object is DateTime

setDate

public void setDate(DateTime value)

Sets the value of the date property.

Parameters:

value - allowed object is DateTime

getPublisher

public String getPublisher()

Gets the value of the publisher property.

Returns:

possible object is String

setPublisher

public void setPublisher(String value)

Sets the value of the publisher property.

Parameters:

value - allowed object is String

getContact

public List<SearchParameterContact> getContact()

Gets the value of the contact property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the contact property.

For example, to add a new item, do as follows:

    getContact().add(newItem);
 

Objects of the following type(s) are allowed in the list SearchParameterContact

getUseContext

public List<CodeableConcept> getUseContext()

Gets the value of the useContext property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the useContext property.

For example, to add a new item, do as follows:

    getUseContext().add(newItem);
 

Objects of the following type(s) are allowed in the list CodeableConcept

getRequirements

public String getRequirements()

Gets the value of the requirements property.

Returns:

possible object is String

setRequirements

public void setRequirements(String value)

Sets the value of the requirements property.

Parameters:

value - allowed object is String

getCode

public Code getCode()

Gets the value of the code property.

Returns:

possible object is Code

setCode

public void setCode(Code value)

Sets the value of the code property.

Parameters:

value - allowed object is Code

getBase

public Code getBase()

Gets the value of the base property.

Returns:

possible object is Code

setBase

public void setBase(Code value)

Sets the value of the base property.

Parameters:

value - allowed object is Code

getType

public SearchParamType getType()

Gets the value of the type property.

Returns:

possible object is SearchParamType

setType

public void setType(SearchParamType value)

Sets the value of the type property.

Parameters:

value - allowed object is SearchParamType

getDescription

public String getDescription()

Gets the value of the description property.

Returns:

possible object is String

setDescription

public void setDescription(String value)

Sets the value of the description property.

Parameters:

value - allowed object is String

getExpression

public String getExpression()

Gets the value of the expression property.

Returns:

possible object is String

setExpression

public void setExpression(String value)

Sets the value of the expression property.

Parameters:

value - allowed object is String

getXpath

public String getXpath()

Gets the value of the xpath property.

Returns:

possible object is String

setXpath

public void setXpath(String value)

Sets the value of the xpath property.

Parameters:

value - allowed object is String

getXpathUsage

public XPathUsageType getXpathUsage()

Gets the value of the xpathUsage property.

Returns:

possible object is XPathUsageType

setXpathUsage

public void setXpathUsage(XPathUsageType value)

Sets the value of the xpathUsage property.

Parameters:

value - allowed object is XPathUsageType

getTarget

public List<Code> getTarget()

Gets the value of the target property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the target property.

For example, to add a new item, do as follows:

    getTarget().add(newItem);
 

Objects of the following type(s) are allowed in the list Code

withUrl

public SearchParameter withUrl(Uri value)

withName

public SearchParameter withName(String value)

withStatus

public SearchParameter withStatus(ConformanceResourceStatus value)

withExperimental

public SearchParameter withExperimental(Boolean value)

withDate

public SearchParameter withDate(DateTime value)

withPublisher

public SearchParameter withPublisher(String value)

withContact

public SearchParameter withContact(SearchParameterContact... values)

withContact

public SearchParameter withContact(Collection<SearchParameterContact> values)

withUseContext

public SearchParameter withUseContext(CodeableConcept... values)

withUseContext

public SearchParameter withUseContext(Collection<CodeableConcept> values)

withRequirements

public SearchParameter withRequirements(String value)

withCode

public SearchParameter withCode(Code value)

withBase

public SearchParameter withBase(Code value)

withType

public SearchParameter withType(SearchParamType value)

withDescription

public SearchParameter withDescription(String value)

withExpression

public SearchParameter withExpression(String value)

withXpath

public SearchParameter withXpath(String value)

withXpathUsage

public SearchParameter withXpathUsage(XPathUsageType value)

withTarget

public SearchParameter withTarget(Code... values)

withTarget

public SearchParameter withTarget(Collection<Code> values)

withText

public SearchParameter withText(Narrative value)

Overrides:

withText in class DomainResource

withContained

public SearchParameter withContained(ResourceContainer... values)

Overrides:

withContained in class DomainResource

withContained

public SearchParameter withContained(Collection<ResourceContainer> values)

Overrides:

withContained in class DomainResource

withExtension

public SearchParameter withExtension(Extension... values)

Overrides:

withExtension in class DomainResource

withExtension

public SearchParameter withExtension(Collection<Extension> values)

Overrides:

withExtension in class DomainResource

withModifierExtension

public SearchParameter withModifierExtension(Extension... values)

Overrides:

withModifierExtension in class DomainResource

withModifierExtension

public SearchParameter withModifierExtension(Collection<Extension> values)

Overrides:

withModifierExtension in class DomainResource

withId

public SearchParameter withId(Id value)

Overrides:

withId in class DomainResource

withMeta

public SearchParameter withMeta(Meta value)

Overrides:

withMeta in class DomainResource

withImplicitRules

public SearchParameter withImplicitRules(Uri value)

Overrides:

withImplicitRules in class DomainResource

withLanguage

public SearchParameter withLanguage(Code value)

Overrides:

withLanguage in class DomainResource

equals

public boolean equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator,
 org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator,
 Object object,
 org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)

Specified by:

equals in interface org.jvnet.jaxb2_commons.lang.Equals2

Overrides:

equals in class DomainResource

equals

public boolean equals(Object object)

Overrides:

equals in class DomainResource

hashCode

public int hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
 org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)

Specified by:

hashCode in interface org.jvnet.jaxb2_commons.lang.HashCode2

Overrides:

hashCode in class DomainResource

hashCode

public int hashCode()

Overrides:

hashCode in class DomainResource

toString

public String toString()

Overrides:

toString in class DomainResource

append

public StringBuilder append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)

Specified by:

append in interface org.jvnet.jaxb2_commons.lang.ToString2

Overrides:

append in class DomainResource

appendFields

public StringBuilder appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)

Specified by:

appendFields in interface org.jvnet.jaxb2_commons.lang.ToString2

Overrides:

appendFields in class DomainResource

setContact

public void setContact(List<SearchParameterContact> value)

setUseContext

public void setUseContext(List<CodeableConcept> value)

setTarget

public void setTarget(List<Code> value)