Package org.hl7.fhir.r4.model

Class SearchParameter

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.model.MetadataResource

org.hl7.fhir.r4.model.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 MetadataResource

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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SearchParameter.SearchComparator
static class	SearchParameter.SearchComparatorEnumFactory
static enum	SearchParameter.SearchModifierCode
static class	SearchParameter.SearchModifierCodeEnumFactory
static class	SearchParameter.SearchParameterComponentComponent
static enum	SearchParameter.XPathUsageType
static class	SearchParameter.XPathUsageTypeEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected List<CodeType>	base	The base resource type(s) that this search parameter can be used against.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	BASE	Fluent Client search parameter constant for base
protected List<StringType>	chain	Contains the names of any search parameters which may be chained to the containing search parameter.
protected CodeType	code	The code used in the URL or the parameter name in a parameters resource for this search parameter.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CODE	Fluent Client search parameter constant for code
protected List<Enumeration<SearchParameter.SearchComparator>>	comparator	Comparators supported for the search parameter.
protected List<SearchParameter.SearchParameterComponentComponent>	component	Used to define the parts of a composite search parameter.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	COMPONENT	Fluent Client search parameter constant for component
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CONTEXT	Fluent Client search parameter constant for context
static final ca.uhn.fhir.rest.gclient.QuantityClientParam	CONTEXT_QUANTITY	Fluent Client search parameter constant for context-quantity
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CONTEXT_TYPE	Fluent Client search parameter constant for context-type
static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam>	CONTEXT_TYPE_QUANTITY	Fluent Client search parameter constant for context-type-quantity
static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>	CONTEXT_TYPE_VALUE	Fluent Client search parameter constant for context-type-value
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DERIVED_FROM	Fluent Client search parameter constant for derived-from
protected CanonicalType	derivedFrom	Where this search parameter is originally defined.
static final ca.uhn.fhir.rest.gclient.StringClientParam	DESCRIPTION	Fluent Client search parameter constant for description
protected StringType	expression	A FHIRPath expression that returns a set of elements for the search parameter.
static final ca.uhn.fhir.model.api.Include	INCLUDE_COMPONENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_DERIVED_FROM	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	JURISDICTION	Fluent Client search parameter constant for jurisdiction
protected List<Enumeration<SearchParameter.SearchModifierCode>>	modifier	A modifier supported for the search parameter.
protected BooleanType	multipleAnd	Whether multiple parameters are allowed - e.g.
protected BooleanType	multipleOr	Whether multiple values are allowed for each time the parameter exists.
static final ca.uhn.fhir.rest.gclient.StringClientParam	NAME	Fluent Client search parameter constant for name
static final ca.uhn.fhir.rest.gclient.StringClientParam	PUBLISHER	Fluent Client search parameter constant for publisher
protected MarkdownType	purpose	Explanation of why this search parameter is needed and why it has been designed as it has.
static final String	SP_BASE	Search parameter: base
static final String	SP_CODE	Search parameter: code
static final String	SP_COMPONENT	Search parameter: component
static final String	SP_CONTEXT	Search parameter: context
static final String	SP_CONTEXT_QUANTITY	Search parameter: context-quantity
static final String	SP_CONTEXT_TYPE	Search parameter: context-type
static final String	SP_CONTEXT_TYPE_QUANTITY	Search parameter: context-type-quantity
static final String	SP_CONTEXT_TYPE_VALUE	Search parameter: context-type-value
static final String	SP_DATE	Search parameter: date
static final String	SP_DERIVED_FROM	Search parameter: derived-from
static final String	SP_DESCRIPTION	Search parameter: description
static final String	SP_JURISDICTION	Search parameter: jurisdiction
static final String	SP_NAME	Search parameter: name
static final String	SP_PUBLISHER	Search parameter: publisher
static final String	SP_STATUS	Search parameter: status
static final String	SP_TARGET	Search parameter: target
static final String	SP_TYPE	Search parameter: type
static final String	SP_URL	Search parameter: url
static final String	SP_VERSION	Search parameter: version
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected List<CodeType>	target	Types of resource (if a resource is referenced).
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TARGET	Fluent Client search parameter constant for target
protected Enumeration<Enumerations.SearchParamType>	type	The type of value that a search parameter may contain, and how the content is interpreted.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TYPE	Fluent Client search parameter constant for type
static final ca.uhn.fhir.rest.gclient.UriClientParam	URL	Fluent Client search parameter constant for url
static final ca.uhn.fhir.rest.gclient.TokenClientParam	VERSION	Fluent Client search parameter constant for version
protected StringType	xpath	An XPath expression that returns a set of elements for the search parameter.
protected Enumeration<SearchParameter.XPathUsageType>	xpathUsage	How the search parameter relates to the set of elements returned by evaluating the xpath query.

