
Class SearchParameter
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.BaseResource
-
- org.hl7.fhir.dstu3.model.Resource
-
- org.hl7.fhir.dstu3.model.DomainResource
-
- org.hl7.fhir.dstu3.model.MetadataResource
-
- org.hl7.fhir.dstu3.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 class
SearchParameter.SearchComparator
static class
SearchParameter.SearchComparatorEnumFactory
static class
SearchParameter.SearchModifierCode
static class
SearchParameter.SearchModifierCodeEnumFactory
static class
SearchParameter.SearchParameterComponentComponent
static class
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 ca.uhn.fhir.rest.gclient.TokenClientParam
BASE
Fluent Client search parameter constant for baseprotected 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 ca.uhn.fhir.rest.gclient.TokenClientParam
CODE
Fluent Client search parameter constant for codeprotected 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 ca.uhn.fhir.rest.gclient.ReferenceClientParam
COMPONENT
Fluent Client search parameter constant for componentstatic ca.uhn.fhir.rest.gclient.DateClientParam
DATE
Fluent Client search parameter constant for datestatic ca.uhn.fhir.rest.gclient.UriClientParam
DERIVED_FROM
Fluent Client search parameter constant for derived-fromprotected UriType
derivedFrom
Where this search parameter is originally defined.static ca.uhn.fhir.rest.gclient.StringClientParam
DESCRIPTION
Fluent Client search parameter constant for descriptionprotected StringType
expression
A FHIRPath expression that returns a set of elements for the search parameter.static ca.uhn.fhir.model.api.Include
INCLUDE_COMPONENT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.TokenClientParam
JURISDICTION
Fluent Client search parameter constant for jurisdictionprotected List<Enumeration<SearchParameter.SearchModifierCode>>
modifier
A modifier supported for the search parameter.static ca.uhn.fhir.rest.gclient.StringClientParam
NAME
Fluent Client search parameter constant for namestatic ca.uhn.fhir.rest.gclient.StringClientParam
PUBLISHER
Fluent Client search parameter constant for publisherprotected MarkdownType
purpose
Explaination of why this search parameter is needed and why it has been designed as it has.static String
SP_BASE
Search parameter: basestatic String
SP_CODE
Search parameter: codestatic String
SP_COMPONENT
Search parameter: componentstatic String
SP_DATE
Search parameter: datestatic String
SP_DERIVED_FROM
Search parameter: derived-fromstatic String
SP_DESCRIPTION
Search parameter: descriptionstatic String
SP_JURISDICTION
Search parameter: jurisdictionstatic String
SP_NAME
Search parameter: namestatic String
SP_PUBLISHER
Search parameter: publisherstatic String
SP_STATUS
Search parameter: statusstatic String
SP_TARGET
Search parameter: targetstatic String
SP_TYPE
Search parameter: typestatic String
SP_URL
Search parameter: urlstatic String
SP_VERSION
Search parameter: versionstatic ca.uhn.fhir.rest.gclient.TokenClientParam
STATUS
Fluent Client search parameter constant for statusprotected List<CodeType>
target
Types of resource (if a resource is referenced).static ca.uhn.fhir.rest.gclient.TokenClientParam
TARGET
Fluent Client search parameter constant for targetprotected Enumeration<Enumerations.SearchParamType>
type
The type of value a search parameter refers to, and how the content is interpreted.static ca.uhn.fhir.rest.gclient.TokenClientParam
TYPE
Fluent Client search parameter constant for typestatic ca.uhn.fhir.rest.gclient.UriClientParam
URL
Fluent Client search parameter constant for urlstatic ca.uhn.fhir.rest.gclient.TokenClientParam
VERSION
Fluent Client search parameter constant for versionprotected 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.dstu3.model.MetadataResource
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version
-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description SearchParameter()
ConstructorSearchParameter(UriType url, StringType name, Enumeration<Enumerations.PublicationStatus> status, CodeType code, Enumeration<Enumerations.SearchParamType> type, MarkdownType description)
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.MetadataResource
checkCanUseUrl, copyValues, getTitle, getTitleElement, hasTitle, hasTitleElement, setTitle, setTitleElement, toString
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, 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.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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
-
-
-
-
Field Detail
-
purpose
protected MarkdownType purpose
Explaination 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 a search parameter refers to, and how the content is interpreted.
-
derivedFrom
protected UriType 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.
-
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.
-
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: dateDescription: 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 dateDescription: The search parameter publication date
Type: date
Path: SearchParameter.date
-
SP_CODE
public static final String SP_CODE
Search parameter: codeDescription: 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 codeDescription: Code used in URL
Type: token
Path: SearchParameter.code
-
SP_JURISDICTION
public static final String SP_JURISDICTION
Search parameter: jurisdictionDescription: 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 jurisdictionDescription: Intended jurisdiction for the search parameter
Type: token
Path: SearchParameter.jurisdiction
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
Search parameter: descriptionDescription: 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 descriptionDescription: The description of the search parameter
Type: string
Path: SearchParameter.description
-
SP_DERIVED_FROM
public static final String SP_DERIVED_FROM
Search parameter: derived-fromDescription: Original Definition for the search parameter
Type: uri
Path: SearchParameter.derivedFrom
- See Also:
- Constant Field Values
-
DERIVED_FROM
public static final ca.uhn.fhir.rest.gclient.UriClientParam DERIVED_FROM
Fluent Client search parameter constant for derived-fromDescription: Original Definition for the search parameter
Type: uri
Path: SearchParameter.derivedFrom
-
SP_TYPE
public static final String SP_TYPE
Search parameter: typeDescription: number | date | string | token | reference | composite | quantity | uri
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 typeDescription: number | date | string | token | reference | composite | quantity | uri
Type: token
Path: SearchParameter.type
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: 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 versionDescription: The business version of the search parameter
Type: token
Path: SearchParameter.version
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: 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 urlDescription: The uri that identifies the search parameter
Type: uri
Path: SearchParameter.url
-
SP_TARGET
public static final String SP_TARGET
Search parameter: targetDescription: 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 targetDescription: Types of resource (if a resource reference)
Type: token
Path: SearchParameter.target
-
SP_COMPONENT
public static final String SP_COMPONENT
Search parameter: componentDescription: 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 componentDescription: 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: nameDescription: 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 nameDescription: Computationally friendly name of the search parameter
Type: string
Path: SearchParameter.name
-
SP_PUBLISHER
public static final String SP_PUBLISHER
Search parameter: publisherDescription: 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 publisherDescription: Name of the publisher of the search parameter
Type: string
Path: SearchParameter.publisher
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: 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 statusDescription: The current status of the search parameter
Type: token
Path: SearchParameter.status
-
SP_BASE
public static final String SP_BASE
Search parameter: baseDescription: 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 baseDescription: The resource type(s) this search parameter applies to
Type: token
Path: SearchParameter.base
-
-
Constructor Detail
-
SearchParameter
public SearchParameter()
Constructor
-
SearchParameter
public SearchParameter(UriType url, StringType name, Enumeration<Enumerations.PublicationStatus> status, CodeType code, Enumeration<Enumerations.SearchParamType> type, MarkdownType description)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType 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. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. The URL SHOULD include the major version of the search parameter. For more information see [Technical and Business Versions](resource.html#versions).). 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 classMetadataResource
-
hasUrl
public boolean hasUrl()
- Overrides:
hasUrl
in classMetadataResource
-
setUrlElement
public SearchParameter setUrlElement(UriType value)
- 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. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. The URL SHOULD include the major version of the search parameter. For more information see [Technical and Business Versions](resource.html#versions).). 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 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. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. The URL SHOULD include the major version of the search parameter. For more information see [Technical and Business Versions](resource.html#versions).
-
setUrl
public SearchParameter setUrl(String value)
- 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. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. The URL SHOULD include the major version of the search parameter. For more information see [Technical and Business Versions](resource.html#versions).
-
getVersionElement
public StringType 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
public boolean hasVersionElement()
- Overrides:
hasVersionElement
in classMetadataResource
-
hasVersion
public boolean hasVersion()
- Overrides:
hasVersion
in classMetadataResource
-
setVersionElement
public SearchParameter setVersionElement(StringType value)
- 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
public String 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
public SearchParameter setVersion(String value)
- 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
public StringType 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
public boolean hasNameElement()
- Overrides:
hasNameElement
in classMetadataResource
-
hasName
public boolean hasName()
- Overrides:
hasName
in classMetadataResource
-
setNameElement
public SearchParameter setNameElement(StringType value)
- 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
public String 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
public SearchParameter setName(String value)
- 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.
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> 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
public boolean hasStatusElement()
- Overrides:
hasStatusElement
in classMetadataResource
-
hasStatus
public boolean hasStatus()
- Overrides:
hasStatus
in classMetadataResource
-
setStatusElement
public SearchParameter setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- 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
public Enumerations.PublicationStatus getStatus()
- Overrides:
getStatus
in classMetadataResource
- 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 classMetadataResource
- Parameters:
value
- The status of this search parameter. Enables tracking the life-cycle of the content.
-
getExperimentalElement
public BooleanType 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
public boolean hasExperimentalElement()
- Overrides:
hasExperimentalElement
in classMetadataResource
-
hasExperimental
public boolean hasExperimental()
- Overrides:
hasExperimental
in classMetadataResource
-
setExperimentalElement
public SearchParameter setExperimentalElement(BooleanType value)
- 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
public boolean 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
public SearchParameter setExperimental(boolean value)
- 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
public DateTimeType getDateElement()
- Overrides:
getDateElement
in classMetadataResource
- Returns:
MetadataResource.date
(The date (and optionally time) when the search parameter was published. The date must change if and 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 classMetadataResource
-
hasDate
public boolean hasDate()
- Overrides:
hasDate
in classMetadataResource
-
setDateElement
public SearchParameter setDateElement(DateTimeType value)
- Overrides:
setDateElement
in classMetadataResource
- Parameters:
value
-MetadataResource.date
(The date (and optionally time) when the search parameter was published. The date must change if and 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 classMetadataResource
- Returns:
- The date (and optionally time) when the search parameter was published. The date must change if and 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 classMetadataResource
- Parameters:
value
- The date (and optionally time) when the search parameter was published. The date must change if and 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 classMetadataResource
- Returns:
MetadataResource.publisher
(The name of the individual or organization 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 classMetadataResource
-
hasPublisher
public boolean hasPublisher()
- Overrides:
hasPublisher
in classMetadataResource
-
setPublisherElement
public SearchParameter setPublisherElement(StringType value)
- Overrides:
setPublisherElement
in classMetadataResource
- Parameters:
value
-MetadataResource.publisher
(The name of the individual or organization 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 classMetadataResource
- Returns:
- The name of the individual or organization that published the search parameter.
-
setPublisher
public SearchParameter setPublisher(String value)
- Overrides:
setPublisher
in classMetadataResource
- Parameters:
value
- The name of the individual or organization that published the search parameter.
-
getContact
public List<ContactDetail> getContact()
- Overrides:
getContact
in classMetadataResource
- 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 classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
public boolean hasContact()
- Overrides:
hasContact
in classMetadataResource
-
addContact
public ContactDetail addContact()
- Overrides:
addContact
in classMetadataResource
-
addContact
public SearchParameter addContact(ContactDetail t)
- Overrides:
addContact
in classMetadataResource
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Overrides:
getContactFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.contact
, creating it if it does not already exist
-
getUseContext
public List<UsageContext> 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 terms may be used to assist with indexing and searching for appropriate search parameter instances.)
-
setUseContext
public SearchParameter setUseContext(List<UsageContext> theUseContext)
- Overrides:
setUseContext
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUseContext
public boolean hasUseContext()
- Overrides:
hasUseContext
in classMetadataResource
-
addUseContext
public UsageContext addUseContext()
- Overrides:
addUseContext
in classMetadataResource
-
addUseContext
public SearchParameter addUseContext(UsageContext t)
- Overrides:
addUseContext
in classMetadataResource
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Overrides:
getUseContextFirstRep
in classMetadataResource
- 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 classMetadataResource
- 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 classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
- Overrides:
hasJurisdiction
in classMetadataResource
-
addJurisdiction
public CodeableConcept addJurisdiction()
- Overrides:
addJurisdiction
in classMetadataResource
-
addJurisdiction
public SearchParameter addJurisdiction(CodeableConcept t)
- Overrides:
addJurisdiction
in classMetadataResource
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Overrides:
getJurisdictionFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.jurisdiction
, creating it if it does not already exist
-
getPurposeElement
public MarkdownType getPurposeElement()
- Returns:
purpose
(Explaination 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
(Explaination 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:
- Explaination of why this search parameter is needed and why it has been designed as it has.
-
setPurpose
public SearchParameter setPurpose(String value)
- Parameters:
value
- Explaination 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 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 SearchParameter 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 SearchParameter setType(Enumerations.SearchParamType value)
- Parameters:
value
- The type of value a search parameter refers to, and how the content is interpreted.
-
getDerivedFromElement
public UriType 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(UriType 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.
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Overrides:
getDescriptionElement
in classMetadataResource
- Returns:
MetadataResource.description
(A free text natural language description of the search parameter from a consumer's perspective. 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 classMetadataResource
-
hasDescription
public boolean hasDescription()
- Overrides:
hasDescription
in classMetadataResource
-
setDescriptionElement
public SearchParameter setDescriptionElement(MarkdownType value)
- Overrides:
setDescriptionElement
in classMetadataResource
- Parameters:
value
-MetadataResource.description
(A free text natural language description of the search parameter from a consumer's perspective. 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 classMetadataResource
- Returns:
- A free text natural language description of the search parameter from a consumer's perspective. and how it used.
-
setDescription
public SearchParameter setDescription(String value)
- Overrides:
setDescription
in classMetadataResource
- Parameters:
value
- A free text natural language description of the search parameter from a consumer's perspective. and how it used.
-
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).)
-
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 classMetadataResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedProperty
in classMetadataResource
- 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
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- 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
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classMetadataResource
-
copy
public SearchParameter copy()
- Specified by:
copy
in classMetadataResource
-
typedCopy
protected SearchParameter typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classMetadataResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classMetadataResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classMetadataResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceType
in classResource
-
-