Class 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
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
static class
static enum
static class
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionThe base resource type(s) that this search parameter can be used against.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for baseprotected List
<StringType> Contains the names of any search parameters which may be chained to the containing search parameter.protected CodeType
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
Fluent Client search parameter constant for codeprotected List
<Enumeration<SearchParameter.SearchComparator>> Comparators supported for the search parameter.Used to define the parts of a composite search parameter.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for componentstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for contextstatic final ca.uhn.fhir.rest.gclient.QuantityClientParam
Fluent Client search parameter constant for context-quantitystatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for context-typestatic final ca.uhn.fhir.rest.gclient.CompositeClientParam
<ca.uhn.fhir.rest.gclient.TokenClientParam, ca.uhn.fhir.rest.gclient.QuantityClientParam> Fluent Client search parameter constant for context-type-quantitystatic final ca.uhn.fhir.rest.gclient.CompositeClientParam
<ca.uhn.fhir.rest.gclient.TokenClientParam, ca.uhn.fhir.rest.gclient.TokenClientParam> Fluent Client search parameter constant for context-type-valuestatic final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for datestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for derived-fromprotected CanonicalType
Where this search parameter is originally defined.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for descriptionprotected StringType
A FHIRPath expression that returns a set of elements for the search parameter.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for jurisdictionprotected List
<Enumeration<SearchParameter.SearchModifierCode>> A modifier supported for the search parameter.protected BooleanType
Whether multiple parameters are allowed - e.g.protected BooleanType
Whether multiple values are allowed for each time the parameter exists.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for namestatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for publisherprotected MarkdownType
Explanation of why this search parameter is needed and why it has been designed as it has.static final String
Search parameter: basestatic final String
Search parameter: codestatic final String
Search parameter: componentstatic final String
Search parameter: contextstatic final String
Search parameter: context-quantitystatic final String
Search parameter: context-typestatic final String
Search parameter: context-type-quantitystatic final String
Search parameter: context-type-valuestatic final String
Search parameter: datestatic final String
Search parameter: derived-fromstatic final String
Search parameter: descriptionstatic final String
Search parameter: jurisdictionstatic final String
Search parameter: namestatic final String
Search parameter: publisherstatic final String
Search parameter: statusstatic final String
Search parameter: targetstatic final String
Search parameter: typestatic final String
Search parameter: urlstatic final String
Search parameter: versionstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusTypes of resource (if a resource is referenced).static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for targetprotected Enumeration
<Enumerations.SearchParamType> The type of value that a search parameter may contain, and how the content is interpreted.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for typestatic final ca.uhn.fhir.rest.gclient.UriClientParam
Fluent Client search parameter constant for urlstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for versionprotected StringType
An XPath expression that returns a set of elements for the search parameter.protected Enumeration
<SearchParameter.XPathUsageType> 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
ConstructorDescriptionConstructorSearchParameter
(UriType url, StringType name, Enumeration<Enumerations.PublicationStatus> status, MarkdownType description, CodeType code, Enumeration<Enumerations.SearchParamType> type) Constructor -
Method Summary
Modifier and TypeMethodDescriptioncopy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getBase()
getChain()
getCode()
getDate()
boolean
boolean
boolean
getName()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) getType()
String[]
getTypesForProperty
(int hash, String name) getUrl()
getXpath()
boolean
hasBase()
boolean
boolean
hasChain()
boolean
boolean
hasCode()
boolean
boolean
boolean
boolean
boolean
boolean
hasDate()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasName()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasType()
boolean
boolean
hasUrl()
boolean
boolean
boolean
boolean
boolean
hasXpath()
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setChain
(List<StringType> theChain) setCodeElement
(CodeType value) setComparator
(List<Enumeration<SearchParameter.SearchComparator>> theComparator) setComponent
(List<SearchParameter.SearchParameterComponentComponent> theComponent) setContact
(List<ContactDetail> theContact) setDateElement
(DateTimeType value) setDerivedFrom
(String value) setDescription
(String value) setExperimental
(boolean value) setExpression
(String value) setExpressionElement
(StringType value) setJurisdiction
(List<CodeableConcept> theJurisdiction) setModifier
(List<Enumeration<SearchParameter.SearchModifierCode>> theModifier) setMultipleAnd
(boolean value) setMultipleAndElement
(BooleanType value) setMultipleOr
(boolean value) setMultipleOrElement
(BooleanType value) setNameElement
(StringType value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setPublisher
(String value) setPublisherElement
(StringType value) setPurpose
(String value) setPurposeElement
(MarkdownType value) setUrlElement
(UriType value) setUseContext
(List<UsageContext> theUseContext) setVersion
(String value) setVersionElement
(StringType value) setXpathElement
(StringType value) protected SearchParameter
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
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
Explanation of why this search parameter is needed and why it has been designed as it has. -
code
The code used in the URL or the parameter name in a parameters resource for this search parameter. -
base
The base resource type(s) that this search parameter can be used against. -
type
The type of value that a search parameter may contain, and how the content is interpreted. -
expression
A FHIRPath expression that returns a set of elements for the search parameter. -
xpath
An XPath expression that returns a set of elements for the search parameter. -
xpathUsage
How the search parameter relates to the set of elements returned by evaluating the xpath query. -
target
Types of resource (if a resource is referenced). -
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
Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match. -
comparator
Comparators supported for the search parameter. -
modifier
A modifier supported for the search parameter. -
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
Used to define the parts of a composite search parameter. -
SP_DATE
Search parameter: dateDescription: The search parameter publication date
Type: date
Path: SearchParameter.date
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: The search parameter publication date
Type: date
Path: SearchParameter.date
-
SP_CODE
Search parameter: codeDescription: Code used in URL
Type: token
Path: SearchParameter.code
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: Code used in URL
Type: token
Path: SearchParameter.code
-
SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-valueDescription: A use context type and value assigned to the search parameter
Type: composite
Path:
- See Also:
-
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_VALUEFluent Client search parameter constant for context-type-valueDescription: A use context type and value assigned to the search parameter
Type: composite
Path:
-
SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the search parameter
Type: token
Path: SearchParameter.jurisdiction
- See Also:
-
JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the search parameter
Type: token
Path: SearchParameter.jurisdiction
-
SP_DESCRIPTION
Search parameter: descriptionDescription: The description of the search parameter
Type: string
Path: SearchParameter.description
- See Also:
-
DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: The description of the search parameter
Type: string
Path: SearchParameter.description
-
SP_DERIVED_FROM
Search parameter: derived-fromDescription: Original definition for the search parameter
Type: reference
Path: SearchParameter.derivedFrom
- See Also:
-
DERIVED_FROM
Fluent Client search parameter constant for derived-fromDescription: Original definition for the search parameter
Type: reference
Path: SearchParameter.derivedFrom
-
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
Search parameter: context-typeDescription: A type of use context assigned to the search parameter
Type: token
Path: SearchParameter.useContext.code
- See Also:
-
CONTEXT_TYPE
Fluent Client search parameter constant for context-typeDescription: A type of use context assigned to the search parameter
Type: token
Path: SearchParameter.useContext.code
-
SP_TYPE
Search parameter: typeDescription: number | date | string | token | reference | composite | quantity | uri | special
Type: token
Path: SearchParameter.type
- See Also:
-
TYPE
Fluent Client search parameter constant for typeDescription: number | date | string | token | reference | composite | quantity | uri | special
Type: token
Path: SearchParameter.type
-
SP_VERSION
Search parameter: versionDescription: The business version of the search parameter
Type: token
Path: SearchParameter.version
- See Also:
-
VERSION
Fluent Client search parameter constant for versionDescription: The business version of the search parameter
Type: token
Path: SearchParameter.version
-
SP_URL
Search parameter: urlDescription: The uri that identifies the search parameter
Type: uri
Path: SearchParameter.url
- See Also:
-
URL
Fluent Client search parameter constant for urlDescription: The uri that identifies the search parameter
Type: uri
Path: SearchParameter.url
-
SP_TARGET
Search parameter: targetDescription: Types of resource (if a resource reference)
Type: token
Path: SearchParameter.target
- See Also:
-
TARGET
Fluent Client search parameter constant for targetDescription: Types of resource (if a resource reference)
Type: token
Path: SearchParameter.target
-
SP_CONTEXT_QUANTITY
Search parameter: context-quantityDescription: A quantity- or range-valued use context assigned to the search parameter
Type: quantity
Path: SearchParameter.useContext.valueQuantity, SearchParameter.useContext.valueRange
- See Also:
-
CONTEXT_QUANTITY
Fluent Client search parameter constant for context-quantityDescription: A quantity- or range-valued use context assigned to the search parameter
Type: quantity
Path: SearchParameter.useContext.valueQuantity, SearchParameter.useContext.valueRange
-
SP_COMPONENT
Search parameter: componentDescription: Defines how the part works
Type: reference
Path: SearchParameter.component.definition
- See Also:
-
COMPONENT
Fluent Client search parameter constant for componentDescription: Defines how the part works
Type: reference
Path: SearchParameter.component.definition
-
INCLUDE_COMPONENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "SearchParameter:component". -
SP_NAME
Search parameter: nameDescription: Computationally friendly name of the search parameter
Type: string
Path: SearchParameter.name
- See Also:
-
NAME
Fluent Client search parameter constant for nameDescription: Computationally friendly name of the search parameter
Type: string
Path: SearchParameter.name
-
SP_CONTEXT
Search parameter: contextDescription: A use context assigned to the search parameter
Type: token
Path: SearchParameter.useContext.valueCodeableConcept
- See Also:
-
CONTEXT
Fluent Client search parameter constant for contextDescription: A use context assigned to the search parameter
Type: token
Path: SearchParameter.useContext.valueCodeableConcept
-
SP_PUBLISHER
Search parameter: publisherDescription: Name of the publisher of the search parameter
Type: string
Path: SearchParameter.publisher
- See Also:
-
PUBLISHER
Fluent Client search parameter constant for publisherDescription: Name of the publisher of the search parameter
Type: string
Path: SearchParameter.publisher
-
SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the search parameter
Type: composite
Path:
- See Also:
-
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_QUANTITYFluent Client search parameter constant for context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the search parameter
Type: composite
Path:
-
SP_STATUS
Search parameter: statusDescription: The current status of the search parameter
Type: token
Path: SearchParameter.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: The current status of the search parameter
Type: token
Path: SearchParameter.status
-
SP_BASE
Search parameter: baseDescription: The resource type(s) this search parameter applies to
Type: token
Path: SearchParameter.base
- See Also:
-
BASE
Fluent Client search parameter constant for baseDescription: 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
- Overrides:
getUrlElement
in classMetadataResource
- 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
- Overrides:
hasUrlElement
in classMetadataResource
-
hasUrl
- Overrides:
hasUrl
in classMetadataResource
-
setUrlElement
- Overrides:
setUrlElement
in classMetadataResource
- 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
- Overrides:
getUrl
in classMetadataResource
- 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
- Overrides:
setUrl
in classMetadataResource
- 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
- Overrides:
getVersionElement
in classMetadataResource
- 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
- Overrides:
hasVersionElement
in classMetadataResource
-
hasVersion
- Overrides:
hasVersion
in classMetadataResource
-
setVersionElement
- Overrides:
setVersionElement
in classMetadataResource
- 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
- Overrides:
getVersion
in classMetadataResource
- 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
- Overrides:
setVersion
in classMetadataResource
- 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
- Overrides:
getNameElement
in classMetadataResource
- 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
- Overrides:
hasNameElement
in classMetadataResource
-
hasName
- Overrides:
hasName
in classMetadataResource
-
setNameElement
- Overrides:
setNameElement
in classMetadataResource
- 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
- Overrides:
getName
in classMetadataResource
- 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
- Overrides:
setName
in classMetadataResource
- 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
- 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
-
hasDerivedFrom
-
setDerivedFromElement
- 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
- 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
- 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
- Overrides:
getStatusElement
in classMetadataResource
- 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
- Overrides:
hasStatusElement
in classMetadataResource
-
hasStatus
- Overrides:
hasStatus
in classMetadataResource
-
setStatusElement
- Overrides:
setStatusElement
in classMetadataResource
- 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
- Overrides:
getStatus
in classMetadataResource
- Returns:
- The status of this search parameter. Enables tracking the life-cycle of the content.
-
setStatus
- Overrides:
setStatus
in classMetadataResource
- Parameters:
value
- The status of this search parameter. Enables tracking the life-cycle of the content.
-
getExperimentalElement
- Overrides:
getExperimentalElement
in classMetadataResource
- 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
- Overrides:
hasExperimentalElement
in classMetadataResource
-
hasExperimental
- Overrides:
hasExperimental
in classMetadataResource
-
setExperimentalElement
- Overrides:
setExperimentalElement
in classMetadataResource
- 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
- Overrides:
getExperimental
in classMetadataResource
- 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
- Overrides:
setExperimental
in classMetadataResource
- 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
- Overrides:
getDateElement
in classMetadataResource
- 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
- Overrides:
hasDateElement
in classMetadataResource
-
hasDate
- Overrides:
hasDate
in classMetadataResource
-
setDateElement
- Overrides:
setDateElement
in classMetadataResource
- 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
- Overrides:
getDate
in classMetadataResource
- 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
- Overrides:
setDate
in classMetadataResource
- 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
- Overrides:
getPublisherElement
in classMetadataResource
- 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
- Overrides:
hasPublisherElement
in classMetadataResource
-
hasPublisher
- Overrides:
hasPublisher
in classMetadataResource
-
setPublisherElement
- Overrides:
setPublisherElement
in classMetadataResource
- 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
- Overrides:
getPublisher
in classMetadataResource
- Returns:
- The name of the organization or individual that published the search parameter.
-
setPublisher
- Overrides:
setPublisher
in classMetadataResource
- Parameters:
value
- The name of the organization or individual that published the search parameter.
-
getContact
- Overrides:
getContact
in classMetadataResource
- Returns:
MetadataResource.contact
(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
- Overrides:
setContact
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
- Overrides:
hasContact
in classMetadataResource
-
addContact
- Overrides:
addContact
in classMetadataResource
-
addContact
- Overrides:
addContact
in classMetadataResource
-
getContactFirstRep
- Overrides:
getContactFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.contact
, creating it if it does not already exist
-
getDescriptionElement
- Overrides:
getDescriptionElement
in classMetadataResource
- 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
- Overrides:
hasDescriptionElement
in classMetadataResource
-
hasDescription
- Overrides:
hasDescription
in classMetadataResource
-
setDescriptionElement
- Overrides:
setDescriptionElement
in classMetadataResource
- 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
- Overrides:
getDescription
in classMetadataResource
- Returns:
- And how it used.
-
setDescription
- Overrides:
setDescription
in classMetadataResource
- Parameters:
value
- And how it used.
-
getUseContext
- Overrides:
getUseContext
in classMetadataResource
- 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
- Overrides:
setUseContext
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUseContext
- Overrides:
hasUseContext
in classMetadataResource
-
addUseContext
- Overrides:
addUseContext
in classMetadataResource
-
addUseContext
- Overrides:
addUseContext
in classMetadataResource
-
getUseContextFirstRep
- Overrides:
getUseContextFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.useContext
, creating it if it does not already exist
-
getJurisdiction
- Overrides:
getJurisdiction
in classMetadataResource
- Returns:
MetadataResource.jurisdiction
(A legal or geographic region in which the search parameter is intended to be used.)
-
setJurisdiction
- Overrides:
setJurisdiction
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasJurisdiction
- Overrides:
hasJurisdiction
in classMetadataResource
-
addJurisdiction
- Overrides:
addJurisdiction
in classMetadataResource
-
addJurisdiction
- Overrides:
addJurisdiction
in classMetadataResource
-
getJurisdictionFirstRep
- Overrides:
getJurisdictionFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.jurisdiction
, creating it if it does not already exist
-
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
-
hasPurpose
-
setPurposeElement
- 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
- Returns:
- Explanation of why this search parameter is needed and why it has been designed as it has.
-
setPurpose
- Parameters:
value
- Explanation of why this search parameter is needed and why it has been designed as it has.
-
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
-
hasCode
-
setCodeElement
- 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
- Returns:
- The code used in the URL or the parameter name in a parameters resource for this search parameter.
-
setCode
- Parameters:
value
- The code used in the URL or the parameter name in a parameters resource for this search parameter.
-
getBase
- Returns:
base
(The base resource type(s) that this search parameter can be used against.)
-
setBase
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasBase
-
addBaseElement
- Returns:
base
(The base resource type(s) that this search parameter can be used against.)
-
addBase
- Parameters:
value
-base
(The base resource type(s) that this search parameter can be used against.)
-
hasBase
- Parameters:
value
-base
(The base resource type(s) that this search parameter can be used against.)
-
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
-
hasType
-
setTypeElement
- 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
- Returns:
- The type of value that a search parameter may contain, and how the content is interpreted.
-
setType
- Parameters:
value
- The type of value that a search parameter may contain, and how the content is interpreted.
-
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
-
hasExpression
-
setExpressionElement
- 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
- Returns:
- A FHIRPath expression that returns a set of elements for the search parameter.
-
setExpression
- Parameters:
value
- A FHIRPath expression that returns a set of elements for the search parameter.
-
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
-
hasXpath
-
setXpathElement
- 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
- Returns:
- An XPath expression that returns a set of elements for the search parameter.
-
setXpath
- Parameters:
value
- An XPath expression that returns a set of elements for the search parameter.
-
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
-
hasXpathUsage
-
setXpathUsageElement
- 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
- Returns:
- How the search parameter relates to the set of elements returned by evaluating the xpath query.
-
setXpathUsage
- Parameters:
value
- How the search parameter relates to the set of elements returned by evaluating the xpath query.
-
getTarget
- Returns:
target
(Types of resource (if a resource is referenced).)
-
setTarget
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTarget
-
addTargetElement
- Returns:
target
(Types of resource (if a resource is referenced).)
-
addTarget
- Parameters:
value
-target
(Types of resource (if a resource is referenced).)
-
hasTarget
- Parameters:
value
-target
(Types of resource (if a resource is referenced).)
-
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
-
hasMultipleOr
-
setMultipleOrElement
- 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
- 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
- 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
- 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
-
hasMultipleAnd
-
setMultipleAndElement
- 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
- 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
- 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
- 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
-
addComparatorElement
- Returns:
comparator
(Comparators supported for the search parameter.)
-
addComparator
- Parameters:
value
-comparator
(Comparators supported for the search parameter.)
-
hasComparator
- Parameters:
value
-comparator
(Comparators supported for the search parameter.)
-
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
-
addModifierElement
- Returns:
modifier
(A modifier supported for the search parameter.)
-
addModifier
- Parameters:
value
-modifier
(A modifier supported for the search parameter.)
-
hasModifier
- Parameters:
value
-modifier
(A modifier supported for the search parameter.)
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasChain
-
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
- 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
- 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
- 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
-
addComponent
-
addComponent
-
getComponentFirstRep
- Returns:
- The first repetition of repeating field
component
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classMetadataResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classMetadataResource
- 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 classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classMetadataResource
-
copy
- Specified by:
copy
in classMetadataResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classMetadataResource
-
equalsShallow
- Overrides:
equalsShallow
in classMetadataResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classMetadataResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-