Package org.hl7.fhir.r4.model

Class SearchParameter

java.lang.Object
org.hl7.fhir.r4.model.Base
org.hl7.fhir.r4.model.BaseResource
org.hl7.fhir.r4.model.Resource
org.hl7.fhir.r4.model.DomainResource
org.hl7.fhir.r4.model.MetadataResource
org.hl7.fhir.r4.model.SearchParameter
All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
public class SearchParameter extends MetadataResource
A search parameter that defines a named search item that can be used to search/filter on a resource.
See Also:

  • Field Details

    • 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.

    • 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.

    • target

      protected List<CodeType> target
      Types of resource (if a resource is referenced).

    • 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_DATE

      public static final String SP_DATE
      Search parameter: date

      Description: The search parameter publication date
      Type: date
      Path: SearchParameter.date

      See Also:

    • DATE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
      Fluent Client search parameter constant for date

      Description: The search parameter publication date
      Type: date
      Path: SearchParameter.date

    • SP_CODE

      public static final String SP_CODE
      Search parameter: code

      Description: Code used in URL
      Type: token
      Path: SearchParameter.code

      See Also:

    • CODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
      Fluent Client search parameter constant for code

      Description: Code used in URL
      Type: token
      Path: SearchParameter.code

    • SP_CONTEXT_TYPE_VALUE

      public static final String SP_CONTEXT_TYPE_VALUE
      Search parameter: context-type-value

      Description: A use context type and value assigned to the search parameter
      Type: composite
      Path:

      See Also:

    • 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-value

      Description: A use context type and value assigned to the search parameter
      Type: composite
      Path:

    • SP_JURISDICTION

      public static final String SP_JURISDICTION
      Search parameter: jurisdiction

      Description: Intended jurisdiction for the search parameter
      Type: token
      Path: SearchParameter.jurisdiction

      See Also:

    • JURISDICTION

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
      Fluent Client search parameter constant for jurisdiction

      Description: Intended jurisdiction for the search parameter
      Type: token
      Path: SearchParameter.jurisdiction

    • SP_DESCRIPTION

      public static final String SP_DESCRIPTION
      Search parameter: description

      Description: The description of the search parameter
      Type: string
      Path: SearchParameter.description

      See Also:

    • DESCRIPTION

      public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
      Fluent Client search parameter constant for description

      Description: The description of the search parameter
      Type: string
      Path: SearchParameter.description

    • SP_DERIVED_FROM

      public static final String SP_DERIVED_FROM
      Search parameter: derived-from

      Description: Original definition for the search parameter
      Type: reference
      Path: SearchParameter.derivedFrom

      See Also:

    • DERIVED_FROM

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DERIVED_FROM
      Fluent Client search parameter constant for derived-from

      Description: 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_CONTEXT_TYPE

      public static final String SP_CONTEXT_TYPE
      Search parameter: context-type

      Description: A type of use context assigned to the search parameter
      Type: token
      Path: SearchParameter.useContext.code

      See Also:

    • CONTEXT_TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
      Fluent Client search parameter constant for context-type

      Description: A type of use context assigned to the search parameter
      Type: token
      Path: SearchParameter.useContext.code

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter: type

      Description: number | date | string | token | reference | composite | quantity | uri | special
      Type: token
      Path: SearchParameter.type

      See Also:

    • TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
      Fluent Client search parameter constant for type

      Description: number | date | string | token | reference | composite | quantity | uri | special
      Type: token
      Path: SearchParameter.type

    • SP_VERSION

      public static final String SP_VERSION
      Search parameter: version

      Description: The business version of the search parameter
      Type: token
      Path: SearchParameter.version

      See Also:

    • VERSION

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
      Fluent Client search parameter constant for version

      Description: The business version of the search parameter
      Type: token
      Path: SearchParameter.version

    • SP_URL

      public static final String SP_URL
      Search parameter: url

      Description: The uri that identifies the search parameter
      Type: uri
      Path: SearchParameter.url

      See Also:

    • URL

      public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
      Fluent Client search parameter constant for url

      Description: The uri that identifies the search parameter
      Type: uri
      Path: SearchParameter.url

    • SP_TARGET

      public static final String SP_TARGET
      Search parameter: target

      Description: Types of resource (if a resource reference)
      Type: token
      Path: SearchParameter.target

      See Also:

    • TARGET

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam TARGET
      Fluent Client search parameter constant for target

      Description: Types of resource (if a resource reference)
      Type: token
      Path: SearchParameter.target

    • SP_CONTEXT_QUANTITY

      public static final String SP_CONTEXT_QUANTITY
      Search parameter: context-quantity

      Description: A quantity- or range-valued use context assigned to the search parameter
      Type: quantity
      Path: SearchParameter.useContext.valueQuantity, SearchParameter.useContext.valueRange

      See Also:

    • CONTEXT_QUANTITY

      public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
      Fluent Client search parameter constant for context-quantity

      Description: A quantity- or range-valued use context assigned to the search parameter
      Type: quantity
      Path: SearchParameter.useContext.valueQuantity, SearchParameter.useContext.valueRange

    • SP_COMPONENT

      public static final String SP_COMPONENT
      Search parameter: component

      Description: Defines how the part works
      Type: reference
      Path: SearchParameter.component.definition

      See Also:

    • COMPONENT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam COMPONENT
      Fluent Client search parameter constant for component

      Description: Defines how the part works
      Type: reference
      Path: SearchParameter.component.definition

    • INCLUDE_COMPONENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_COMPONENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "SearchParameter:component".

    • SP_NAME

      public static final String SP_NAME
      Search parameter: name

      Description: Computationally friendly name of the search parameter
      Type: string
      Path: SearchParameter.name

      See Also:

    • NAME

      public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
      Fluent Client search parameter constant for name

      Description: Computationally friendly name of the search parameter
      Type: string
      Path: SearchParameter.name

    • SP_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: A use context assigned to the search parameter
      Type: token
      Path: SearchParameter.useContext.valueCodeableConcept

      See Also:

    • CONTEXT

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
      Fluent Client search parameter constant for context

      Description: A use context assigned to the search parameter
      Type: token
      Path: SearchParameter.useContext.valueCodeableConcept

    • SP_PUBLISHER

      public static final String SP_PUBLISHER
      Search parameter: publisher

      Description: Name of the publisher of the search parameter
      Type: string
      Path: SearchParameter.publisher

      See Also:

    • PUBLISHER

      public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
      Fluent Client search parameter constant for publisher

      Description: Name of the publisher of the search parameter
      Type: string
      Path: SearchParameter.publisher

    • SP_CONTEXT_TYPE_QUANTITY

      public static final String SP_CONTEXT_TYPE_QUANTITY
      Search parameter: context-type-quantity

      Description: A use context type and quantity- or range-based value assigned to the search parameter
      Type: composite
      Path:

      See Also:

    • 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-quantity

      Description: A use context type and quantity- or range-based value assigned to the search parameter
      Type: composite
      Path:

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: The current status of the search parameter
      Type: token
      Path: SearchParameter.status

      See Also:

    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: The current status of the search parameter
      Type: token
      Path: SearchParameter.status

    • SP_BASE

      public static final String SP_BASE
      Search parameter: base

      Description: The resource type(s) this search parameter applies to
      Type: token
      Path: SearchParameter.base

      See Also:

    • BASE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam BASE
      Fluent Client search parameter constant for base

      Description: The resource type(s) this search parameter applies to
      Type: token
      Path: SearchParameter.base

  • Constructor Details

  • Method Details