
Class SearchParameter
- All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement
,ca.uhn.fhir.model.api.IElement
,ca.uhn.fhir.model.api.IResource
,ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions
,Serializable
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseResource
public class SearchParameter extends BaseResource implements ca.uhn.fhir.model.api.IResource
Definition: A search parameter that defines a named search item that can be used to search/filter on a resource.
Requirements:
Profile Definition: http://hl7.org/fhir/profiles/SearchParameter
- See Also:
- Serialized Form
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SearchParameter.Contact
Block class for child element: SearchParameter.contact () -
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.TokenClientParam
BASE
Fluent Client search parameter constant for basestatic ca.uhn.fhir.rest.gclient.TokenClientParam
CODE
Fluent Client search parameter constant for codestatic ca.uhn.fhir.rest.gclient.StringClientParam
DESCRIPTION
Fluent Client search parameter constant for descriptionstatic ca.uhn.fhir.rest.gclient.StringClientParam
NAME
Fluent Client search parameter constant for namestatic String
SP_BASE
Search parameter constant for basestatic String
SP_CODE
Search parameter constant for codestatic String
SP_DESCRIPTION
Search parameter constant for descriptionstatic String
SP_NAME
Search parameter constant for namestatic String
SP_TARGET
Search parameter constant for targetstatic String
SP_TYPE
Search parameter constant for typestatic String
SP_URL
Search parameter constant for urlstatic ca.uhn.fhir.rest.gclient.TokenClientParam
TARGET
Fluent Client search parameter constant for targetstatic 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 urlFields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
Constructors Constructor Description SearchParameter()
-
Method Summary
Modifier and Type Method Description SearchParameter.Contact
addContact()
Adds and returns a new value for contact ()SearchParameter
addContact(SearchParameter.Contact theValue)
Adds a given new value for contact ()ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum>
addTarget()
Add a value for target ()ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum>
addTarget(ResourceTypeEnum theValue)
Add a value for target () using an enumerated type.<T extends ca.uhn.fhir.model.api.IElement>
List<T>getAllPopulatedChildElementsOfType(Class<T> theType)
String
getBase()
Gets the value(s) for base ().ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum>
getBaseElement()
Gets the value(s) for base ().String
getCode()
Gets the value(s) for code ().ca.uhn.fhir.model.primitive.CodeDt
getCodeElement()
Gets the value(s) for code ().List<SearchParameter.Contact>
getContact()
Gets the value(s) for contact ().SearchParameter.Contact
getContactFirstRep()
Gets the first repetition for contact (), creating it if it does not already exist.Date
getDate()
Gets the value(s) for date (when.recorded).ca.uhn.fhir.model.primitive.DateTimeDt
getDateElement()
Gets the value(s) for date (when.recorded).String
getDescription()
Gets the value(s) for description ().ca.uhn.fhir.model.primitive.StringDt
getDescriptionElement()
Gets the value(s) for description ().Boolean
getExperimental()
Gets the value(s) for experimental (class).ca.uhn.fhir.model.primitive.BooleanDt
getExperimentalElement()
Gets the value(s) for experimental (class).String
getName()
Gets the value(s) for name ().ca.uhn.fhir.model.primitive.StringDt
getNameElement()
Gets the value(s) for name ().String
getPublisher()
Gets the value(s) for publisher (who.witness).ca.uhn.fhir.model.primitive.StringDt
getPublisherElement()
Gets the value(s) for publisher (who.witness).String
getRequirements()
Gets the value(s) for requirements (why).ca.uhn.fhir.model.primitive.StringDt
getRequirementsElement()
Gets the value(s) for requirements (why).String
getResourceName()
String
getStatus()
Gets the value(s) for status (status).ca.uhn.fhir.model.primitive.BoundCodeDt<ConformanceResourceStatusEnum>
getStatusElement()
Gets the value(s) for status (status).ca.uhn.fhir.context.FhirVersionEnum
getStructureFhirVersionEnum()
List<ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum>>
getTarget()
Gets the value(s) for target ().ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum>
getTargetFirstRep()
Gets the first repetition for target (), creating it if it does not already exist.String
getType()
Gets the value(s) for type ().ca.uhn.fhir.model.primitive.BoundCodeDt<SearchParamTypeEnum>
getTypeElement()
Gets the value(s) for type ().String
getUrl()
Gets the value(s) for url (id).ca.uhn.fhir.model.primitive.UriDt
getUrlElement()
Gets the value(s) for url (id).String
getXpath()
Gets the value(s) for xpath ().ca.uhn.fhir.model.primitive.StringDt
getXpathElement()
Gets the value(s) for xpath ().String
getXpathUsage()
Gets the value(s) for xpathUsage ().ca.uhn.fhir.model.primitive.BoundCodeDt<XPathUsageTypeEnum>
getXpathUsageElement()
Gets the value(s) for xpathUsage ().boolean
isEmpty()
SearchParameter
setBase(ResourceTypeEnum theValue)
Sets the value(s) for base ()SearchParameter
setBase(ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum> theValue)
Sets the value(s) for base ()SearchParameter
setCode(ca.uhn.fhir.model.primitive.CodeDt theValue)
Sets the value(s) for code ()SearchParameter
setCode(String theCode)
Sets the value for code ()SearchParameter
setContact(List<SearchParameter.Contact> theValue)
Sets the value(s) for contact ()SearchParameter
setDate(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
Sets the value(s) for date (when.recorded)SearchParameter
setDate(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
Sets the value for date (when.recorded)SearchParameter
setDateWithSecondsPrecision(Date theDate)
Sets the value for date (when.recorded)SearchParameter
setDescription(ca.uhn.fhir.model.primitive.StringDt theValue)
Sets the value(s) for description ()SearchParameter
setDescription(String theString)
Sets the value for description ()SearchParameter
setExperimental(boolean theBoolean)
Sets the value for experimental (class)SearchParameter
setExperimental(ca.uhn.fhir.model.primitive.BooleanDt theValue)
Sets the value(s) for experimental (class)SearchParameter
setName(ca.uhn.fhir.model.primitive.StringDt theValue)
Sets the value(s) for name ()SearchParameter
setName(String theString)
Sets the value for name ()SearchParameter
setPublisher(ca.uhn.fhir.model.primitive.StringDt theValue)
Sets the value(s) for publisher (who.witness)SearchParameter
setPublisher(String theString)
Sets the value for publisher (who.witness)SearchParameter
setRequirements(ca.uhn.fhir.model.primitive.StringDt theValue)
Sets the value(s) for requirements (why)SearchParameter
setRequirements(String theString)
Sets the value for requirements (why)SearchParameter
setStatus(ConformanceResourceStatusEnum theValue)
Sets the value(s) for status (status)SearchParameter
setStatus(ca.uhn.fhir.model.primitive.BoundCodeDt<ConformanceResourceStatusEnum> theValue)
Sets the value(s) for status (status)SearchParameter
setTarget(ResourceTypeEnum theValue)
Sets the value(s), and clears any existing value(s) for target ()SearchParameter
setTarget(List<ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum>> theValue)
Sets the value(s) for target ()SearchParameter
setType(SearchParamTypeEnum theValue)
Sets the value(s) for type ()SearchParameter
setType(ca.uhn.fhir.model.primitive.BoundCodeDt<SearchParamTypeEnum> theValue)
Sets the value(s) for type ()SearchParameter
setUrl(ca.uhn.fhir.model.primitive.UriDt theValue)
Sets the value(s) for url (id)SearchParameter
setUrl(String theUri)
Sets the value for url (id)SearchParameter
setXpath(ca.uhn.fhir.model.primitive.StringDt theValue)
Sets the value(s) for xpath ()SearchParameter
setXpath(String theString)
Sets the value for xpath ()SearchParameter
setXpathUsage(XPathUsageTypeEnum theValue)
Sets the value(s) for xpathUsage ()SearchParameter
setXpathUsage(ca.uhn.fhir.model.primitive.BoundCodeDt<XPathUsageTypeEnum> theValue)
Sets the value(s) for xpathUsage ()Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getMeta, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString
Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, setUserData
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.IBase
fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId
Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getMeta, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata
-
Field Details
-
SP_URL
Search parameter constant for urlDescription:
Type: uri
Path: SearchParameter.url
- See Also:
- Constant Field Values
-
URL
Fluent Client search parameter constant for urlDescription:
Type: uri
Path: SearchParameter.url
-
SP_NAME
Search parameter constant for nameDescription:
Type: string
Path: SearchParameter.name
- See Also:
- Constant Field Values
-
NAME
Fluent Client search parameter constant for nameDescription:
Type: string
Path: SearchParameter.name
-
SP_BASE
Search parameter constant for baseDescription:
Type: token
Path: SearchParameter.base
- See Also:
- Constant Field Values
-
BASE
Fluent Client search parameter constant for baseDescription:
Type: token
Path: SearchParameter.base
-
SP_TYPE
Search parameter constant for typeDescription:
Type: token
Path: SearchParameter.type
- See Also:
- Constant Field Values
-
TYPE
Fluent Client search parameter constant for typeDescription:
Type: token
Path: SearchParameter.type
-
SP_DESCRIPTION
Search parameter constant for descriptionDescription:
Type: string
Path: SearchParameter.description
- See Also:
- Constant Field Values
-
DESCRIPTION
Fluent Client search parameter constant for descriptionDescription:
Type: string
Path: SearchParameter.description
-
SP_TARGET
Search parameter constant for targetDescription:
Type: token
Path: SearchParameter.target
- See Also:
- Constant Field Values
-
TARGET
Fluent Client search parameter constant for targetDescription:
Type: token
Path: SearchParameter.target
-
SP_CODE
Search parameter constant for codeDescription:
Type: token
Path: SearchParameter.code
- See Also:
- Constant Field Values
-
CODE
Fluent Client search parameter constant for codeDescription:
Type: token
Path: SearchParameter.code
-
-
Constructor Details
-
SearchParameter
public SearchParameter()
-
-
Method Details
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
-
getAllPopulatedChildElementsOfType
public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)- Specified by:
getAllPopulatedChildElementsOfType
in interfaceca.uhn.fhir.model.api.ICompositeElement
-
getUrlElement
Gets the value(s) for url (id). creating it if it does not exist. Will not returnnull
.Definition: An absolute URL 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
-
getUrl
Gets the value(s) for url (id). creating it if it does not exist. This method may returnnull
.Definition: An absolute URL 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
-
setUrl
Sets the value(s) for url (id)Definition: An absolute URL 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
-
setUrl
Sets the value for url (id)Definition: An absolute URL 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
-
getNameElement
Gets the value(s) for name (). creating it if it does not exist. Will not returnnull
.Definition: A free text natural language name identifying the search parameter
-
getName
Gets the value(s) for name (). creating it if it does not exist. This method may returnnull
.Definition: A free text natural language name identifying the search parameter
-
setName
Sets the value(s) for name ()Definition: A free text natural language name identifying the search parameter
-
setName
Sets the value for name ()Definition: A free text natural language name identifying the search parameter
-
getStatusElement
Gets the value(s) for status (status). creating it if it does not exist. Will not returnnull
.Definition: The status of this search parameter definition
-
getStatus
Gets the value(s) for status (status). creating it if it does not exist. This method may returnnull
.Definition: The status of this search parameter definition
-
setStatus
public SearchParameter setStatus(ca.uhn.fhir.model.primitive.BoundCodeDt<ConformanceResourceStatusEnum> theValue)Sets the value(s) for status (status)Definition: The status of this search parameter definition
-
setStatus
Sets the value(s) for status (status)Definition: The status of this search parameter definition
-
getExperimentalElement
Gets the value(s) for experimental (class). creating it if it does not exist. Will not returnnull
.Definition: A flag to indicate that this search parameter definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage
-
getExperimental
Gets the value(s) for experimental (class). creating it if it does not exist. This method may returnnull
.Definition: A flag to indicate that this search parameter definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage
-
setExperimental
Sets the value(s) for experimental (class)Definition: A flag to indicate that this search parameter definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage
-
setExperimental
Sets the value for experimental (class)Definition: A flag to indicate that this search parameter definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage
-
getPublisherElement
Gets the value(s) for publisher (who.witness). creating it if it does not exist. Will not returnnull
.Definition: The name of the individual or organization that published the search parameter
-
getPublisher
Gets the value(s) for publisher (who.witness). creating it if it does not exist. This method may returnnull
.Definition: The name of the individual or organization that published the search parameter
-
setPublisher
Sets the value(s) for publisher (who.witness)Definition: The name of the individual or organization that published the search parameter
-
setPublisher
Sets the value for publisher (who.witness)Definition: The name of the individual or organization that published the search parameter
-
getContact
Gets the value(s) for contact (). creating it if it does not exist. Will not returnnull
.Definition: Contacts to assist a user in finding and communicating with the publisher
-
setContact
Sets the value(s) for contact ()Definition: Contacts to assist a user in finding and communicating with the publisher
-
addContact
Adds and returns a new value for contact ()Definition: Contacts to assist a user in finding and communicating with the publisher
-
addContact
Adds a given new value for contact ()Definition: Contacts to assist a user in finding and communicating with the publisher
- Parameters:
theValue
- The contact to add (must not benull
)
-
getContactFirstRep
Gets the first repetition for contact (), creating it if it does not already exist.Definition: Contacts to assist a user in finding and communicating with the publisher
-
getDateElement
Gets the value(s) for date (when.recorded). creating it if it does not exist. Will not returnnull
.Definition: The date (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes
-
getDate
Gets the value(s) for date (when.recorded). creating it if it does not exist. This method may returnnull
.Definition: The date (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes
-
setDate
Sets the value(s) for date (when.recorded)Definition: The date (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, 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 theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)Sets the value for date (when.recorded)Definition: The date (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes
-
setDateWithSecondsPrecision
Sets the value for date (when.recorded)Definition: The date (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes
-
getRequirementsElement
Gets the value(s) for requirements (why). creating it if it does not exist. Will not returnnull
.Definition: The Scope and Usage that this search parameter was created to meet
-
getRequirements
Gets the value(s) for requirements (why). creating it if it does not exist. This method may returnnull
.Definition: The Scope and Usage that this search parameter was created to meet
-
setRequirements
Sets the value(s) for requirements (why)Definition: The Scope and Usage that this search parameter was created to meet
-
setRequirements
Sets the value for requirements (why)Definition: The Scope and Usage that this search parameter was created to meet
-
getCodeElement
Gets the value(s) for code (). creating it if it does not exist. Will not returnnull
.Definition: The code used in the URL or the parameter name in a parameters resource for this search parameter
-
getCode
Gets the value(s) for code (). creating it if it does not exist. This method may returnnull
.Definition: The code used in the URL or the parameter name in a parameters resource for this search parameter
-
setCode
Sets the value(s) for code ()Definition: The code used in the URL or the parameter name in a parameters resource for this search parameter
-
setCode
Sets the value for code ()Definition: The code used in the URL or the parameter name in a parameters resource for this search parameter
-
getBaseElement
Gets the value(s) for base (). creating it if it does not exist. Will not returnnull
.Definition: The base resource type that this search parameter refers to
-
getBase
Gets the value(s) for base (). creating it if it does not exist. This method may returnnull
.Definition: The base resource type that this search parameter refers to
-
setBase
Sets the value(s) for base ()Definition: The base resource type that this search parameter refers to
-
setBase
Sets the value(s) for base ()Definition: The base resource type that this search parameter refers to
-
getTypeElement
Gets the value(s) for type (). creating it if it does not exist. Will not returnnull
.Definition: The type of value a search parameter refers to, and how the content is interpreted
-
getType
Gets the value(s) for type (). creating it if it does not exist. This method may returnnull
.Definition: The type of value a search parameter refers to, and how the content is interpreted
-
setType
public SearchParameter setType(ca.uhn.fhir.model.primitive.BoundCodeDt<SearchParamTypeEnum> theValue)Sets the value(s) for type ()Definition: The type of value a search parameter refers to, and how the content is interpreted
-
setType
Sets the value(s) for type ()Definition: The type of value a search parameter refers to, and how the content is interpreted
-
getDescriptionElement
Gets the value(s) for description (). creating it if it does not exist. Will not returnnull
.Definition: A description of the search parameters and how it used
-
getDescription
Gets the value(s) for description (). creating it if it does not exist. This method may returnnull
.Definition: A description of the search parameters and how it used
-
setDescription
Sets the value(s) for description ()Definition: A description of the search parameters and how it used
-
setDescription
Sets the value for description ()Definition: A description of the search parameters and how it used
-
getXpathElement
Gets the value(s) for xpath (). creating it if it does not exist. Will not returnnull
.Definition: An XPath expression that returns a set of elements for the search parameter
-
getXpath
Gets the value(s) for xpath (). creating it if it does not exist. This method may returnnull
.Definition: An XPath expression that returns a set of elements for the search parameter
-
setXpath
Sets the value(s) for xpath ()Definition: An XPath expression that returns a set of elements for the search parameter
-
setXpath
Sets the value for xpath ()Definition: An XPath expression that returns a set of elements for the search parameter
-
getXpathUsageElement
Gets the value(s) for xpathUsage (). creating it if it does not exist. Will not returnnull
.Definition: How the search parameter relates to the set of elements returned by evaluating the xpath query
-
getXpathUsage
Gets the value(s) for xpathUsage (). creating it if it does not exist. This method may returnnull
.Definition: How the search parameter relates to the set of elements returned by evaluating the xpath query
-
setXpathUsage
public SearchParameter setXpathUsage(ca.uhn.fhir.model.primitive.BoundCodeDt<XPathUsageTypeEnum> theValue)Sets the value(s) for xpathUsage ()Definition: How the search parameter relates to the set of elements returned by evaluating the xpath query
-
setXpathUsage
Sets the value(s) for xpathUsage ()Definition: How the search parameter relates to the set of elements returned by evaluating the xpath query
-
getTarget
Gets the value(s) for target (). creating it if it does not exist. Will not returnnull
.Definition: Types of resource (if a resource is referenced)
-
setTarget
public SearchParameter setTarget(List<ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum>> theValue)Sets the value(s) for target ()Definition: Types of resource (if a resource is referenced)
-
addTarget
public ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum> addTarget(ResourceTypeEnum theValue)Add a value for target () using an enumerated type. This is intended as a convenience method for situations where the FHIR defined ValueSets are mandatory or contain the desirable codes. If you wish to use codes other than those which are built-in, you may also use theaddTarget()
method.Definition: Types of resource (if a resource is referenced)
-
getTargetFirstRep
Gets the first repetition for target (), creating it if it does not already exist.Definition: Types of resource (if a resource is referenced)
-
addTarget
Add a value for target ()Definition: Types of resource (if a resource is referenced)
-
setTarget
Sets the value(s), and clears any existing value(s) for target ()Definition: Types of resource (if a resource is referenced)
-
getResourceName
- Specified by:
getResourceName
in interfaceca.uhn.fhir.model.api.IResource
-
getStructureFhirVersionEnum
- Specified by:
getStructureFhirVersionEnum
in interfaceorg.hl7.fhir.instance.model.api.IBaseResource
- Specified by:
getStructureFhirVersionEnum
in interfaceca.uhn.fhir.model.api.IResource
-