Fields inherited from class org.hl7.fhir.r4.model.MetadataResource

contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version

Fields inherited from class org.hl7.fhir.r4.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.model.Resource

id, implicitRules, language, meta

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

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
SearchParameter()	Constructor
SearchParameter(UriType url, StringType name, Enumeration<Enumerations.PublicationStatus> status, MarkdownType description, CodeType code, Enumeration<Enumerations.SearchParamType> type)	Constructor

Method Summary

Modifier and Type	Method	Description
SearchParameter	addBase(String value)
CodeType	addBaseElement()
SearchParameter	addChain(String value)
StringType	addChainElement()
Base	addChild(String name)
SearchParameter	addComparator(SearchParameter.SearchComparator value)
Enumeration<SearchParameter.SearchComparator>	addComparatorElement()
SearchParameter.SearchParameterComponentComponent	addComponent()
SearchParameter	addComponent(SearchParameter.SearchParameterComponentComponent t)
ContactDetail	addContact()
SearchParameter	addContact(ContactDetail t)
CodeableConcept	addJurisdiction()
SearchParameter	addJurisdiction(CodeableConcept t)
SearchParameter	addModifier(SearchParameter.SearchModifierCode value)
Enumeration<SearchParameter.SearchModifierCode>	addModifierElement()
SearchParameter	addTarget(String value)
CodeType	addTargetElement()
UsageContext	addUseContext()
SearchParameter	addUseContext(UsageContext t)
SearchParameter	copy()
void	copyValues(SearchParameter dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<CodeType>	getBase()
List<StringType>	getChain()
String	getCode()
CodeType	getCodeElement()
List<Enumeration<SearchParameter.SearchComparator>>	getComparator()
List<SearchParameter.SearchParameterComponentComponent>	getComponent()
SearchParameter.SearchParameterComponentComponent	getComponentFirstRep()
List<ContactDetail>	getContact()
ContactDetail	getContactFirstRep()
Date	getDate()
DateTimeType	getDateElement()
String	getDerivedFrom()
CanonicalType	getDerivedFromElement()
String	getDescription()
MarkdownType	getDescriptionElement()
boolean	getExperimental()
BooleanType	getExperimentalElement()
String	getExpression()
StringType	getExpressionElement()
List<CodeableConcept>	getJurisdiction()
CodeableConcept	getJurisdictionFirstRep()
List<Enumeration<SearchParameter.SearchModifierCode>>	getModifier()
boolean	getMultipleAnd()
BooleanType	getMultipleAndElement()
boolean	getMultipleOr()
BooleanType	getMultipleOrElement()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getPublisher()
StringType	getPublisherElement()
String	getPurpose()
MarkdownType	getPurposeElement()
ResourceType	getResourceType()
Enumerations.PublicationStatus	getStatus()
Enumeration<Enumerations.PublicationStatus>	getStatusElement()
List<CodeType>	getTarget()
Enumerations.SearchParamType	getType()
Enumeration<Enumerations.SearchParamType>	getTypeElement()
String[]	getTypesForProperty(int hash, String name)
String	getUrl()
UriType	getUrlElement()
List<UsageContext>	getUseContext()
UsageContext	getUseContextFirstRep()
String	getVersion()
StringType	getVersionElement()
String	getXpath()
StringType	getXpathElement()
SearchParameter.XPathUsageType	getXpathUsage()
Enumeration<SearchParameter.XPathUsageType>	getXpathUsageElement()
boolean	hasBase()
boolean	hasBase(String value)
boolean	hasChain()
boolean	hasChain(String value)
boolean	hasCode()
boolean	hasCodeElement()
boolean	hasComparator()
boolean	hasComparator(SearchParameter.SearchComparator value)
boolean	hasComponent()
boolean	hasContact()
boolean	hasDate()
boolean	hasDateElement()
boolean	hasDerivedFrom()
boolean	hasDerivedFromElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasExperimental()
boolean	hasExperimentalElement()
boolean	hasExpression()
boolean	hasExpressionElement()
boolean	hasJurisdiction()
boolean	hasModifier()
boolean	hasModifier(SearchParameter.SearchModifierCode value)
boolean	hasMultipleAnd()
boolean	hasMultipleAndElement()
boolean	hasMultipleOr()
boolean	hasMultipleOrElement()
boolean	hasName()
boolean	hasNameElement()
boolean	hasPublisher()
boolean	hasPublisherElement()
boolean	hasPurpose()
boolean	hasPurposeElement()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasTarget()
boolean	hasTarget(String value)
boolean	hasType()
boolean	hasTypeElement()
boolean	hasUrl()
boolean	hasUrlElement()
boolean	hasUseContext()
boolean	hasVersion()
boolean	hasVersionElement()
boolean	hasXpath()
boolean	hasXpathElement()
boolean	hasXpathUsage()
boolean	hasXpathUsageElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
SearchParameter	setBase(List<CodeType> theBase)
SearchParameter	setChain(List<StringType> theChain)
SearchParameter	setCode(String value)
SearchParameter	setCodeElement(CodeType value)
SearchParameter	setComparator(List<Enumeration<SearchParameter.SearchComparator>> theComparator)
SearchParameter	setComponent(List<SearchParameter.SearchParameterComponentComponent> theComponent)
SearchParameter	setContact(List<ContactDetail> theContact)
SearchParameter	setDate(Date value)
SearchParameter	setDateElement(DateTimeType value)
SearchParameter	setDerivedFrom(String value)
SearchParameter	setDerivedFromElement(CanonicalType value)
SearchParameter	setDescription(String value)
SearchParameter	setDescriptionElement(MarkdownType value)
SearchParameter	setExperimental(boolean value)
SearchParameter	setExperimentalElement(BooleanType value)
SearchParameter	setExpression(String value)
SearchParameter	setExpressionElement(StringType value)
SearchParameter	setJurisdiction(List<CodeableConcept> theJurisdiction)
SearchParameter	setModifier(List<Enumeration<SearchParameter.SearchModifierCode>> theModifier)
SearchParameter	setMultipleAnd(boolean value)
SearchParameter	setMultipleAndElement(BooleanType value)
SearchParameter	setMultipleOr(boolean value)
SearchParameter	setMultipleOrElement(BooleanType value)
SearchParameter	setName(String value)
SearchParameter	setNameElement(StringType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
SearchParameter	setPublisher(String value)
SearchParameter	setPublisherElement(StringType value)
SearchParameter	setPurpose(String value)
SearchParameter	setPurposeElement(MarkdownType value)
SearchParameter	setStatus(Enumerations.PublicationStatus value)
SearchParameter	setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
SearchParameter	setTarget(List<CodeType> theTarget)
SearchParameter	setType(Enumerations.SearchParamType value)
SearchParameter	setTypeElement(Enumeration<Enumerations.SearchParamType> value)
SearchParameter	setUrl(String value)
SearchParameter	setUrlElement(UriType value)
SearchParameter	setUseContext(List<UsageContext> theUseContext)
SearchParameter	setVersion(String value)
SearchParameter	setVersionElement(StringType value)
SearchParameter	setXpath(String value)
SearchParameter	setXpathElement(StringType value)
SearchParameter	setXpathUsage(SearchParameter.XPathUsageType value)
SearchParameter	setXpathUsageElement(Enumeration<SearchParameter.XPathUsageType> value)
protected SearchParameter	typedCopy()

Methods inherited from class org.hl7.fhir.r4.model.MetadataResource

copyValues, getTitle, getTitleElement, hasTitle, hasTitleElement, present, setTitle, setTitleElement, toString

Methods inherited from class org.hl7.fhir.r4.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r4.model.Resource

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r4.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

derivedFrom

protected CanonicalType derivedFrom

Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. i.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.

purpose

protected MarkdownType purpose

Explanation of why this search parameter is needed and why it has been designed as it has.

code

protected CodeType code

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

base

protected List<CodeType> base

The base resource type(s) that this search parameter can be used against.

type

protected Enumeration<Enumerations.SearchParamType> type

The type of value that a search parameter may contain, and how the content is interpreted.

expression

protected StringType expression

A FHIRPath 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.

xpathUsage

protected Enumeration<SearchParameter.XPathUsageType> xpathUsage

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

target

protected List<CodeType> target

Types of resource (if a resource is referenced).

multipleOr

protected BooleanType multipleOr

Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.

multipleAnd

protected BooleanType multipleAnd

Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.

comparator

protected List<Enumeration<SearchParameter.SearchComparator>> comparator

Comparators supported for the search parameter.

modifier

protected List<Enumeration<SearchParameter.SearchModifierCode>> modifier

A modifier supported for the search parameter.

chain

protected List<StringType> chain

Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.

component

protected List<SearchParameter.SearchParameterComponentComponent> component

Used to define the parts of a composite search parameter.

SP_DATE

public static final String SP_DATE

Search parameter: date

Description: The search parameter publication date
Type: date
Path: SearchParameter.date

See Also:

• Constant Field Values

DATE

public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE

Fluent Client search parameter constant for date

Description: The search parameter publication date
Type: date
Path: SearchParameter.date

SP_CODE

public static final String SP_CODE

Search parameter: code

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

See Also:

• Constant Field Values

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_CONTEXT_TYPE_VALUE

public static final String SP_CONTEXT_TYPE_VALUE

Search parameter: context-type-value

Description: A use context type and value assigned to the search parameter
Type: composite
Path:

See Also:

• Constant Field Values

CONTEXT_TYPE_VALUE

public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE

Fluent Client search parameter constant for context-type-value

Description: A use context type and value assigned to the search parameter
Type: composite
Path:

SP_JURISDICTION

public static final String SP_JURISDICTION

Search parameter: jurisdiction

Description: Intended jurisdiction for the search parameter
Type: token
Path: SearchParameter.jurisdiction

See Also:

• Constant Field Values

JURISDICTION

public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION

Fluent Client search parameter constant for jurisdiction

Description: Intended jurisdiction for the search parameter
Type: token
Path: SearchParameter.jurisdiction

SP_DESCRIPTION

public static final String SP_DESCRIPTION

Search parameter: description

Description: The description of the 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: The description of the search parameter
Type: string
Path: SearchParameter.description

SP_DERIVED_FROM

public static final String SP_DERIVED_FROM

Search parameter: derived-from

Description: Original definition for the search parameter
Type: reference
Path: SearchParameter.derivedFrom

See Also:

• Constant Field Values

DERIVED_FROM

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DERIVED_FROM

Fluent Client search parameter constant for derived-from

Description: Original definition for the search parameter
Type: reference
Path: SearchParameter.derivedFrom

INCLUDE_DERIVED_FROM

public static final ca.uhn.fhir.model.api.Include INCLUDE_DERIVED_FROM

Constant for fluent queries to be used to add include statements. Specifies the path value of "SearchParameter:derived-from".

SP_CONTEXT_TYPE

public static final String SP_CONTEXT_TYPE

Search parameter: context-type

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

See Also:

• Constant Field Values

CONTEXT_TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE

Fluent Client search parameter constant for context-type

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

SP_TYPE

public static final String SP_TYPE

Search parameter: type

Description: number | date | string | token | reference | composite | quantity | uri | special
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 | special
Type: token
Path: SearchParameter.type

SP_VERSION

public static final String SP_VERSION

Search parameter: version

Description: The business version of the search parameter
Type: token
Path: SearchParameter.version

See Also:

• Constant Field Values

VERSION

public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION

Fluent Client search parameter constant for version

Description: The business version of the search parameter
Type: token
Path: SearchParameter.version

SP_URL

public static final String SP_URL

Search parameter: url

Description: The uri that identifies the 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: The uri that identifies the search parameter
Type: uri
Path: SearchParameter.url

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_CONTEXT_QUANTITY

public static final String SP_CONTEXT_QUANTITY

Search parameter: context-quantity

Description: A quantity- or range-valued use context assigned to the search parameter
Type: quantity
Path: SearchParameter.useContext.valueQuantity, SearchParameter.useContext.valueRange

See Also:

• Constant Field Values

CONTEXT_QUANTITY

public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY

Fluent Client search parameter constant for context-quantity

Description: A quantity- or range-valued use context assigned to the search parameter
Type: quantity
Path: SearchParameter.useContext.valueQuantity, SearchParameter.useContext.valueRange

SP_COMPONENT

public static final String SP_COMPONENT

Search parameter: component

Description: Defines how the part works
Type: reference
Path: SearchParameter.component.definition

See Also:

• Constant Field Values

COMPONENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam COMPONENT

Fluent Client search parameter constant for component

Description: Defines how the part works
Type: reference
Path: SearchParameter.component.definition

INCLUDE_COMPONENT

public static final ca.uhn.fhir.model.api.Include INCLUDE_COMPONENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "SearchParameter:component".

SP_NAME

public static final String SP_NAME

Search parameter: name

Description: Computationally friendly name of the 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: Computationally friendly name of the 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.valueCodeableConcept

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.valueCodeableConcept

SP_PUBLISHER

public static final String SP_PUBLISHER

Search parameter: publisher

Description: Name of the publisher of the search parameter
Type: string
Path: SearchParameter.publisher

See Also:

• Constant Field Values

PUBLISHER

public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER

Fluent Client search parameter constant for publisher

Description: Name of the publisher of the search parameter
Type: string
Path: SearchParameter.publisher

SP_CONTEXT_TYPE_QUANTITY

public static final String SP_CONTEXT_TYPE_QUANTITY

Search parameter: context-type-quantity

Description: A use context type and quantity- or range-based value assigned to the search parameter
Type: composite
Path:

See Also:

• Constant Field Values

CONTEXT_TYPE_QUANTITY

public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY

Fluent Client search parameter constant for context-type-quantity

Description: A use context type and quantity- or range-based value assigned to the search parameter
Type: composite
Path:

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The current status of the search parameter
Type: token
Path: SearchParameter.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: The current status of the search parameter
Type: token
Path: SearchParameter.status

SP_BASE

public static final String SP_BASE

Search parameter: base

Description: The resource type(s) 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(s) this search parameter applies to
Type: token
Path: SearchParameter.base

Constructor Details

SearchParameter

public SearchParameter()

Constructor

SearchParameter

public SearchParameter(UriType url,
 StringType name,
 Enumeration<Enumerations.PublicationStatus> status,
 MarkdownType description,
 CodeType code,
 Enumeration<Enumerations.SearchParamType> type)

Constructor

Method Details

getUrlElement

public UriType getUrlElement()

Overrides:

getUrlElement in class MetadataResource

Returns:

MetadataResource.url (An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

hasUrlElement

public boolean hasUrlElement()

Overrides:

hasUrlElement in class MetadataResource

hasUrl

public boolean hasUrl()

Overrides:

hasUrl in class MetadataResource

setUrlElement

public SearchParameter setUrlElement(UriType value)

Overrides:

setUrlElement in class MetadataResource

Parameters:

value - MetadataResource.url (An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

getUrl

public String getUrl()

Overrides:

getUrl in class MetadataResource

Returns:

An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers.

setUrl

public SearchParameter setUrl(String value)

Overrides:

setUrl in class MetadataResource

Parameters:

value - An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers.

getVersionElement

public StringType getVersionElement()

Overrides:

getVersionElement in class MetadataResource

Returns:

MetadataResource.version (The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

hasVersionElement

public boolean hasVersionElement()

Overrides:

hasVersionElement in class MetadataResource

hasVersion

public boolean hasVersion()

Overrides:

hasVersion in class MetadataResource

setVersionElement

public SearchParameter setVersionElement(StringType value)

Overrides:

setVersionElement in class MetadataResource

Parameters:

value - MetadataResource.version (The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

getVersion

public String getVersion()

Overrides:

getVersion in class MetadataResource

Returns:

The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

setVersion

public SearchParameter setVersion(String value)

Overrides:

setVersion in class MetadataResource

Parameters:

value - The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

getNameElement

public StringType getNameElement()

Overrides:

getNameElement in class MetadataResource

Returns:

MetadataResource.name (A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

hasNameElement

public boolean hasNameElement()

Overrides:

hasNameElement in class MetadataResource

hasName

public boolean hasName()

Overrides:

hasName in class MetadataResource

setNameElement

public SearchParameter setNameElement(StringType value)

Overrides:

setNameElement in class MetadataResource

Parameters:

value - MetadataResource.name (A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

getName

public String getName()

Overrides:

getName in class MetadataResource

Returns:

A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.

setName

public SearchParameter setName(String value)

Overrides:

setName in class MetadataResource

Parameters:

value - A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.

getDerivedFromElement

public CanonicalType getDerivedFromElement()

Returns:

derivedFrom (Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. i.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.). This is the underlying object with id, value and extensions. The accessor "getDerivedFrom" gives direct access to the value

hasDerivedFromElement

public boolean hasDerivedFromElement()

hasDerivedFrom

public boolean hasDerivedFrom()

setDerivedFromElement

public SearchParameter setDerivedFromElement(CanonicalType value)

Parameters:

value - derivedFrom (Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. i.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.). This is the underlying object with id, value and extensions. The accessor "getDerivedFrom" gives direct access to the value

getDerivedFrom

public String getDerivedFrom()

Returns:

Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. i.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.

setDerivedFrom

public SearchParameter setDerivedFrom(String value)

Parameters:

value - Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. i.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.

getStatusElement

public Enumeration<Enumerations.PublicationStatus> getStatusElement()

Overrides:

getStatusElement in class MetadataResource

Returns:

MetadataResource.status (The status of this search parameter. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

Overrides:

hasStatusElement in class MetadataResource

hasStatus

public boolean hasStatus()

Overrides:

hasStatus in class MetadataResource

setStatusElement

public SearchParameter setStatusElement(Enumeration<Enumerations.PublicationStatus> value)

Overrides:

setStatusElement in class MetadataResource

Parameters:

value - MetadataResource.status (The status of this search parameter. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public Enumerations.PublicationStatus getStatus()

Overrides:

getStatus in class MetadataResource

Returns:

The status of this search parameter. Enables tracking the life-cycle of the content.

setStatus

public SearchParameter setStatus(Enumerations.PublicationStatus value)

Overrides:

setStatus in class MetadataResource

Parameters:

value - The status of this search parameter. Enables tracking the life-cycle of the content.

getExperimentalElement

public BooleanType getExperimentalElement()

Overrides:

getExperimentalElement in class MetadataResource

Returns:

MetadataResource.experimental (A Boolean value to indicate that this search parameter 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

hasExperimentalElement

public boolean hasExperimentalElement()

Overrides:

hasExperimentalElement in class MetadataResource

hasExperimental

public boolean hasExperimental()

Overrides:

hasExperimental in class MetadataResource

setExperimentalElement

public SearchParameter setExperimentalElement(BooleanType value)

Overrides:

setExperimentalElement in class MetadataResource

Parameters:

value - MetadataResource.experimental (A Boolean value to indicate that this search parameter 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()

Overrides:

getExperimental in class MetadataResource

Returns:

A Boolean value to indicate that this search parameter 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)

Overrides:

setExperimental in class MetadataResource

Parameters:

value - A Boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

getDateElement

public DateTimeType getDateElement()

Overrides:

getDateElement in class MetadataResource

Returns:

MetadataResource.date (The date (and optionally time) when the search parameter was published. The date must change when the business version changes 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

hasDateElement

public boolean hasDateElement()

Overrides:

hasDateElement in class MetadataResource

hasDate

public boolean hasDate()

Overrides:

hasDate in class MetadataResource

setDateElement

public SearchParameter setDateElement(DateTimeType value)

Overrides:

setDateElement in class MetadataResource

Parameters:

value - MetadataResource.date (The date (and optionally time) when the search parameter was published. The date must change when the business version changes 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()

Overrides:

getDate in class MetadataResource

Returns:

The date (and optionally time) when the search parameter was published. The date must change when the business version changes 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)

Overrides:

setDate in class MetadataResource

Parameters:

value - The date (and optionally time) when the search parameter was published. The date must change when the business version changes 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()

Overrides:

getPublisherElement in class MetadataResource

Returns:

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

hasPublisherElement

public boolean hasPublisherElement()

Overrides:

hasPublisherElement in class MetadataResource

hasPublisher

public boolean hasPublisher()

Overrides:

hasPublisher in class MetadataResource

setPublisherElement

public SearchParameter setPublisherElement(StringType value)

Overrides:

setPublisherElement in class MetadataResource

Parameters:

value - MetadataResource.publisher (The name of the organization or individual 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()

Overrides:

getPublisher in class MetadataResource

Returns:

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

setPublisher

public SearchParameter setPublisher(String value)

Overrides:

setPublisher in class MetadataResource

Parameters:

value - The name of the organization or individual that published the search parameter.

getContact

public List<ContactDetail> getContact()

Overrides:

getContact in class MetadataResource

Returns:

MetadataResource.contact (Contact details to assist a user in finding and communicating with the publisher.)

setContact

public SearchParameter setContact(List<ContactDetail> theContact)

Overrides:

setContact in class MetadataResource

Returns:

Returns a reference to this for easy method chaining

hasContact

public boolean hasContact()

Overrides:

hasContact in class MetadataResource

addContact

public ContactDetail addContact()

Overrides:

addContact in class MetadataResource

addContact

public SearchParameter addContact(ContactDetail t)

Overrides:

addContact in class MetadataResource

getContactFirstRep

public ContactDetail getContactFirstRep()

Overrides:

getContactFirstRep in class MetadataResource

Returns:

The first repetition of repeating field MetadataResource.contact, creating it if it does not already exist

getDescriptionElement

public MarkdownType getDescriptionElement()

Overrides:

getDescriptionElement in class MetadataResource

Returns:

MetadataResource.description (And how it used.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

hasDescriptionElement

public boolean hasDescriptionElement()

Overrides:

hasDescriptionElement in class MetadataResource

hasDescription

public boolean hasDescription()

Overrides:

hasDescription in class MetadataResource

setDescriptionElement

public SearchParameter setDescriptionElement(MarkdownType value)

Overrides:

setDescriptionElement in class MetadataResource

Parameters:

value - MetadataResource.description (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()

Overrides:

getDescription in class MetadataResource

Returns:

And how it used.

setDescription

public SearchParameter setDescription(String value)

Overrides:

setDescription in class MetadataResource

Parameters:

value - And how it used.

getUseContext

public List<UsageContext> getUseContext()

Overrides:

getUseContext in class MetadataResource

Returns:

MetadataResource.useContext (The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instances.)

setUseContext

public SearchParameter setUseContext(List<UsageContext> theUseContext)

Overrides:

setUseContext in class MetadataResource

Returns:

Returns a reference to this for easy method chaining

hasUseContext

public boolean hasUseContext()

Overrides:

hasUseContext in class MetadataResource

addUseContext

public UsageContext addUseContext()

Overrides:

addUseContext in class MetadataResource

addUseContext

public SearchParameter addUseContext(UsageContext t)

Overrides:

addUseContext in class MetadataResource

getUseContextFirstRep

public UsageContext getUseContextFirstRep()

Overrides:

getUseContextFirstRep in class MetadataResource

Returns:

The first repetition of repeating field MetadataResource.useContext, creating it if it does not already exist

getJurisdiction

public List<CodeableConcept> getJurisdiction()

Overrides:

getJurisdiction in class MetadataResource

Returns:

MetadataResource.jurisdiction (A legal or geographic region in which the search parameter is intended to be used.)

setJurisdiction

public SearchParameter setJurisdiction(List<CodeableConcept> theJurisdiction)

Overrides:

setJurisdiction in class MetadataResource

Returns:

Returns a reference to this for easy method chaining

hasJurisdiction

public boolean hasJurisdiction()

Overrides:

hasJurisdiction in class MetadataResource

addJurisdiction

public CodeableConcept addJurisdiction()

Overrides:

addJurisdiction in class MetadataResource

addJurisdiction

public SearchParameter addJurisdiction(CodeableConcept t)

Overrides:

addJurisdiction in class MetadataResource

getJurisdictionFirstRep

public CodeableConcept getJurisdictionFirstRep()

Overrides:

getJurisdictionFirstRep in class MetadataResource

Returns:

The first repetition of repeating field MetadataResource.jurisdiction, creating it if it does not already exist

getPurposeElement

public MarkdownType getPurposeElement()

Returns:

purpose (Explanation of why this search parameter is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value

hasPurposeElement

public boolean hasPurposeElement()

hasPurpose

public boolean hasPurpose()

setPurposeElement

public SearchParameter setPurposeElement(MarkdownType value)

Parameters:

value - purpose (Explanation of why this search parameter is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value

getPurpose

public String getPurpose()

Returns:

Explanation of why this search parameter is needed and why it has been designed as it has.

setPurpose

public SearchParameter setPurpose(String value)

Parameters:

value - Explanation of why this search parameter is needed and why it has been designed as it has.

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

hasCodeElement

public boolean hasCodeElement()

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.

getBase

public List<CodeType> getBase()

Returns:

base (The base resource type(s) that this search parameter can be used against.)

setBase

public SearchParameter setBase(List<CodeType> theBase)

Returns:

Returns a reference to this for easy method chaining

hasBase

public boolean hasBase()

addBaseElement

public CodeType addBaseElement()

Returns:

base (The base resource type(s) that this search parameter can be used against.)

addBase

public SearchParameter addBase(String value)

Parameters:

value - base (The base resource type(s) that this search parameter can be used against.)

hasBase

public boolean hasBase(String value)

Parameters:

value - base (The base resource type(s) that this search parameter can be used against.)

getTypeElement

public Enumeration<Enumerations.SearchParamType> getTypeElement()

Returns:

type (The type of value that a search parameter may contain, 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

hasTypeElement

public boolean hasTypeElement()

hasType

public boolean hasType()

setTypeElement

public SearchParameter setTypeElement(Enumeration<Enumerations.SearchParamType> value)

Parameters:

value - type (The type of value that a search parameter may contain, 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

getType

public Enumerations.SearchParamType getType()

Returns:

The type of value that a search parameter may contain, and how the content is interpreted.

setType

public SearchParameter setType(Enumerations.SearchParamType value)

Parameters:

value - The type of value that a search parameter may contain, and how the content is interpreted.

getExpressionElement

public StringType getExpressionElement()

Returns:

expression (A FHIRPath 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

hasExpressionElement

public boolean hasExpressionElement()

hasExpression

public boolean hasExpression()

setExpressionElement

public SearchParameter setExpressionElement(StringType value)

Parameters:

value - expression (A FHIRPath 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 FHIRPath expression that returns a set of elements for the search parameter.

setExpression

public SearchParameter setExpression(String value)

Parameters:

value - A FHIRPath 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

hasXpathElement

public boolean hasXpathElement()

hasXpath

public boolean hasXpath()

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.

getXpathUsageElement

public Enumeration<SearchParameter.XPathUsageType> getXpathUsageElement()

Returns:

xpathUsage (How the search parameter relates to the set of elements returned by evaluating the xpath query.). This is the underlying object with id, value and extensions. The accessor "getXpathUsage" gives direct access to the value

hasXpathUsageElement

public boolean hasXpathUsageElement()

hasXpathUsage

public boolean hasXpathUsage()

setXpathUsageElement

public SearchParameter setXpathUsageElement(Enumeration<SearchParameter.XPathUsageType> value)

Parameters:

value - xpathUsage (How the search parameter relates to the set of elements returned by evaluating the xpath query.). This is the underlying object with id, value and extensions. The accessor "getXpathUsage" gives direct access to the value

getXpathUsage

public SearchParameter.XPathUsageType getXpathUsage()

Returns:

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

setXpathUsage

public SearchParameter setXpathUsage(SearchParameter.XPathUsageType value)

Parameters:

value - How the search parameter relates to the set of elements returned by evaluating the xpath query.

getTarget

public List<CodeType> getTarget()

Returns:

target (Types of resource (if a resource is referenced).)

setTarget

public SearchParameter setTarget(List<CodeType> theTarget)

Returns:

Returns a reference to this for easy method chaining

hasTarget

public boolean hasTarget()

addTargetElement

public CodeType addTargetElement()

Returns:

target (Types of resource (if a resource is referenced).)

addTarget

public SearchParameter addTarget(String value)

Parameters:

value - target (Types of resource (if a resource is referenced).)

hasTarget

public boolean hasTarget(String value)

Parameters:

value - target (Types of resource (if a resource is referenced).)

getMultipleOrElement

public BooleanType getMultipleOrElement()

Returns:

multipleOr (Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.). This is the underlying object with id, value and extensions. The accessor "getMultipleOr" gives direct access to the value

hasMultipleOrElement

public boolean hasMultipleOrElement()

hasMultipleOr

public boolean hasMultipleOr()

setMultipleOrElement

public SearchParameter setMultipleOrElement(BooleanType value)

Parameters:

value - multipleOr (Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.). This is the underlying object with id, value and extensions. The accessor "getMultipleOr" gives direct access to the value

getMultipleOr

public boolean getMultipleOr()

Returns:

Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.

setMultipleOr

public SearchParameter setMultipleOr(boolean value)

Parameters:

value - Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.

getMultipleAndElement

public BooleanType getMultipleAndElement()

Returns:

multipleAnd (Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.). This is the underlying object with id, value and extensions. The accessor "getMultipleAnd" gives direct access to the value

hasMultipleAndElement

public boolean hasMultipleAndElement()

hasMultipleAnd

public boolean hasMultipleAnd()

setMultipleAndElement

public SearchParameter setMultipleAndElement(BooleanType value)

Parameters:

value - multipleAnd (Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.). This is the underlying object with id, value and extensions. The accessor "getMultipleAnd" gives direct access to the value

getMultipleAnd

public boolean getMultipleAnd()

Returns:

Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.

setMultipleAnd

public SearchParameter setMultipleAnd(boolean value)

Parameters:

value - Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.

getComparator

public List<Enumeration<SearchParameter.SearchComparator>> getComparator()

Returns:

comparator (Comparators supported for the search parameter.)

setComparator

public SearchParameter setComparator(List<Enumeration<SearchParameter.SearchComparator>> theComparator)

Returns:

Returns a reference to this for easy method chaining

hasComparator

public boolean hasComparator()

addComparatorElement

public Enumeration<SearchParameter.SearchComparator> addComparatorElement()

Returns:

comparator (Comparators supported for the search parameter.)

addComparator

public SearchParameter addComparator(SearchParameter.SearchComparator value)

Parameters:

value - comparator (Comparators supported for the search parameter.)

hasComparator

public boolean hasComparator(SearchParameter.SearchComparator value)

Parameters:

value - comparator (Comparators supported for the search parameter.)

getModifier

public List<Enumeration<SearchParameter.SearchModifierCode>> getModifier()

Returns:

modifier (A modifier supported for the search parameter.)

setModifier

public SearchParameter setModifier(List<Enumeration<SearchParameter.SearchModifierCode>> theModifier)

Returns:

Returns a reference to this for easy method chaining

hasModifier

public boolean hasModifier()

addModifierElement

public Enumeration<SearchParameter.SearchModifierCode> addModifierElement()

Returns:

modifier (A modifier supported for the search parameter.)

addModifier

public SearchParameter addModifier(SearchParameter.SearchModifierCode value)

Parameters:

value - modifier (A modifier supported for the search parameter.)

hasModifier

public boolean hasModifier(SearchParameter.SearchModifierCode value)

Parameters:

value - modifier (A modifier supported for the search parameter.)

getChain

public List<StringType> getChain()

Returns:

chain (Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.)

setChain

public SearchParameter setChain(List<StringType> theChain)

Returns:

Returns a reference to this for easy method chaining

hasChain

public boolean hasChain()

addChainElement

public StringType addChainElement()

Returns:

chain (Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.)

addChain

public SearchParameter addChain(String value)

Parameters:

value - chain (Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.)

hasChain

public boolean hasChain(String value)

Parameters:

value - chain (Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.)

getComponent

public List<SearchParameter.SearchParameterComponentComponent> getComponent()

Returns:

component (Used to define the parts of a composite search parameter.)

setComponent

public SearchParameter setComponent(List<SearchParameter.SearchParameterComponentComponent> theComponent)

Returns:

Returns a reference to this for easy method chaining

hasComponent

public boolean hasComponent()

addComponent

public SearchParameter.SearchParameterComponentComponent addComponent()

addComponent

public SearchParameter addComponent(SearchParameter.SearchParameterComponentComponent t)

getComponentFirstRep

public SearchParameter.SearchParameterComponentComponent getComponentFirstRep()

Returns:

The first repetition of repeating field component, creating it if it does not already exist

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class MetadataResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class MetadataResource

copy

public SearchParameter copy()

Specified by:

copy in class MetadataResource

copyValues

public void copyValues(SearchParameter dst)

typedCopy

protected SearchParameter typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class MetadataResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class MetadataResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class MetadataResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource