Package org.hl7.fhir.dstu2.model

Class Conformance.ConformanceRestResourceSearchParamComponent

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.Element

org.hl7.fhir.dstu2.model.BackboneElement

org.hl7.fhir.dstu2.model.Conformance.ConformanceRestResourceSearchParamComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

Conformance

public static class Conformance.ConformanceRestResourceSearchParamComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<StringType>	chain	Contains the names of any search parameters which may be chained to the containing search parameter.
protected UriType	definition	An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]).
protected StringType	documentation	This allows documentation of any distinct behaviors about how the search parameter is used.
protected List<Enumeration<Conformance.SearchModifierCode>>	modifier	A modifier supported for the search parameter.
protected StringType	name	The name of the search parameter used in the interface.
protected List<CodeType>	target	Types of resource (if a resource is referenced).
protected Enumeration<Enumerations.SearchParamType>	type	The type of value a search parameter refers to, and how the content is interpreted.

Fields inherited from class org.hl7.fhir.dstu2.model.BackboneElement

modifierExtension

Fields inherited from class org.hl7.fhir.dstu2.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
ConformanceRestResourceSearchParamComponent()
ConformanceRestResourceSearchParamComponent(StringType name, Enumeration<Enumerations.SearchParamType> type)

Method Summary

Modifier and Type	Method	Description
Conformance.ConformanceRestResourceSearchParamComponent	addChain(String value)
StringType	addChainElement()
Base	addChild(String name)
Conformance.ConformanceRestResourceSearchParamComponent	addModifier(Conformance.SearchModifierCode value)
Enumeration<Conformance.SearchModifierCode>	addModifierElement()
Conformance.ConformanceRestResourceSearchParamComponent	addTarget(String value)
CodeType	addTargetElement()
Conformance.ConformanceRestResourceSearchParamComponent	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
List<StringType>	getChain()
String	getDefinition()
UriType	getDefinitionElement()
String	getDocumentation()
StringType	getDocumentationElement()
List<Enumeration<Conformance.SearchModifierCode>>	getModifier()
String	getName()
StringType	getNameElement()
List<CodeType>	getTarget()
Enumerations.SearchParamType	getType()
Enumeration<Enumerations.SearchParamType>	getTypeElement()
boolean	hasChain()
boolean	hasChain(String value)
boolean	hasDefinition()
boolean	hasDefinitionElement()
boolean	hasDocumentation()
boolean	hasDocumentationElement()
boolean	hasModifier()
boolean	hasModifier(Conformance.SearchModifierCode value)
boolean	hasName()
boolean	hasNameElement()
boolean	hasTarget()
boolean	hasTarget(String value)
boolean	hasType()
boolean	hasTypeElement()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Conformance.ConformanceRestResourceSearchParamComponent	setDefinition(String value)
Conformance.ConformanceRestResourceSearchParamComponent	setDefinitionElement(UriType value)
Conformance.ConformanceRestResourceSearchParamComponent	setDocumentation(String value)
Conformance.ConformanceRestResourceSearchParamComponent	setDocumentationElement(StringType value)
Conformance.ConformanceRestResourceSearchParamComponent	setName(String value)
Conformance.ConformanceRestResourceSearchParamComponent	setNameElement(StringType value)
void	setProperty(String name, Base value)
Conformance.ConformanceRestResourceSearchParamComponent	setType(Enumerations.SearchParamType value)
Conformance.ConformanceRestResourceSearchParamComponent	setTypeElement(Enumeration<Enumerations.SearchParamType> value)

Methods inherited from class org.hl7.fhir.dstu2.model.BackboneElement

addModifierExtension, addModifierExtension, copyValues, getModifierExtension, hasModifierExtension

Methods inherited from class org.hl7.fhir.dstu2.model.Element

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

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

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

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

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

getUserData, setUserData

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

addExtension, getExtension, hasExtension

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

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

name

protected StringType name

The name of the search parameter used in the interface.

definition

protected UriType definition

An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]).

type

protected Enumeration<Enumerations.SearchParamType> type

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

documentation

protected StringType documentation

This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.

target

protected List<CodeType> target

Types of resource (if a resource is referenced).

modifier

protected List<Enumeration<Conformance.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 Conformance.rest.resource.searchParam.name on the target resource type.

Constructor Details

