Package com.ibm.fhir.model.resource

Class SearchParameter.Builder

    • Method Detail

      • id

        public SearchParameter.Builder id​(java.lang.String id)
        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
        Overrides:
        id in class DomainResource.Builder
        Parameters:
        id - Logical id of this artifact
        Returns:
        A reference to this Builder instance

      • meta

        public SearchParameter.Builder meta​(Meta meta)
        The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
        Overrides:
        meta in class DomainResource.Builder
        Parameters:
        meta - Metadata about the resource
        Returns:
        A reference to this Builder instance

      • implicitRules

        public SearchParameter.Builder implicitRules​(Uri implicitRules)
        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
        Overrides:
        implicitRules in class DomainResource.Builder
        Parameters:
        implicitRules - A set of rules under which this content was created
        Returns:
        A reference to this Builder instance

      • text

        public SearchParameter.Builder text​(Narrative text)
        A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
        Overrides:
        text in class DomainResource.Builder
        Parameters:
        text - Text summary of the resource, for human interpretation
        Returns:
        A reference to this Builder instance

      • contained

        public SearchParameter.Builder contained​(Resource... contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance

      • contained

        public SearchParameter.Builder contained​(java.util.Collection<Resource> contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • extension

        public SearchParameter.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public SearchParameter.Builder extension​(java.util.Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • modifierExtension

        public SearchParameter.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public SearchParameter.Builder modifierExtension​(java.util.Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • url

        public SearchParameter.Builder url​(Uri 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 element is required.

        Parameters:
        url - Canonical identifier for this search parameter, represented as a URI (globally unique)
        Returns:
        A reference to this Builder instance

      • version

        public SearchParameter.Builder version​(String 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.
        Parameters:
        version - Business version of the search parameter
        Returns:
        A reference to this Builder instance

      • name

        public SearchParameter.Builder name​(java.lang.String name)
        Convenience method for setting name.

        This element is required.

        Parameters:
        name - Name for this search parameter (computer friendly)
        Returns:
        A reference to this Builder instance
        See Also:
        name(com.ibm.fhir.model.type.String)

      • name

        public SearchParameter.Builder name​(String 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 element is required.

        Parameters:
        name - Name for this search parameter (computer friendly)
        Returns:
        A reference to this Builder instance

      • derivedFrom

        public SearchParameter.Builder derivedFrom​(Canonical 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.
        Parameters:
        derivedFrom - Original definition for the search parameter
        Returns:
        A reference to this Builder instance

      • status

        public SearchParameter.Builder status​(PublicationStatus status)
        The status of this search parameter. Enables tracking the life-cycle of the content.

        This element is required.

        Parameters:
        status - draft | active | retired | unknown
        Returns:
        A reference to this Builder instance

      • experimental

        public SearchParameter.Builder experimental​(Boolean 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.
        Parameters:
        experimental - For testing purposes, not real usage
        Returns:
        A reference to this Builder instance

      • date

        public SearchParameter.Builder date​(DateTime 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.
        Parameters:
        date - Date last changed
        Returns:
        A reference to this Builder instance

      • publisher

        public SearchParameter.Builder publisher​(String publisher)
        The name of the organization or individual that published the search parameter.
        Parameters:
        publisher - Name of the publisher (organization or individual)
        Returns:
        A reference to this Builder instance

      • contact

        public SearchParameter.Builder contact​(ContactDetail... contact)
        Contact details to assist a user in finding and communicating with the publisher.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        contact - Contact details for the publisher
        Returns:
        A reference to this Builder instance

      • contact

        public SearchParameter.Builder contact​(java.util.Collection<ContactDetail> contact)
        Contact details to assist a user in finding and communicating with the publisher.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        contact - Contact details for the publisher
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • description

        public SearchParameter.Builder description​(Markdown description)
        And how it used.

        This element is required.

        Parameters:
        description - Natural language description of the search parameter
        Returns:
        A reference to this Builder instance

      • useContext

        public SearchParameter.Builder useContext​(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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        useContext - The context that the content is intended to support
        Returns:
        A reference to this Builder instance

      • useContext

        public SearchParameter.Builder useContext​(java.util.Collection<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.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        useContext - The context that the content is intended to support
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • jurisdiction

        public SearchParameter.Builder jurisdiction​(CodeableConcept... jurisdiction)
        A legal or geographic region in which the search parameter is intended to be used.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        jurisdiction - Intended jurisdiction for search parameter (if applicable)
        Returns:
        A reference to this Builder instance

      • jurisdiction

        public SearchParameter.Builder jurisdiction​(java.util.Collection<CodeableConcept> jurisdiction)
        A legal or geographic region in which the search parameter is intended to be used.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        jurisdiction - Intended jurisdiction for search parameter (if applicable)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • purpose

        public SearchParameter.Builder purpose​(Markdown purpose)
        Explanation of why this search parameter is needed and why it has been designed as it has.
        Parameters:
        purpose - Why this search parameter is defined
        Returns:
        A reference to this Builder instance

      • code

        public SearchParameter.Builder code​(Code code)
        The code used in the URL or the parameter name in a parameters resource for this search parameter.

        This element is required.

        Parameters:
        code - Code used in URL
        Returns:
        A reference to this Builder instance

      • base

        public SearchParameter.Builder base​(ResourceType... base)
        The base resource type(s) that this search parameter can be used against.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        This element is required.

        Parameters:
        base - The resource type(s) this search parameter applies to
        Returns:
        A reference to this Builder instance

      • base

        public SearchParameter.Builder base​(java.util.Collection<ResourceType> base)
        The base resource type(s) that this search parameter can be used against.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        This element is required.

        Parameters:
        base - The resource type(s) this search parameter applies to
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • type

        public SearchParameter.Builder type​(SearchParamType type)
        The type of value that a search parameter may contain, and how the content is interpreted.

        This element is required.

        Parameters:
        type - number | date | string | token | reference | composite | quantity | uri | special
        Returns:
        A reference to this Builder instance

      • expression

        public SearchParameter.Builder expression​(String expression)
        A FHIRPath expression that returns a set of elements for the search parameter.
        Parameters:
        expression - FHIRPath expression that extracts the values
        Returns:
        A reference to this Builder instance

      • xpath

        public SearchParameter.Builder xpath​(String xpath)
        An XPath expression that returns a set of elements for the search parameter.
        Parameters:
        xpath - XPath that extracts the values
        Returns:
        A reference to this Builder instance

      • xpathUsage

        public SearchParameter.Builder xpathUsage​(XPathUsageType xpathUsage)
        How the search parameter relates to the set of elements returned by evaluating the xpath query.
        Parameters:
        xpathUsage - normal | phonetic | nearby | distance | other
        Returns:
        A reference to this Builder instance

      • target

        public SearchParameter.Builder target​(ResourceType... target)
        Types of resource (if a resource is referenced).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        target - Types of resource (if a resource reference)
        Returns:
        A reference to this Builder instance

      • target

        public SearchParameter.Builder target​(java.util.Collection<ResourceType> target)
        Types of resource (if a resource is referenced).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        target - Types of resource (if a resource reference)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • multipleOr

        public SearchParameter.Builder multipleOr​(Boolean 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.
        Parameters:
        multipleOr - Allow multiple values per parameter (or)
        Returns:
        A reference to this Builder instance

      • multipleAnd

        public SearchParameter.Builder multipleAnd​(Boolean multipleAnd)
        Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.
        Parameters:
        multipleAnd - Allow multiple parameters (and)
        Returns:
        A reference to this Builder instance

      • comparator

        public SearchParameter.Builder comparator​(SearchComparator... comparator)
        Comparators supported for the search parameter.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        comparator - eq | ne | gt | lt | ge | le | sa | eb | ap
        Returns:
        A reference to this Builder instance

      • comparator

        public SearchParameter.Builder comparator​(java.util.Collection<SearchComparator> comparator)
        Comparators supported for the search parameter.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        comparator - eq | ne | gt | lt | ge | le | sa | eb | ap
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • modifier

        public SearchParameter.Builder modifier​(SearchModifierCode... modifier)
        A modifier supported for the search parameter.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        modifier - missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
        Returns:
        A reference to this Builder instance

      • modifier

        public SearchParameter.Builder modifier​(java.util.Collection<SearchModifierCode> modifier)
        A modifier supported for the search parameter.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        modifier - missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • chain

        public SearchParameter.Builder chain​(java.lang.String... chain)
        Convenience method for setting chain.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        chain - Chained names supported
        Returns:
        A reference to this Builder instance
        See Also:
        #chain(com.ibm.fhir.model.type.String)

      • chain

        public SearchParameter.Builder chain​(String... 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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        chain - Chained names supported
        Returns:
        A reference to this Builder instance

      • chain

        public SearchParameter.Builder chain​(java.util.Collection<String> 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.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        chain - Chained names supported
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • component

        public SearchParameter.Builder component​(SearchParameter.Component... component)
        Used to define the parts of a composite search parameter.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        component - For Composite resources to define the parts
        Returns:
        A reference to this Builder instance

      • component

        public SearchParameter.Builder component​(java.util.Collection<SearchParameter.Component> component)
        Used to define the parts of a composite search parameter.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        component - For Composite resources to define the parts
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null