Package ca.uhn.fhir.model.dstu2.resource

Class Conformance.RestResourceSearchParam

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.api.BaseIdentifiableElement
ca.uhn.fhir.model.dstu2.resource.Conformance.RestResourceSearchParam
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.IResourceBlock, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase
Enclosing class:
Conformance
public static class Conformance.RestResourceSearchParam extends ca.uhn.fhir.model.api.BaseIdentifiableElement implements ca.uhn.fhir.model.api.IResourceBlock
Block class for child element: Conformance.rest.resource.searchParam ()

Definition: Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation

See Also:

  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase

    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

    • getNameElement

      public ca.uhn.fhir.model.primitive.StringDt getNameElement()
      Gets the value(s) for name (). creating it if it does not exist. Will not return null.

      Definition: The name of the search parameter used in the interface

    • getName

      public String getName()
      Gets the value(s) for name (). creating it if it does not exist. This method may return null.

      Definition: The name of the search parameter used in the interface

    • setName

      public Conformance.RestResourceSearchParam setName(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for name ()

      Definition: The name of the search parameter used in the interface

    • setName

      public Conformance.RestResourceSearchParam setName(String theString)
      Sets the value for name ()

      Definition: The name of the search parameter used in the interface

    • getDefinitionElement

      public ca.uhn.fhir.model.primitive.UriDt getDefinitionElement()
      Gets the value(s) for definition (). creating it if it does not exist. Will not return null.

      Definition: An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]])

    • getDefinition

      public String getDefinition()
      Gets the value(s) for definition (). creating it if it does not exist. This method may return null.

      Definition: An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]])

    • setDefinition

      public Conformance.RestResourceSearchParam setDefinition(ca.uhn.fhir.model.primitive.UriDt theValue)
      Sets the value(s) for definition ()

      Definition: An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]])

    • setDefinition

      public Conformance.RestResourceSearchParam setDefinition(String theUri)
      Sets the value for definition ()

      Definition: An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]])

    • getTypeElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<SearchParamTypeEnum> getTypeElement()
      Gets the value(s) for type (). creating it if it does not exist. Will not return null.

      Definition: The type of value a search parameter refers to, and how the content is interpreted

    • getType

      public String getType()
      Gets the value(s) for type (). creating it if it does not exist. This method may return null.

      Definition: The type of value a search parameter refers to, and how the content is interpreted

    • setType

      public Conformance.RestResourceSearchParam setType(ca.uhn.fhir.model.primitive.BoundCodeDt<SearchParamTypeEnum> theValue)
      Sets the value(s) for type ()

      Definition: The type of value a search parameter refers to, and how the content is interpreted

    • setType

      public Conformance.RestResourceSearchParam setType(SearchParamTypeEnum theValue)
      Sets the value(s) for type ()

      Definition: The type of value a search parameter refers to, and how the content is interpreted

    • getDocumentationElement

      public ca.uhn.fhir.model.primitive.StringDt getDocumentationElement()
      Gets the value(s) for documentation (). creating it if it does not exist. Will not return null.

      Definition: This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.

    • getDocumentation

      public String getDocumentation()
      Gets the value(s) for documentation (). creating it if it does not exist. This method may return null.

      Definition: This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.

    • setDocumentation

      public Conformance.RestResourceSearchParam setDocumentation(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for documentation ()

      Definition: This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.

    • setDocumentation

      public Conformance.RestResourceSearchParam setDocumentation(String theString)
      Sets the value for documentation ()

      Definition: This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.

    • getTarget

      public List<ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum>> getTarget()
      Gets the value(s) for target (). creating it if it does not exist. Will not return null.

      Definition: Types of resource (if a resource is referenced)

    • setTarget

      public Conformance.RestResourceSearchParam setTarget(List<ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum>> theValue)
      Sets the value(s) for target ()

      Definition: Types of resource (if a resource is referenced)

    • addTarget

      public ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum> addTarget(ResourceTypeEnum theValue)
      Add a value for target () using an enumerated type. This is intended as a convenience method for situations where the FHIR defined ValueSets are mandatory or contain the desirable codes. If you wish to use codes other than those which are built-in, you may also use the addTarget() method.

      Definition: Types of resource (if a resource is referenced)

    • getTargetFirstRep

      public ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum> getTargetFirstRep()
      Gets the first repetition for target (), creating it if it does not already exist.

      Definition: Types of resource (if a resource is referenced)

    • addTarget

      public ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum> addTarget()
      Add a value for target ()

      Definition: Types of resource (if a resource is referenced)

    • setTarget

      public Conformance.RestResourceSearchParam setTarget(ResourceTypeEnum theValue)
      Sets the value(s), and clears any existing value(s) for target ()

      Definition: Types of resource (if a resource is referenced)

    • getModifier

      public List<ca.uhn.fhir.model.primitive.BoundCodeDt<SearchModifierCodeEnum>> getModifier()
      Gets the value(s) for modifier (). creating it if it does not exist. Will not return null.

      Definition: A modifier supported for the search parameter

    • setModifier

      public Conformance.RestResourceSearchParam setModifier(List<ca.uhn.fhir.model.primitive.BoundCodeDt<SearchModifierCodeEnum>> theValue)
      Sets the value(s) for modifier ()

      Definition: A modifier supported for the search parameter

    • addModifier

      public ca.uhn.fhir.model.primitive.BoundCodeDt<SearchModifierCodeEnum> addModifier(SearchModifierCodeEnum theValue)
      Add a value for modifier () using an enumerated type. This is intended as a convenience method for situations where the FHIR defined ValueSets are mandatory or contain the desirable codes. If you wish to use codes other than those which are built-in, you may also use the addModifier() method.

      Definition: A modifier supported for the search parameter

    • getModifierFirstRep

      public ca.uhn.fhir.model.primitive.BoundCodeDt<SearchModifierCodeEnum> getModifierFirstRep()
      Gets the first repetition for modifier (), creating it if it does not already exist.

      Definition: A modifier supported for the search parameter

    • addModifier

      public ca.uhn.fhir.model.primitive.BoundCodeDt<SearchModifierCodeEnum> addModifier()
      Add a value for modifier ()

      Definition: A modifier supported for the search parameter

    • setModifier

      public Conformance.RestResourceSearchParam setModifier(SearchModifierCodeEnum theValue)
      Sets the value(s), and clears any existing value(s) for modifier ()

      Definition: A modifier supported for the search parameter

    • getChain

      public List<ca.uhn.fhir.model.primitive.StringDt> getChain()
      Gets the value(s) for chain (). creating it if it does not exist. Will not return null.

      Definition: 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 Conformance.rest.resource.searchParam.name on the target resource type

    • setChain

      public Conformance.RestResourceSearchParam setChain(List<ca.uhn.fhir.model.primitive.StringDt> theValue)
      Sets the value(s) for chain ()

      Definition: 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 Conformance.rest.resource.searchParam.name on the target resource type

    • addChain

      public ca.uhn.fhir.model.primitive.StringDt addChain()
      Adds and returns a new value for chain ()

      Definition: 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 Conformance.rest.resource.searchParam.name on the target resource type

    • addChain

      public Conformance.RestResourceSearchParam addChain(ca.uhn.fhir.model.primitive.StringDt theValue)
      Adds a given new value for chain ()

      Definition: 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 Conformance.rest.resource.searchParam.name on the target resource type

      Parameters:
      theValue - The chain to add (must not be null)

    • getChainFirstRep

      public ca.uhn.fhir.model.primitive.StringDt getChainFirstRep()
      Gets the first repetition for chain (), creating it if it does not already exist.

      Definition: 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 Conformance.rest.resource.searchParam.name on the target resource type

    • addChain

      public Conformance.RestResourceSearchParam addChain(String theString)
      Adds a new value for chain ()

      Definition: 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 Conformance.rest.resource.searchParam.name on the target resource type

      Returns:
      Returns a reference to this object, to allow for simple chaining.