public class SearchParameter extends BaseResource implements 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
Modifier and Type | Class and Description |
---|---|
static class |
SearchParameter.Contact
Block class for child element: SearchParameter.contact ()
|
Modifier and Type | Field and Description |
---|---|
static TokenClientParam |
BASE
Fluent Client search parameter constant for base
|
static TokenClientParam |
CODE
Fluent Client search parameter constant for code
|
static StringClientParam |
DESCRIPTION
Fluent Client search parameter constant for description
|
static StringClientParam |
NAME
Fluent Client search parameter constant for name
|
static String |
SP_BASE
Search parameter constant for base
|
static String |
SP_CODE
Search parameter constant for code
|
static String |
SP_DESCRIPTION
Search parameter constant for description
|
static String |
SP_NAME
Search parameter constant for name
|
static String |
SP_TARGET
Search parameter constant for target
|
static String |
SP_TYPE
Search parameter constant for type
|
static String |
SP_URL
Search parameter constant for url
|
static TokenClientParam |
TARGET
Fluent Client search parameter constant for target
|
static TokenClientParam |
TYPE
Fluent Client search parameter constant for type
|
static UriClientParam |
URL
Fluent Client search parameter constant for url
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGE
INCLUDE_ALL, WILDCARD_ALL_SET
Constructor and Description |
---|
SearchParameter() |
Modifier and Type | Method and Description |
---|---|
SearchParameter.Contact |
addContact()
Adds and returns a new value for contact ()
|
SearchParameter |
addContact(SearchParameter.Contact theValue)
Adds a given new value for contact ()
|
BoundCodeDt<ResourceTypeEnum> |
addTarget()
Add a value for target ()
|
BoundCodeDt<ResourceTypeEnum> |
addTarget(ResourceTypeEnum theValue)
Add a value for target () using an enumerated type.
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType) |
String |
getBase()
Gets the value(s) for base ().
|
BoundCodeDt<ResourceTypeEnum> |
getBaseElement()
Gets the value(s) for base ().
|
String |
getCode()
Gets the value(s) for code ().
|
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).
|
DateTimeDt |
getDateElement()
Gets the value(s) for date (when.recorded).
|
String |
getDescription()
Gets the value(s) for description ().
|
StringDt |
getDescriptionElement()
Gets the value(s) for description ().
|
Boolean |
getExperimental()
Gets the value(s) for experimental (class).
|
BooleanDt |
getExperimentalElement()
Gets the value(s) for experimental (class).
|
String |
getName()
Gets the value(s) for name ().
|
StringDt |
getNameElement()
Gets the value(s) for name ().
|
String |
getPublisher()
Gets the value(s) for publisher (who.witness).
|
StringDt |
getPublisherElement()
Gets the value(s) for publisher (who.witness).
|
String |
getRequirements()
Gets the value(s) for requirements (why).
|
StringDt |
getRequirementsElement()
Gets the value(s) for requirements (why).
|
String |
getResourceName() |
String |
getStatus()
Gets the value(s) for status (status).
|
BoundCodeDt<ConformanceResourceStatusEnum> |
getStatusElement()
Gets the value(s) for status (status).
|
FhirVersionEnum |
getStructureFhirVersionEnum() |
List<BoundCodeDt<ResourceTypeEnum>> |
getTarget()
Gets the value(s) for target ().
|
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 ().
|
BoundCodeDt<SearchParamTypeEnum> |
getTypeElement()
Gets the value(s) for type ().
|
String |
getUrl()
Gets the value(s) for url (id).
|
UriDt |
getUrlElement()
Gets the value(s) for url (id).
|
String |
getXpath()
Gets the value(s) for xpath ().
|
StringDt |
getXpathElement()
Gets the value(s) for xpath ().
|
String |
getXpathUsage()
Gets the value(s) for xpathUsage ().
|
BoundCodeDt<XPathUsageTypeEnum> |
getXpathUsageElement()
Gets the value(s) for xpathUsage ().
|
boolean |
isEmpty() |
SearchParameter |
setBase(BoundCodeDt<ResourceTypeEnum> theValue)
Sets the value(s) for base ()
|
SearchParameter |
setBase(ResourceTypeEnum theValue)
Sets the value(s) for base ()
|
SearchParameter |
setCode(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(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for date (when.recorded)
|
SearchParameter |
setDate(DateTimeDt theValue)
Sets the value(s) for date (when.recorded)
|
SearchParameter |
setDateWithSecondsPrecision(Date theDate)
Sets the value for date (when.recorded)
|
SearchParameter |
setDescription(String theString)
Sets the value for description ()
|
SearchParameter |
setDescription(StringDt theValue)
Sets the value(s) for description ()
|
SearchParameter |
setExperimental(boolean theBoolean)
Sets the value for experimental (class)
|
SearchParameter |
setExperimental(BooleanDt theValue)
Sets the value(s) for experimental (class)
|
SearchParameter |
setName(String theString)
Sets the value for name ()
|
SearchParameter |
setName(StringDt theValue)
Sets the value(s) for name ()
|
SearchParameter |
setPublisher(String theString)
Sets the value for publisher (who.witness)
|
SearchParameter |
setPublisher(StringDt theValue)
Sets the value(s) for publisher (who.witness)
|
SearchParameter |
setRequirements(String theString)
Sets the value for requirements (why)
|
SearchParameter |
setRequirements(StringDt theValue)
Sets the value(s) for requirements (why)
|
SearchParameter |
setStatus(BoundCodeDt<ConformanceResourceStatusEnum> theValue)
Sets the value(s) for status (status)
|
SearchParameter |
setStatus(ConformanceResourceStatusEnum theValue)
Sets the value(s) for status (status)
|
SearchParameter |
setTarget(List<BoundCodeDt<ResourceTypeEnum>> theValue)
Sets the value(s) for target ()
|
SearchParameter |
setTarget(ResourceTypeEnum theValue)
Sets the value(s), and clears any existing value(s) for target ()
|
SearchParameter |
setType(BoundCodeDt<SearchParamTypeEnum> theValue)
Sets the value(s) for type ()
|
SearchParameter |
setType(SearchParamTypeEnum theValue)
Sets the value(s) for type ()
|
SearchParameter |
setUrl(String theUri)
Sets the value for url (id)
|
SearchParameter |
setUrl(UriDt theValue)
Sets the value(s) for url (id)
|
SearchParameter |
setXpath(String theString)
Sets the value for xpath ()
|
SearchParameter |
setXpath(StringDt theValue)
Sets the value(s) for xpath ()
|
SearchParameter |
setXpathUsage(BoundCodeDt<XPathUsageTypeEnum> theValue)
Sets the value(s) for xpathUsage ()
|
SearchParameter |
setXpathUsage(XPathUsageTypeEnum theValue)
Sets the value(s) for xpathUsage ()
|
getContained, getId, getIdElement, getLanguage, getMeta, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, hasFormatComment
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getContained, getId, getLanguage, getMeta, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata
getIdElement, setId, setId
public static final String SP_URL
Description:
Type: uri
Path: SearchParameter.url
public static final UriClientParam URL
Description:
Type: uri
Path: SearchParameter.url
public static final String SP_NAME
Description:
Type: string
Path: SearchParameter.name
public static final StringClientParam NAME
Description:
Type: string
Path: SearchParameter.name
public static final String SP_BASE
Description:
Type: token
Path: SearchParameter.base
public static final TokenClientParam BASE
Description:
Type: token
Path: SearchParameter.base
public static final String SP_TYPE
Description:
Type: token
Path: SearchParameter.type
public static final TokenClientParam TYPE
Description:
Type: token
Path: SearchParameter.type
public static final String SP_DESCRIPTION
Description:
Type: string
Path: SearchParameter.description
public static final StringClientParam DESCRIPTION
Description:
Type: string
Path: SearchParameter.description
public static final String SP_TARGET
Description:
Type: token
Path: SearchParameter.target
public static final TokenClientParam TARGET
Description:
Type: token
Path: SearchParameter.target
public static final String SP_CODE
Description:
Type: token
Path: SearchParameter.code
public static final TokenClientParam CODE
Description:
Type: token
Path: SearchParameter.code
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType
in interface ICompositeElement
public UriDt getUrlElement()
null
.
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
public String getUrl()
null
.
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
public SearchParameter setUrl(UriDt theValue)
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
public SearchParameter setUrl(String theUri)
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
public StringDt getNameElement()
null
.
Definition: A free text natural language name identifying the search parameter
public String getName()
null
.
Definition: A free text natural language name identifying the search parameter
public SearchParameter setName(StringDt theValue)
Definition: A free text natural language name identifying the search parameter
public SearchParameter setName(String theString)
Definition: A free text natural language name identifying the search parameter
public BoundCodeDt<ConformanceResourceStatusEnum> getStatusElement()
null
.
Definition: The status of this search parameter definition
public String getStatus()
null
.
Definition: The status of this search parameter definition
public SearchParameter setStatus(BoundCodeDt<ConformanceResourceStatusEnum> theValue)
Definition: The status of this search parameter definition
public SearchParameter setStatus(ConformanceResourceStatusEnum theValue)
Definition: The status of this search parameter definition
public BooleanDt getExperimentalElement()
null
.
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
public Boolean getExperimental()
null
.
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
public SearchParameter setExperimental(BooleanDt theValue)
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
public SearchParameter setExperimental(boolean theBoolean)
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
public StringDt getPublisherElement()
null
.
Definition: The name of the individual or organization that published the search parameter
public String getPublisher()
null
.
Definition: The name of the individual or organization that published the search parameter
public SearchParameter setPublisher(StringDt theValue)
Definition: The name of the individual or organization that published the search parameter
public SearchParameter setPublisher(String theString)
Definition: The name of the individual or organization that published the search parameter
public List<SearchParameter.Contact> getContact()
null
.
Definition: Contacts to assist a user in finding and communicating with the publisher
public SearchParameter setContact(List<SearchParameter.Contact> theValue)
Definition: Contacts to assist a user in finding and communicating with the publisher
public SearchParameter.Contact addContact()
Definition: Contacts to assist a user in finding and communicating with the publisher
public SearchParameter addContact(SearchParameter.Contact theValue)
Definition: Contacts to assist a user in finding and communicating with the publisher
theValue
- The contact to add (must not be null
)public SearchParameter.Contact getContactFirstRep()
Definition: Contacts to assist a user in finding and communicating with the publisher
public DateTimeDt getDateElement()
null
.
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
public Date getDate()
null
.
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
public SearchParameter setDate(DateTimeDt theValue)
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
public SearchParameter setDateWithSecondsPrecision(Date theDate)
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
public SearchParameter setDate(Date theDate, TemporalPrecisionEnum thePrecision)
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
public StringDt getRequirementsElement()
null
.
Definition: The Scope and Usage that this search parameter was created to meet
public String getRequirements()
null
.
Definition: The Scope and Usage that this search parameter was created to meet
public SearchParameter setRequirements(StringDt theValue)
Definition: The Scope and Usage that this search parameter was created to meet
public SearchParameter setRequirements(String theString)
Definition: The Scope and Usage that this search parameter was created to meet
public CodeDt getCodeElement()
null
.
Definition: The code used in the URL or the parameter name in a parameters resource for this search parameter
public String getCode()
null
.
Definition: The code used in the URL or the parameter name in a parameters resource for this search parameter
public SearchParameter setCode(CodeDt theValue)
Definition: The code used in the URL or the parameter name in a parameters resource for this search parameter
public SearchParameter setCode(String theCode)
Definition: The code used in the URL or the parameter name in a parameters resource for this search parameter
public BoundCodeDt<ResourceTypeEnum> getBaseElement()
null
.
Definition: The base resource type that this search parameter refers to
public String getBase()
null
.
Definition: The base resource type that this search parameter refers to
public SearchParameter setBase(BoundCodeDt<ResourceTypeEnum> theValue)
Definition: The base resource type that this search parameter refers to
public SearchParameter setBase(ResourceTypeEnum theValue)
Definition: The base resource type that this search parameter refers to
public BoundCodeDt<SearchParamTypeEnum> getTypeElement()
null
.
Definition: The type of value a search parameter refers to, and how the content is interpreted
public String getType()
null
.
Definition: The type of value a search parameter refers to, and how the content is interpreted
public SearchParameter setType(BoundCodeDt<SearchParamTypeEnum> theValue)
Definition: The type of value a search parameter refers to, and how the content is interpreted
public SearchParameter setType(SearchParamTypeEnum theValue)
Definition: The type of value a search parameter refers to, and how the content is interpreted
public StringDt getDescriptionElement()
null
.
Definition: A description of the search parameters and how it used
public String getDescription()
null
.
Definition: A description of the search parameters and how it used
public SearchParameter setDescription(StringDt theValue)
Definition: A description of the search parameters and how it used
public SearchParameter setDescription(String theString)
Definition: A description of the search parameters and how it used
public StringDt getXpathElement()
null
.
Definition: An XPath expression that returns a set of elements for the search parameter
public String getXpath()
null
.
Definition: An XPath expression that returns a set of elements for the search parameter
public SearchParameter setXpath(StringDt theValue)
Definition: An XPath expression that returns a set of elements for the search parameter
public SearchParameter setXpath(String theString)
Definition: An XPath expression that returns a set of elements for the search parameter
public BoundCodeDt<XPathUsageTypeEnum> getXpathUsageElement()
null
.
Definition: How the search parameter relates to the set of elements returned by evaluating the xpath query
public String getXpathUsage()
null
.
Definition: How the search parameter relates to the set of elements returned by evaluating the xpath query
public SearchParameter setXpathUsage(BoundCodeDt<XPathUsageTypeEnum> theValue)
Definition: How the search parameter relates to the set of elements returned by evaluating the xpath query
public SearchParameter setXpathUsage(XPathUsageTypeEnum theValue)
Definition: How the search parameter relates to the set of elements returned by evaluating the xpath query
public List<BoundCodeDt<ResourceTypeEnum>> getTarget()
null
.
Definition: Types of resource (if a resource is referenced)
public SearchParameter setTarget(List<BoundCodeDt<ResourceTypeEnum>> theValue)
Definition: Types of resource (if a resource is referenced)
public BoundCodeDt<ResourceTypeEnum> addTarget(ResourceTypeEnum theValue)
addTarget()
method.
Definition: Types of resource (if a resource is referenced)
public BoundCodeDt<ResourceTypeEnum> getTargetFirstRep()
Definition: Types of resource (if a resource is referenced)
public BoundCodeDt<ResourceTypeEnum> addTarget()
Definition: Types of resource (if a resource is referenced)
public SearchParameter setTarget(ResourceTypeEnum theValue)
Definition: Types of resource (if a resource is referenced)
public String getResourceName()
getResourceName
in interface IResource
public FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum
in interface IResource
getStructureFhirVersionEnum
in interface IBaseResource
Copyright © 2014–2019 University Health Network. All rights reserved.