ConformanceRestResourceSearchParamComponent

public ConformanceRestResourceSearchParamComponent()

ConformanceRestResourceSearchParamComponent

public ConformanceRestResourceSearchParamComponent(StringType name,
 Enumeration<Enumerations.SearchParamType> type)

Method Details

getNameElement

public StringType getNameElement()

Returns:

name (The name of the search parameter used in the interface.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

hasNameElement

public boolean hasNameElement()

hasName

public boolean hasName()

setNameElement

public Conformance.ConformanceRestResourceSearchParamComponent setNameElement(StringType value)

Parameters:

value - name (The name of the search parameter used in the interface.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

getName

public String getName()

Returns:

The name of the search parameter used in the interface.

setName

public Conformance.ConformanceRestResourceSearchParamComponent setName(String value)

Parameters:

value - The name of the search parameter used in the interface.

getDefinitionElement

public UriType getDefinitionElement()

Returns:

definition (An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]).). This is the underlying object with id, value and extensions. The accessor "getDefinition" gives direct access to the value

hasDefinitionElement

public boolean hasDefinitionElement()

hasDefinition

public boolean hasDefinition()

setDefinitionElement

public Conformance.ConformanceRestResourceSearchParamComponent setDefinitionElement(UriType value)

Parameters:

value - definition (An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]).). This is the underlying object with id, value and extensions. The accessor "getDefinition" gives direct access to the value

getDefinition

public String getDefinition()

Returns:

An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]).

setDefinition

public Conformance.ConformanceRestResourceSearchParamComponent setDefinition(String value)

Parameters:

value - An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]).

getTypeElement

public Enumeration<Enumerations.SearchParamType> getTypeElement()

Returns:

type (The type of value a search parameter refers to, and how the content is interpreted.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

hasTypeElement

public boolean hasTypeElement()

hasType

public boolean hasType()

setTypeElement

public Conformance.ConformanceRestResourceSearchParamComponent setTypeElement(Enumeration<Enumerations.SearchParamType> value)

Parameters:

value - type (The type of value a search parameter refers to, and how the content is interpreted.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

getType

public Enumerations.SearchParamType getType()

Returns:

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

setType

public Conformance.ConformanceRestResourceSearchParamComponent setType(Enumerations.SearchParamType value)

Parameters:

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

getDocumentationElement

public StringType getDocumentationElement()

Returns:

documentation (This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.). This is the underlying object with id, value and extensions. The accessor "getDocumentation" gives direct access to the value

hasDocumentationElement

public boolean hasDocumentationElement()

hasDocumentation

public boolean hasDocumentation()

setDocumentationElement

public Conformance.ConformanceRestResourceSearchParamComponent setDocumentationElement(StringType value)

Parameters:

value - documentation (This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.). This is the underlying object with id, value and extensions. The accessor "getDocumentation" gives direct access to the value

getDocumentation

public String getDocumentation()

Returns:

This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.

setDocumentation

public Conformance.ConformanceRestResourceSearchParamComponent setDocumentation(String value)

Parameters:

value - This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.

getTarget

public List<CodeType> getTarget()

Returns:

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

hasTarget

public boolean hasTarget()

addTargetElement

public CodeType addTargetElement()

Returns:

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

addTarget

public Conformance.ConformanceRestResourceSearchParamComponent 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).)

getModifier

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

Returns:

modifier (A modifier supported for the search parameter.)

hasModifier

public boolean hasModifier()

addModifierElement

public Enumeration<Conformance.SearchModifierCode> addModifierElement()

Returns:

modifier (A modifier supported for the search parameter.)

addModifier

public Conformance.ConformanceRestResourceSearchParamComponent addModifier(Conformance.SearchModifierCode value)

Parameters:

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

hasModifier

public boolean hasModifier(Conformance.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 Conformance.rest.resource.searchParam.name on the target resource type.)

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 Conformance.rest.resource.searchParam.name on the target resource type.)

addChain

public Conformance.ConformanceRestResourceSearchParamComponent 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 Conformance.rest.resource.searchParam.name 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 Conformance.rest.resource.searchParam.name on the target resource type.)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class BackboneElement

setProperty

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

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public Conformance.ConformanceRestResourceSearchParamComponent copy()

Specified by:

copy in class BackboneElement

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class BackboneElement