Class SearchParameter
- java.lang.Object
-
- org.hl7.fhir.r4b.model.Base
-
- org.hl7.fhir.r4b.model.BaseResource
-
- org.hl7.fhir.r4b.model.Resource
-
- org.hl7.fhir.r4b.model.DomainResource
-
- org.hl7.fhir.r4b.model.CanonicalResource
-
- org.hl7.fhir.r4b.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 CanonicalResource
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 classSearchParameter.SearchComparatorstatic classSearchParameter.SearchComparatorEnumFactorystatic classSearchParameter.SearchModifierCodestatic classSearchParameter.SearchModifierCodeEnumFactorystatic classSearchParameter.SearchParameterComponentComponentstatic classSearchParameter.XPathUsageTypestatic classSearchParameter.XPathUsageTypeEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected List<CodeType>baseThe base resource type(s) that this search parameter can be used against.static ca.uhn.fhir.rest.gclient.TokenClientParamBASEFluent Client search parameter constant for baseprotected List<StringType>chainContains the names of any search parameters which may be chained to the containing search parameter.protected CodeTypecodeThe code used in the URL or the parameter name in a parameters resource for this search parameter.static ca.uhn.fhir.rest.gclient.TokenClientParamCODEFluent Client search parameter constant for codeprotected List<Enumeration<SearchParameter.SearchComparator>>comparatorComparators supported for the search parameter.protected List<SearchParameter.SearchParameterComponentComponent>componentUsed to define the parts of a composite search parameter.static ca.uhn.fhir.rest.gclient.ReferenceClientParamCOMPONENTFluent Client search parameter constant for componentprotected List<ContactDetail>contactContact details to assist a user in finding and communicating with the publisher.static ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXTFluent Client search parameter constant for contextstatic ca.uhn.fhir.rest.gclient.QuantityClientParamCONTEXT_QUANTITYFluent Client search parameter constant for context-quantitystatic ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXT_TYPEFluent Client search parameter constant for context-typestatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam>CONTEXT_TYPE_QUANTITYFluent Client search parameter constant for context-type-quantitystatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>CONTEXT_TYPE_VALUEFluent Client search parameter constant for context-type-valueprotected DateTimeTypedateThe date (and optionally time) when the search parameter was published.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for datestatic ca.uhn.fhir.rest.gclient.ReferenceClientParamDERIVED_FROMFluent Client search parameter constant for derived-fromprotected CanonicalTypederivedFromWhere this search parameter is originally defined.protected MarkdownTypedescriptionAnd how it used.static ca.uhn.fhir.rest.gclient.StringClientParamDESCRIPTIONFluent Client search parameter constant for descriptionprotected BooleanTypeexperimentalA 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.protected StringTypeexpressionA FHIRPath expression that returns a set of elements for the search parameter.static ca.uhn.fhir.model.api.IncludeINCLUDE_COMPONENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_DERIVED_FROMConstant for fluent queries to be used to add include statements.protected List<CodeableConcept>jurisdictionA legal or geographic region in which the search parameter is intended to be used.static ca.uhn.fhir.rest.gclient.TokenClientParamJURISDICTIONFluent Client search parameter constant for jurisdictionprotected List<Enumeration<SearchParameter.SearchModifierCode>>modifierA modifier supported for the search parameter.protected BooleanTypemultipleAndWhether multiple parameters are allowed - e.g.protected BooleanTypemultipleOrWhether multiple values are allowed for each time the parameter exists.protected StringTypenameA natural language name identifying the search parameter.static ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for nameprotected StringTypepublisherThe name of the organization or individual that published the search parameter.static ca.uhn.fhir.rest.gclient.StringClientParamPUBLISHERFluent Client search parameter constant for publisherprotected MarkdownTypepurposeExplanation of why this search parameter is needed and why it has been designed as it has.static StringSP_BASESearch parameter: basestatic StringSP_CODESearch parameter: codestatic StringSP_COMPONENTSearch parameter: componentstatic StringSP_CONTEXTSearch parameter: contextstatic StringSP_CONTEXT_QUANTITYSearch parameter: context-quantitystatic StringSP_CONTEXT_TYPESearch parameter: context-typestatic StringSP_CONTEXT_TYPE_QUANTITYSearch parameter: context-type-quantitystatic StringSP_CONTEXT_TYPE_VALUESearch parameter: context-type-valuestatic StringSP_DATESearch parameter: datestatic StringSP_DERIVED_FROMSearch parameter: derived-fromstatic StringSP_DESCRIPTIONSearch parameter: descriptionstatic StringSP_JURISDICTIONSearch parameter: jurisdictionstatic StringSP_NAMESearch parameter: namestatic StringSP_PUBLISHERSearch parameter: publisherstatic StringSP_STATUSSearch parameter: statusstatic StringSP_TARGETSearch parameter: targetstatic StringSP_TYPESearch parameter: typestatic StringSP_URLSearch parameter: urlstatic StringSP_VERSIONSearch parameter: versionprotected Enumeration<Enumerations.PublicationStatus>statusThe status of this search parameter.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected List<CodeType>targetTypes of resource (if a resource is referenced).static ca.uhn.fhir.rest.gclient.TokenClientParamTARGETFluent Client search parameter constant for targetprotected Enumeration<Enumerations.SearchParamType>typeThe type of value that a search parameter may contain, and how the content is interpreted.static ca.uhn.fhir.rest.gclient.TokenClientParamTYPEFluent Client search parameter constant for typeprotected UriTypeurlAn absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier.static ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for urlprotected List<UsageContext>useContextThe content was developed with a focus and intent of supporting the contexts that are listed.protected StringTypeversionThe identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance.static ca.uhn.fhir.rest.gclient.TokenClientParamVERSIONFluent Client search parameter constant for versionprotected StringTypexpathAn XPath expression that returns a set of elements for the search parameter.protected Enumeration<SearchParameter.XPathUsageType>xpathUsageHow the search parameter relates to the set of elements returned by evaluating the xpath query.-
Fields inherited from class org.hl7.fhir.r4b.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
-
Fields inherited from class org.hl7.fhir.r4b.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description SearchParameter()ConstructorSearchParameter(String url, String name, Enumerations.PublicationStatus status, String description, String code, String base, Enumerations.SearchParamType type)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4b.model.CanonicalResource
copyValues, getContactMax, getCopyrightMax, getDateMax, getDescriptionMax, getExperimentalMax, getIdentifierMax, getJurisdictionMax, getNameMax, getPublisherMax, getPurposeMax, getStatusMax, getTitleMax, getUrlMax, getUseContextMax, getVersionedUrl, getVersionMax, getVUrl, present, toString
-
Methods inherited from class org.hl7.fhir.r4b.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4b.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r4b.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4b.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
url
protected UriType url
An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers.
-
version
protected StringType 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.
-
name
protected StringType 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.
-
derivedFrom
protected CanonicalType 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.
-
status
protected Enumeration<Enumerations.PublicationStatus> status
The status of this search parameter. Enables tracking the life-cycle of the content.
-
experimental
protected BooleanType 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.
-
date
protected DateTimeType date
The date (and optionally time) when the search parameter was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.
-
publisher
protected StringType publisher
The name of the organization or individual that published the search parameter.
-
contact
protected List<ContactDetail> contact
Contact details to assist a user in finding and communicating with the publisher.
-
description
protected MarkdownType description
And how it used.
-
useContext
protected List<UsageContext> useContext
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instances.
-
jurisdiction
protected List<CodeableConcept> jurisdiction
A legal or geographic region in which the search parameter is intended to be used.
-
purpose
protected MarkdownType purpose
Explanation 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 that a search parameter may contain, and how the content is interpreted.
-
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.
-
multipleOr
protected BooleanType multipleOr
Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.
-
multipleAnd
protected BooleanType multipleAnd
Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.
-
comparator
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_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
-
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_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_DERIVED_FROM
public static final String SP_DERIVED_FROM
Search parameter: derived-fromDescription: Original definition for the search parameter
Type: reference
Path: SearchParameter.derivedFrom
- See Also:
- Constant Field Values
-
DERIVED_FROM
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DERIVED_FROM
Fluent Client search parameter constant for derived-fromDescription: Original definition for the search parameter
Type: reference
Path: SearchParameter.derivedFrom
-
INCLUDE_DERIVED_FROM
public static final ca.uhn.fhir.model.api.Include INCLUDE_DERIVED_FROM
Constant for fluent queries to be used to add include statements. Specifies the path value of "SearchParameter:derived-from".
-
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_TYPE
public static final String SP_TYPE
Search parameter: typeDescription: number | date | string | token | reference | composite | quantity | uri | special
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 | special
Type: token
Path: SearchParameter.type
-
SP_CONTEXT_QUANTITY
public static final String SP_CONTEXT_QUANTITY
Search parameter: context-quantityDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set
Type: quantity
Path: (CapabilityStatement.useContext.value as Quantity) | (CapabilityStatement.useContext.value as Range) | (CodeSystem.useContext.value as Quantity) | (CodeSystem.useContext.value as Range) | (CompartmentDefinition.useContext.value as Quantity) | (CompartmentDefinition.useContext.value as Range) | (ConceptMap.useContext.value as Quantity) | (ConceptMap.useContext.value as Range) | (GraphDefinition.useContext.value as Quantity) | (GraphDefinition.useContext.value as Range) | (ImplementationGuide.useContext.value as Quantity) | (ImplementationGuide.useContext.value as Range) | (MessageDefinition.useContext.value as Quantity) | (MessageDefinition.useContext.value as Range) | (NamingSystem.useContext.value as Quantity) | (NamingSystem.useContext.value as Range) | (OperationDefinition.useContext.value as Quantity) | (OperationDefinition.useContext.value as Range) | (SearchParameter.useContext.value as Quantity) | (SearchParameter.useContext.value as Range) | (StructureDefinition.useContext.value as Quantity) | (StructureDefinition.useContext.value as Range) | (StructureMap.useContext.value as Quantity) | (StructureMap.useContext.value as Range) | (TerminologyCapabilities.useContext.value as Quantity) | (TerminologyCapabilities.useContext.value as Range) | (ValueSet.useContext.value as Quantity) | (ValueSet.useContext.value as Range)
- See Also:
- Constant Field Values
-
CONTEXT_QUANTITY
public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
Fluent Client search parameter constant for context-quantityDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set
Type: quantity
Path: (CapabilityStatement.useContext.value as Quantity) | (CapabilityStatement.useContext.value as Range) | (CodeSystem.useContext.value as Quantity) | (CodeSystem.useContext.value as Range) | (CompartmentDefinition.useContext.value as Quantity) | (CompartmentDefinition.useContext.value as Range) | (ConceptMap.useContext.value as Quantity) | (ConceptMap.useContext.value as Range) | (GraphDefinition.useContext.value as Quantity) | (GraphDefinition.useContext.value as Range) | (ImplementationGuide.useContext.value as Quantity) | (ImplementationGuide.useContext.value as Range) | (MessageDefinition.useContext.value as Quantity) | (MessageDefinition.useContext.value as Range) | (NamingSystem.useContext.value as Quantity) | (NamingSystem.useContext.value as Range) | (OperationDefinition.useContext.value as Quantity) | (OperationDefinition.useContext.value as Range) | (SearchParameter.useContext.value as Quantity) | (SearchParameter.useContext.value as Range) | (StructureDefinition.useContext.value as Quantity) | (StructureDefinition.useContext.value as Range) | (StructureMap.useContext.value as Quantity) | (StructureMap.useContext.value as Range) | (TerminologyCapabilities.useContext.value as Quantity) | (TerminologyCapabilities.useContext.value as Range) | (ValueSet.useContext.value as Quantity) | (ValueSet.useContext.value as Range)
-
SP_CONTEXT_TYPE_QUANTITY
public static final String SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantityDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set
Type: composite
Path: CapabilityStatement.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | ValueSet.useContext
- See Also:
- Constant Field Values
-
CONTEXT_TYPE_QUANTITY
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
Fluent Client search parameter constant for context-type-quantityDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set
Type: composite
Path: CapabilityStatement.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | ValueSet.useContext
-
SP_CONTEXT_TYPE_VALUE
public static final String SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-valueDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement [CodeSystem](codesystem.html): A use context type and value assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition [StructureMap](structuremap.html): A use context type and value assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities [ValueSet](valueset.html): A use context type and value assigned to the value set
Type: composite
Path: CapabilityStatement.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | ValueSet.useContext
- See Also:
- Constant Field Values
-
CONTEXT_TYPE_VALUE
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
Fluent Client search parameter constant for context-type-valueDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement [CodeSystem](codesystem.html): A use context type and value assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition [StructureMap](structuremap.html): A use context type and value assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities [ValueSet](valueset.html): A use context type and value assigned to the value set
Type: composite
Path: CapabilityStatement.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | ValueSet.useContext
-
SP_CONTEXT_TYPE
public static final String SP_CONTEXT_TYPE
Search parameter: context-typeDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement [CodeSystem](codesystem.html): A type of use context assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition [ConceptMap](conceptmap.html): A type of use context assigned to the concept map [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition [NamingSystem](namingsystem.html): A type of use context assigned to the naming system [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition [StructureMap](structuremap.html): A type of use context assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities [ValueSet](valueset.html): A type of use context assigned to the value set
Type: token
Path: CapabilityStatement.useContext.code | CodeSystem.useContext.code | CompartmentDefinition.useContext.code | ConceptMap.useContext.code | GraphDefinition.useContext.code | ImplementationGuide.useContext.code | MessageDefinition.useContext.code | NamingSystem.useContext.code | OperationDefinition.useContext.code | SearchParameter.useContext.code | StructureDefinition.useContext.code | StructureMap.useContext.code | TerminologyCapabilities.useContext.code | ValueSet.useContext.code
- See Also:
- Constant Field Values
-
CONTEXT_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
Fluent Client search parameter constant for context-typeDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement [CodeSystem](codesystem.html): A type of use context assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition [ConceptMap](conceptmap.html): A type of use context assigned to the concept map [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition [NamingSystem](namingsystem.html): A type of use context assigned to the naming system [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition [StructureMap](structuremap.html): A type of use context assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities [ValueSet](valueset.html): A type of use context assigned to the value set
Type: token
Path: CapabilityStatement.useContext.code | CodeSystem.useContext.code | CompartmentDefinition.useContext.code | ConceptMap.useContext.code | GraphDefinition.useContext.code | ImplementationGuide.useContext.code | MessageDefinition.useContext.code | NamingSystem.useContext.code | OperationDefinition.useContext.code | SearchParameter.useContext.code | StructureDefinition.useContext.code | StructureMap.useContext.code | TerminologyCapabilities.useContext.code | ValueSet.useContext.code
-
SP_CONTEXT
public static final String SP_CONTEXT
Search parameter: contextDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement [CodeSystem](codesystem.html): A use context assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition [ConceptMap](conceptmap.html): A use context assigned to the concept map [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide [MessageDefinition](messagedefinition.html): A use context assigned to the message definition [NamingSystem](namingsystem.html): A use context assigned to the naming system [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition [SearchParameter](searchparameter.html): A use context assigned to the search parameter [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition [StructureMap](structuremap.html): A use context assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities [ValueSet](valueset.html): A use context assigned to the value set
Type: token
Path: (CapabilityStatement.useContext.value as CodeableConcept) | (CodeSystem.useContext.value as CodeableConcept) | (CompartmentDefinition.useContext.value as CodeableConcept) | (ConceptMap.useContext.value as CodeableConcept) | (GraphDefinition.useContext.value as CodeableConcept) | (ImplementationGuide.useContext.value as CodeableConcept) | (MessageDefinition.useContext.value as CodeableConcept) | (NamingSystem.useContext.value as CodeableConcept) | (OperationDefinition.useContext.value as CodeableConcept) | (SearchParameter.useContext.value as CodeableConcept) | (StructureDefinition.useContext.value as CodeableConcept) | (StructureMap.useContext.value as CodeableConcept) | (TerminologyCapabilities.useContext.value as CodeableConcept) | (ValueSet.useContext.value as CodeableConcept)
- See Also:
- Constant Field Values
-
CONTEXT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
Fluent Client search parameter constant for contextDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement [CodeSystem](codesystem.html): A use context assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition [ConceptMap](conceptmap.html): A use context assigned to the concept map [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide [MessageDefinition](messagedefinition.html): A use context assigned to the message definition [NamingSystem](namingsystem.html): A use context assigned to the naming system [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition [SearchParameter](searchparameter.html): A use context assigned to the search parameter [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition [StructureMap](structuremap.html): A use context assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities [ValueSet](valueset.html): A use context assigned to the value set
Type: token
Path: (CapabilityStatement.useContext.value as CodeableConcept) | (CodeSystem.useContext.value as CodeableConcept) | (CompartmentDefinition.useContext.value as CodeableConcept) | (ConceptMap.useContext.value as CodeableConcept) | (GraphDefinition.useContext.value as CodeableConcept) | (ImplementationGuide.useContext.value as CodeableConcept) | (MessageDefinition.useContext.value as CodeableConcept) | (NamingSystem.useContext.value as CodeableConcept) | (OperationDefinition.useContext.value as CodeableConcept) | (SearchParameter.useContext.value as CodeableConcept) | (StructureDefinition.useContext.value as CodeableConcept) | (StructureMap.useContext.value as CodeableConcept) | (TerminologyCapabilities.useContext.value as CodeableConcept) | (ValueSet.useContext.value as CodeableConcept)
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The capability statement publication date [CodeSystem](codesystem.html): The code system publication date [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date [ConceptMap](conceptmap.html): The concept map publication date [GraphDefinition](graphdefinition.html): The graph definition publication date [ImplementationGuide](implementationguide.html): The implementation guide publication date [MessageDefinition](messagedefinition.html): The message definition publication date [NamingSystem](namingsystem.html): The naming system publication date [OperationDefinition](operationdefinition.html): The operation definition publication date [SearchParameter](searchparameter.html): The search parameter publication date [StructureDefinition](structuredefinition.html): The structure definition publication date [StructureMap](structuremap.html): The structure map publication date [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date [ValueSet](valueset.html): The value set publication date
Type: date
Path: CapabilityStatement.date | CodeSystem.date | CompartmentDefinition.date | ConceptMap.date | GraphDefinition.date | ImplementationGuide.date | MessageDefinition.date | NamingSystem.date | OperationDefinition.date | SearchParameter.date | StructureDefinition.date | StructureMap.date | TerminologyCapabilities.date | ValueSet.date
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The capability statement publication date [CodeSystem](codesystem.html): The code system publication date [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date [ConceptMap](conceptmap.html): The concept map publication date [GraphDefinition](graphdefinition.html): The graph definition publication date [ImplementationGuide](implementationguide.html): The implementation guide publication date [MessageDefinition](messagedefinition.html): The message definition publication date [NamingSystem](namingsystem.html): The naming system publication date [OperationDefinition](operationdefinition.html): The operation definition publication date [SearchParameter](searchparameter.html): The search parameter publication date [StructureDefinition](structuredefinition.html): The structure definition publication date [StructureMap](structuremap.html): The structure map publication date [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date [ValueSet](valueset.html): The value set publication date
Type: date
Path: CapabilityStatement.date | CodeSystem.date | CompartmentDefinition.date | ConceptMap.date | GraphDefinition.date | ImplementationGuide.date | MessageDefinition.date | NamingSystem.date | OperationDefinition.date | SearchParameter.date | StructureDefinition.date | StructureMap.date | TerminologyCapabilities.date | ValueSet.date
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
Search parameter: descriptionDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The description of the capability statement [CodeSystem](codesystem.html): The description of the code system [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition [ConceptMap](conceptmap.html): The description of the concept map [GraphDefinition](graphdefinition.html): The description of the graph definition [ImplementationGuide](implementationguide.html): The description of the implementation guide [MessageDefinition](messagedefinition.html): The description of the message definition [NamingSystem](namingsystem.html): The description of the naming system [OperationDefinition](operationdefinition.html): The description of the operation definition [SearchParameter](searchparameter.html): The description of the search parameter [StructureDefinition](structuredefinition.html): The description of the structure definition [StructureMap](structuremap.html): The description of the structure map [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities [ValueSet](valueset.html): The description of the value set
Type: string
Path: CapabilityStatement.description | CodeSystem.description | CompartmentDefinition.description | ConceptMap.description | GraphDefinition.description | ImplementationGuide.description | MessageDefinition.description | NamingSystem.description | OperationDefinition.description | SearchParameter.description | StructureDefinition.description | StructureMap.description | TerminologyCapabilities.description | ValueSet.description
- See Also:
- Constant Field Values
-
DESCRIPTION
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The description of the capability statement [CodeSystem](codesystem.html): The description of the code system [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition [ConceptMap](conceptmap.html): The description of the concept map [GraphDefinition](graphdefinition.html): The description of the graph definition [ImplementationGuide](implementationguide.html): The description of the implementation guide [MessageDefinition](messagedefinition.html): The description of the message definition [NamingSystem](namingsystem.html): The description of the naming system [OperationDefinition](operationdefinition.html): The description of the operation definition [SearchParameter](searchparameter.html): The description of the search parameter [StructureDefinition](structuredefinition.html): The description of the structure definition [StructureMap](structuremap.html): The description of the structure map [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities [ValueSet](valueset.html): The description of the value set
Type: string
Path: CapabilityStatement.description | CodeSystem.description | CompartmentDefinition.description | ConceptMap.description | GraphDefinition.description | ImplementationGuide.description | MessageDefinition.description | NamingSystem.description | OperationDefinition.description | SearchParameter.description | StructureDefinition.description | StructureMap.description | TerminologyCapabilities.description | ValueSet.description
-
SP_JURISDICTION
public static final String SP_JURISDICTION
Search parameter: jurisdictionDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement [CodeSystem](codesystem.html): Intended jurisdiction for the code system [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition [StructureMap](structuremap.html): Intended jurisdiction for the structure map [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities [ValueSet](valueset.html): Intended jurisdiction for the value set
Type: token
Path: CapabilityStatement.jurisdiction | CodeSystem.jurisdiction | ConceptMap.jurisdiction | GraphDefinition.jurisdiction | ImplementationGuide.jurisdiction | MessageDefinition.jurisdiction | NamingSystem.jurisdiction | OperationDefinition.jurisdiction | SearchParameter.jurisdiction | StructureDefinition.jurisdiction | StructureMap.jurisdiction | TerminologyCapabilities.jurisdiction | ValueSet.jurisdiction
- See Also:
- Constant Field Values
-
JURISDICTION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement [CodeSystem](codesystem.html): Intended jurisdiction for the code system [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition [StructureMap](structuremap.html): Intended jurisdiction for the structure map [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities [ValueSet](valueset.html): Intended jurisdiction for the value set
Type: token
Path: CapabilityStatement.jurisdiction | CodeSystem.jurisdiction | ConceptMap.jurisdiction | GraphDefinition.jurisdiction | ImplementationGuide.jurisdiction | MessageDefinition.jurisdiction | NamingSystem.jurisdiction | OperationDefinition.jurisdiction | SearchParameter.jurisdiction | StructureDefinition.jurisdiction | StructureMap.jurisdiction | TerminologyCapabilities.jurisdiction | ValueSet.jurisdiction
-
SP_NAME
public static final String SP_NAME
Search parameter: nameDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement [CodeSystem](codesystem.html): Computationally friendly name of the code system [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition [ConceptMap](conceptmap.html): Computationally friendly name of the concept map [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition [NamingSystem](namingsystem.html): Computationally friendly name of the naming system [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition [StructureMap](structuremap.html): Computationally friendly name of the structure map [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities [ValueSet](valueset.html): Computationally friendly name of the value set
Type: string
Path: CapabilityStatement.name | CodeSystem.name | CompartmentDefinition.name | ConceptMap.name | GraphDefinition.name | ImplementationGuide.name | MessageDefinition.name | NamingSystem.name | OperationDefinition.name | SearchParameter.name | StructureDefinition.name | StructureMap.name | TerminologyCapabilities.name | ValueSet.name
- See Also:
- Constant Field Values
-
NAME
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Fluent Client search parameter constant for nameDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement [CodeSystem](codesystem.html): Computationally friendly name of the code system [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition [ConceptMap](conceptmap.html): Computationally friendly name of the concept map [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition [NamingSystem](namingsystem.html): Computationally friendly name of the naming system [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition [StructureMap](structuremap.html): Computationally friendly name of the structure map [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities [ValueSet](valueset.html): Computationally friendly name of the value set
Type: string
Path: CapabilityStatement.name | CodeSystem.name | CompartmentDefinition.name | ConceptMap.name | GraphDefinition.name | ImplementationGuide.name | MessageDefinition.name | NamingSystem.name | OperationDefinition.name | SearchParameter.name | StructureDefinition.name | StructureMap.name | TerminologyCapabilities.name | ValueSet.name
-
SP_PUBLISHER
public static final String SP_PUBLISHER
Search parameter: publisherDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement [CodeSystem](codesystem.html): Name of the publisher of the code system [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition [ConceptMap](conceptmap.html): Name of the publisher of the concept map [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition [NamingSystem](namingsystem.html): Name of the publisher of the naming system [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition [SearchParameter](searchparameter.html): Name of the publisher of the search parameter [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition [StructureMap](structuremap.html): Name of the publisher of the structure map [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities [ValueSet](valueset.html): Name of the publisher of the value set
Type: string
Path: CapabilityStatement.publisher | CodeSystem.publisher | CompartmentDefinition.publisher | ConceptMap.publisher | GraphDefinition.publisher | ImplementationGuide.publisher | MessageDefinition.publisher | NamingSystem.publisher | OperationDefinition.publisher | SearchParameter.publisher | StructureDefinition.publisher | StructureMap.publisher | TerminologyCapabilities.publisher | ValueSet.publisher
- See Also:
- Constant Field Values
-
PUBLISHER
public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
Fluent Client search parameter constant for publisherDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement [CodeSystem](codesystem.html): Name of the publisher of the code system [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition [ConceptMap](conceptmap.html): Name of the publisher of the concept map [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition [NamingSystem](namingsystem.html): Name of the publisher of the naming system [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition [SearchParameter](searchparameter.html): Name of the publisher of the search parameter [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition [StructureMap](structuremap.html): Name of the publisher of the structure map [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities [ValueSet](valueset.html): Name of the publisher of the value set
Type: string
Path: CapabilityStatement.publisher | CodeSystem.publisher | CompartmentDefinition.publisher | ConceptMap.publisher | GraphDefinition.publisher | ImplementationGuide.publisher | MessageDefinition.publisher | NamingSystem.publisher | OperationDefinition.publisher | SearchParameter.publisher | StructureDefinition.publisher | StructureMap.publisher | TerminologyCapabilities.publisher | ValueSet.publisher
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The current status of the capability statement [CodeSystem](codesystem.html): The current status of the code system [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition [ConceptMap](conceptmap.html): The current status of the concept map [GraphDefinition](graphdefinition.html): The current status of the graph definition [ImplementationGuide](implementationguide.html): The current status of the implementation guide [MessageDefinition](messagedefinition.html): The current status of the message definition [NamingSystem](namingsystem.html): The current status of the naming system [OperationDefinition](operationdefinition.html): The current status of the operation definition [SearchParameter](searchparameter.html): The current status of the search parameter [StructureDefinition](structuredefinition.html): The current status of the structure definition [StructureMap](structuremap.html): The current status of the structure map [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities [ValueSet](valueset.html): The current status of the value set
Type: token
Path: CapabilityStatement.status | CodeSystem.status | CompartmentDefinition.status | ConceptMap.status | GraphDefinition.status | ImplementationGuide.status | MessageDefinition.status | NamingSystem.status | OperationDefinition.status | SearchParameter.status | StructureDefinition.status | StructureMap.status | TerminologyCapabilities.status | ValueSet.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The current status of the capability statement [CodeSystem](codesystem.html): The current status of the code system [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition [ConceptMap](conceptmap.html): The current status of the concept map [GraphDefinition](graphdefinition.html): The current status of the graph definition [ImplementationGuide](implementationguide.html): The current status of the implementation guide [MessageDefinition](messagedefinition.html): The current status of the message definition [NamingSystem](namingsystem.html): The current status of the naming system [OperationDefinition](operationdefinition.html): The current status of the operation definition [SearchParameter](searchparameter.html): The current status of the search parameter [StructureDefinition](structuredefinition.html): The current status of the structure definition [StructureMap](structuremap.html): The current status of the structure map [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities [ValueSet](valueset.html): The current status of the value set
Type: token
Path: CapabilityStatement.status | CodeSystem.status | CompartmentDefinition.status | ConceptMap.status | GraphDefinition.status | ImplementationGuide.status | MessageDefinition.status | NamingSystem.status | OperationDefinition.status | SearchParameter.status | StructureDefinition.status | StructureMap.status | TerminologyCapabilities.status | ValueSet.status
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement [CodeSystem](codesystem.html): The uri that identifies the code system [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition [ConceptMap](conceptmap.html): The uri that identifies the concept map [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide [MessageDefinition](messagedefinition.html): The uri that identifies the message definition [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition [SearchParameter](searchparameter.html): The uri that identifies the search parameter [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition [StructureMap](structuremap.html): The uri that identifies the structure map [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities [ValueSet](valueset.html): The uri that identifies the value set
Type: uri
Path: CapabilityStatement.url | CodeSystem.url | CompartmentDefinition.url | ConceptMap.url | GraphDefinition.url | ImplementationGuide.url | MessageDefinition.url | OperationDefinition.url | SearchParameter.url | StructureDefinition.url | StructureMap.url | TerminologyCapabilities.url | ValueSet.url
- See Also:
- Constant Field Values
-
URL
public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
Fluent Client search parameter constant for urlDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement [CodeSystem](codesystem.html): The uri that identifies the code system [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition [ConceptMap](conceptmap.html): The uri that identifies the concept map [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide [MessageDefinition](messagedefinition.html): The uri that identifies the message definition [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition [SearchParameter](searchparameter.html): The uri that identifies the search parameter [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition [StructureMap](structuremap.html): The uri that identifies the structure map [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities [ValueSet](valueset.html): The uri that identifies the value set
Type: uri
Path: CapabilityStatement.url | CodeSystem.url | CompartmentDefinition.url | ConceptMap.url | GraphDefinition.url | ImplementationGuide.url | MessageDefinition.url | OperationDefinition.url | SearchParameter.url | StructureDefinition.url | StructureMap.url | TerminologyCapabilities.url | ValueSet.url
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The business version of the capability statement [CodeSystem](codesystem.html): The business version of the code system [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition [ConceptMap](conceptmap.html): The business version of the concept map [GraphDefinition](graphdefinition.html): The business version of the graph definition [ImplementationGuide](implementationguide.html): The business version of the implementation guide [MessageDefinition](messagedefinition.html): The business version of the message definition [OperationDefinition](operationdefinition.html): The business version of the operation definition [SearchParameter](searchparameter.html): The business version of the search parameter [StructureDefinition](structuredefinition.html): The business version of the structure definition [StructureMap](structuremap.html): The business version of the structure map [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities [ValueSet](valueset.html): The business version of the value set
Type: token
Path: CapabilityStatement.version | CodeSystem.version | CompartmentDefinition.version | ConceptMap.version | GraphDefinition.version | ImplementationGuide.version | MessageDefinition.version | OperationDefinition.version | SearchParameter.version | StructureDefinition.version | StructureMap.version | TerminologyCapabilities.version | ValueSet.version
- See Also:
- Constant Field Values
-
VERSION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
Fluent Client search parameter constant for versionDescription: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The business version of the capability statement [CodeSystem](codesystem.html): The business version of the code system [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition [ConceptMap](conceptmap.html): The business version of the concept map [GraphDefinition](graphdefinition.html): The business version of the graph definition [ImplementationGuide](implementationguide.html): The business version of the implementation guide [MessageDefinition](messagedefinition.html): The business version of the message definition [OperationDefinition](operationdefinition.html): The business version of the operation definition [SearchParameter](searchparameter.html): The business version of the search parameter [StructureDefinition](structuredefinition.html): The business version of the structure definition [StructureMap](structuremap.html): The business version of the structure map [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities [ValueSet](valueset.html): The business version of the value set
Type: token
Path: CapabilityStatement.version | CodeSystem.version | CompartmentDefinition.version | ConceptMap.version | GraphDefinition.version | ImplementationGuide.version | MessageDefinition.version | OperationDefinition.version | SearchParameter.version | StructureDefinition.version | StructureMap.version | TerminologyCapabilities.version | ValueSet.version
-
-
Constructor Detail
-
SearchParameter
public SearchParameter()
Constructor
-
SearchParameter
public SearchParameter(String url, String name, Enumerations.PublicationStatus status, String description, String code, String base, Enumerations.SearchParamType type)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType getUrlElement()
- Specified by:
getUrlElementin classCanonicalResource- Returns:
url(An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
public boolean hasUrlElement()
- Specified by:
hasUrlElementin classCanonicalResource
-
hasUrl
public boolean hasUrl()
- Specified by:
hasUrlin classCanonicalResource
-
setUrlElement
public SearchParameter setUrlElement(UriType value)
- Specified by:
setUrlElementin classCanonicalResource- Parameters:
value-url(An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
public String getUrl()
- Specified by:
getUrlin classCanonicalResource- Returns:
- An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers.
-
setUrl
public SearchParameter setUrl(String value)
- Specified by:
setUrlin classCanonicalResource- Parameters:
value- An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers.
-
getVersionElement
public StringType getVersionElement()
- Specified by:
getVersionElementin classCanonicalResource- Returns:
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()
- Specified by:
hasVersionElementin classCanonicalResource
-
hasVersion
public boolean hasVersion()
- Specified by:
hasVersionin classCanonicalResource
-
setVersionElement
public SearchParameter setVersionElement(StringType value)
- Specified by:
setVersionElementin classCanonicalResource- Parameters:
value-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()
- Specified by:
getVersionin classCanonicalResource- 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)
- Specified by:
setVersionin classCanonicalResource- 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()
- Specified by:
getNameElementin classCanonicalResource- Returns:
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()
- Specified by:
hasNameElementin classCanonicalResource
-
hasName
public boolean hasName()
- Specified by:
hasNamein classCanonicalResource
-
setNameElement
public SearchParameter setNameElement(StringType value)
- Specified by:
setNameElementin classCanonicalResource- Parameters:
value-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()
- Specified by:
getNamein classCanonicalResource- 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)
- Specified by:
setNamein classCanonicalResource- Parameters:
value- A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
getDerivedFromElement
public CanonicalType 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(CanonicalType 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.
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Specified by:
getStatusElementin classCanonicalResource- Returns:
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()
- Specified by:
hasStatusElementin classCanonicalResource
-
hasStatus
public boolean hasStatus()
- Specified by:
hasStatusin classCanonicalResource
-
setStatusElement
public SearchParameter setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- Specified by:
setStatusElementin classCanonicalResource- Parameters:
value-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()
- Specified by:
getStatusin classCanonicalResource- Returns:
- The status of this search parameter. Enables tracking the life-cycle of the content.
-
setStatus
public SearchParameter setStatus(Enumerations.PublicationStatus value)
- Specified by:
setStatusin classCanonicalResource- Parameters:
value- The status of this search parameter. Enables tracking the life-cycle of the content.
-
getExperimentalElement
public BooleanType getExperimentalElement()
- Specified by:
getExperimentalElementin classCanonicalResource- Returns:
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()
- Specified by:
hasExperimentalElementin classCanonicalResource
-
hasExperimental
public boolean hasExperimental()
- Specified by:
hasExperimentalin classCanonicalResource
-
setExperimentalElement
public SearchParameter setExperimentalElement(BooleanType value)
- Specified by:
setExperimentalElementin classCanonicalResource- Parameters:
value-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()
- Specified by:
getExperimentalin classCanonicalResource- 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)
- Specified by:
setExperimentalin classCanonicalResource- 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()
- Specified by:
getDateElementin classCanonicalResource- Returns:
date(The date (and optionally time) when the search parameter was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
public boolean hasDateElement()
- Specified by:
hasDateElementin classCanonicalResource
-
hasDate
public boolean hasDate()
- Specified by:
hasDatein classCanonicalResource
-
setDateElement
public SearchParameter setDateElement(DateTimeType value)
- Specified by:
setDateElementin classCanonicalResource- Parameters:
value-date(The date (and optionally time) when the search parameter was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
public Date getDate()
- Specified by:
getDatein classCanonicalResource- Returns:
- The date (and optionally time) when the search parameter was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.
-
setDate
public SearchParameter setDate(Date value)
- Specified by:
setDatein classCanonicalResource- Parameters:
value- The date (and optionally time) when the search parameter was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.
-
getPublisherElement
public StringType getPublisherElement()
- Specified by:
getPublisherElementin classCanonicalResource- Returns:
publisher(The name of the organization or individual that published the search parameter.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
hasPublisherElement
public boolean hasPublisherElement()
- Specified by:
hasPublisherElementin classCanonicalResource
-
hasPublisher
public boolean hasPublisher()
- Specified by:
hasPublisherin classCanonicalResource
-
setPublisherElement
public SearchParameter setPublisherElement(StringType value)
- Specified by:
setPublisherElementin classCanonicalResource- Parameters:
value-publisher(The name of the organization or individual that published the search parameter.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
getPublisher
public String getPublisher()
- Specified by:
getPublisherin classCanonicalResource- Returns:
- The name of the organization or individual that published the search parameter.
-
setPublisher
public SearchParameter setPublisher(String value)
- Specified by:
setPublisherin classCanonicalResource- Parameters:
value- The name of the organization or individual that published the search parameter.
-
getContact
public List<ContactDetail> getContact()
- Specified by:
getContactin classCanonicalResource- Returns:
contact(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
public SearchParameter setContact(List<ContactDetail> theContact)
- Specified by:
setContactin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
public boolean hasContact()
- Specified by:
hasContactin classCanonicalResource
-
addContact
public ContactDetail addContact()
- Specified by:
addContactin classCanonicalResource
-
addContact
public SearchParameter addContact(ContactDetail t)
- Specified by:
addContactin classCanonicalResource
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Specified by:
getContactFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
contact, creating it if it does not already exist {3}
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Specified by:
getDescriptionElementin classCanonicalResource- Returns:
description(And how it used.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
public boolean hasDescriptionElement()
- Specified by:
hasDescriptionElementin classCanonicalResource
-
hasDescription
public boolean hasDescription()
- Specified by:
hasDescriptionin classCanonicalResource
-
setDescriptionElement
public SearchParameter setDescriptionElement(MarkdownType value)
- Specified by:
setDescriptionElementin classCanonicalResource- Parameters:
value-description(And how it used.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
public String getDescription()
- Specified by:
getDescriptionin classCanonicalResource- Returns:
- And how it used.
-
setDescription
public SearchParameter setDescription(String value)
- Specified by:
setDescriptionin classCanonicalResource- Parameters:
value- And how it used.
-
getUseContext
public List<UsageContext> getUseContext()
- Specified by:
getUseContextin classCanonicalResource- Returns:
useContext(The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instances.)
-
setUseContext
public SearchParameter setUseContext(List<UsageContext> theUseContext)
- Specified by:
setUseContextin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUseContext
public boolean hasUseContext()
- Specified by:
hasUseContextin classCanonicalResource
-
addUseContext
public UsageContext addUseContext()
- Specified by:
addUseContextin classCanonicalResource
-
addUseContext
public SearchParameter addUseContext(UsageContext t)
- Specified by:
addUseContextin classCanonicalResource
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Specified by:
getUseContextFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
useContext, creating it if it does not already exist {3}
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
- Specified by:
getJurisdictionin classCanonicalResource- Returns:
jurisdiction(A legal or geographic region in which the search parameter is intended to be used.)
-
setJurisdiction
public SearchParameter setJurisdiction(List<CodeableConcept> theJurisdiction)
- Specified by:
setJurisdictionin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
- Specified by:
hasJurisdictionin classCanonicalResource
-
addJurisdiction
public CodeableConcept addJurisdiction()
- Specified by:
addJurisdictionin classCanonicalResource
-
addJurisdiction
public SearchParameter addJurisdiction(CodeableConcept t)
- Specified by:
addJurisdictionin classCanonicalResource
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Specified by:
getJurisdictionFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
jurisdiction, creating it if it does not already exist {3}
-
getPurposeElement
public MarkdownType getPurposeElement()
- Specified by:
getPurposeElementin classCanonicalResource- Returns:
purpose(Explanation of why this search parameter is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
hasPurposeElement
public boolean hasPurposeElement()
- Specified by:
hasPurposeElementin classCanonicalResource
-
hasPurpose
public boolean hasPurpose()
- Specified by:
hasPurposein classCanonicalResource
-
setPurposeElement
public SearchParameter setPurposeElement(MarkdownType value)
- Specified by:
setPurposeElementin classCanonicalResource- Parameters:
value-purpose(Explanation of why this search parameter is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
getPurpose
public String getPurpose()
- Specified by:
getPurposein classCanonicalResource- Returns:
- Explanation of why this search parameter is needed and why it has been designed as it has.
-
setPurpose
public SearchParameter setPurpose(String value)
- Specified by:
setPurposein classCanonicalResource- Parameters:
value- Explanation 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
thisfor 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 that a search parameter may contain, and how the content is interpreted.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
-
hasTypeElement
public boolean hasTypeElement()
-
hasType
public boolean hasType()
-
setTypeElement
public SearchParameter setTypeElement(Enumeration<Enumerations.SearchParamType> value)
- Parameters:
value-type(The type of value that a search parameter may contain, and how the content is interpreted.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
-
getType
public Enumerations.SearchParamType getType()
- Returns:
- The type of value that a search parameter may contain, and how the content is interpreted.
-
setType
public SearchParameter setType(Enumerations.SearchParamType value)
- Parameters:
value- The type of value that a search parameter may contain, and how the content is interpreted.
-
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
thisfor 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).)
-
getMultipleOrElement
public BooleanType getMultipleOrElement()
- Returns:
multipleOr(Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.). This is the underlying object with id, value and extensions. The accessor "getMultipleOr" gives direct access to the value
-
hasMultipleOrElement
public boolean hasMultipleOrElement()
-
hasMultipleOr
public boolean hasMultipleOr()
-
setMultipleOrElement
public SearchParameter setMultipleOrElement(BooleanType value)
- Parameters:
value-multipleOr(Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.). This is the underlying object with id, value and extensions. The accessor "getMultipleOr" gives direct access to the value
-
getMultipleOr
public boolean getMultipleOr()
- Returns:
- Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.
-
setMultipleOr
public SearchParameter setMultipleOr(boolean value)
- Parameters:
value- Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.
-
getMultipleAndElement
public BooleanType getMultipleAndElement()
- Returns:
multipleAnd(Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.). This is the underlying object with id, value and extensions. The accessor "getMultipleAnd" gives direct access to the value
-
hasMultipleAndElement
public boolean hasMultipleAndElement()
-
hasMultipleAnd
public boolean hasMultipleAnd()
-
setMultipleAndElement
public SearchParameter setMultipleAndElement(BooleanType value)
- Parameters:
value-multipleAnd(Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.). This is the underlying object with id, value and extensions. The accessor "getMultipleAnd" gives direct access to the value
-
getMultipleAnd
public boolean getMultipleAnd()
- Returns:
- Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.
-
setMultipleAnd
public SearchParameter setMultipleAnd(boolean value)
- Parameters:
value- Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.
-
getComparator
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
thisfor 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
thisfor 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
thisfor 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
thisfor 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 {3}
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classCanonicalResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classCanonicalResource
-
copy
public SearchParameter copy()
- Specified by:
copyin classCanonicalResource
-
copyValues
public void copyValues(SearchParameter dst)
-
typedCopy
protected SearchParameter typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classCanonicalResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classCanonicalResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classCanonicalResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
supportsCopyright
public boolean supportsCopyright()
- Overrides:
supportsCopyrightin classCanonicalResource
-
getIdentifier
public List<Identifier> getIdentifier()
- Specified by:
getIdentifierin classCanonicalResource- Returns:
#identifier(A formal identifier that is used to identify this canonical resource when it is represented in other formats, or referenced in a specification, model, design or an instance.)
-
setIdentifier
public CanonicalResource setIdentifier(List<Identifier> theIdentifier)
- Specified by:
setIdentifierin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
- Specified by:
hasIdentifierin classCanonicalResource
-
addIdentifier
public Identifier addIdentifier()
- Specified by:
addIdentifierin classCanonicalResource
-
addIdentifier
public CanonicalResource addIdentifier(Identifier t)
- Specified by:
addIdentifierin classCanonicalResource
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Specified by:
getIdentifierFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
#identifier, creating it if it does not already exist {1}
-
getCopyrightElement
public MarkdownType getCopyrightElement()
- Specified by:
getCopyrightElementin classCanonicalResource- Returns:
#copyright(A copyright statement relating to the canonical resource and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the canonical resource.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
hasCopyrightElement
public boolean hasCopyrightElement()
- Specified by:
hasCopyrightElementin classCanonicalResource
-
hasCopyright
public boolean hasCopyright()
- Specified by:
hasCopyrightin classCanonicalResource
-
setCopyrightElement
public CanonicalResource setCopyrightElement(MarkdownType value)
- Specified by:
setCopyrightElementin classCanonicalResource- Parameters:
value-#copyright(A copyright statement relating to the canonical resource and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the canonical resource.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
getCopyright
public String getCopyright()
- Specified by:
getCopyrightin classCanonicalResource- Returns:
- A copyright statement relating to the canonical resource and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the canonical resource.
-
setCopyright
public CanonicalResource setCopyright(String value)
- Specified by:
setCopyrightin classCanonicalResource- Parameters:
value- A copyright statement relating to the canonical resource and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the canonical resource.
-
getTitleElement
public StringType getTitleElement()
- Specified by:
getTitleElementin classCanonicalResource- Returns:
#title(A short, descriptive, user-friendly title for the canonical resource.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
public boolean hasTitleElement()
- Specified by:
hasTitleElementin classCanonicalResource
-
hasTitle
public boolean hasTitle()
- Specified by:
hasTitlein classCanonicalResource
-
setTitleElement
public CanonicalResource setTitleElement(StringType value)
- Specified by:
setTitleElementin classCanonicalResource- Parameters:
value-#title(A short, descriptive, user-friendly title for the canonical resource.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
public String getTitle()
- Specified by:
getTitlein classCanonicalResource- Returns:
- A short, descriptive, user-friendly title for the canonical resource.
-
setTitle
public CanonicalResource setTitle(String value)
- Specified by:
setTitlein classCanonicalResource- Parameters:
value- A short, descriptive, user-friendly title for the canonical resource.
-
-