Package com.babylonhealth.lit.hl7_java.builders

Class SearchParameterBuilder.Impl

    • Constructor Detail

      • Impl

        public Impl​(java.lang.String url,
            java.lang.String name,
            java.lang.String code,
            java.util.Collection<com.babylonhealth.lit.hl7.RESOURCE_TYPES> base,
            com.babylonhealth.lit.hl7.SEARCH_PARAM_TYPE _type,
            com.babylonhealth.lit.hl7.PUBLICATION_STATUS status,
            java.lang.String description)
        Required fields for SearchParameter
        Parameters:
        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.
        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.
        code - - The code used in the URL or the parameter name in a parameters resource for this search parameter.
        base - - The base resource type(s) that this search parameter can be used against.
        _type - - The type of value that a search parameter may contain, and how the content is interpreted.
        status - - The status of this search parameter. Enables tracking the life-cycle of the content.
        description - - And how it used.

    • Method Detail

      • withId

        public SearchParameterBuilder.Impl withId​(@NonNull
                                          @NonNull java.lang.String id)
        Parameters:
        id - - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      • withMeta

        public SearchParameterBuilder.Impl withMeta​(@NonNull
                                            @NonNull com.babylonhealth.lit.core.model.Meta meta)
        Parameters:
        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.

      • withMeta

        public SearchParameterBuilder.Impl withMeta​(@NonNull
                                            @NonNull com.babylonhealth.lit.core_java.builders.MetaBuilder meta)

      • withText

        public SearchParameterBuilder.Impl withText​(@NonNull
                                            @NonNull com.babylonhealth.lit.hl7.model.Narrative text)
        Parameters:
        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.

      • withDate

        public SearchParameterBuilder.Impl withDate​(@NonNull
                                            @NonNull com.babylonhealth.lit.core.FHIRDateTime date)
        Parameters:
        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.

      • withXpath

        public SearchParameterBuilder.Impl withXpath​(@NonNull
                                             @NonNull java.lang.String xpath)
        Parameters:
        xpath - - An XPath expression that returns a set of elements for the search parameter.

      • withChain

        public SearchParameterBuilder.Impl withChain​(@NonNull
                                             @NonNull java.lang.String... chain)
        Parameters:
        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.

      • withChain

        public SearchParameterBuilder.Impl withChain​(@NonNull
                                             @NonNull java.util.Collection<java.lang.String> chain)
        Parameters:
        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.

      • withTarget

        public SearchParameterBuilder.Impl withTarget​(@NonNull
                                              @NonNull com.babylonhealth.lit.hl7.RESOURCE_TYPES... target)
        Parameters:
        target - - Types of resource (if a resource is referenced).

      • withTarget

        public SearchParameterBuilder.Impl withTarget​(@NonNull
                                              @NonNull java.util.Collection<com.babylonhealth.lit.hl7.RESOURCE_TYPES> target)
        Parameters:
        target - - Types of resource (if a resource is referenced).

      • withVersion

        public SearchParameterBuilder.Impl withVersion​(@NonNull
                                               @NonNull java.lang.String version)
        Parameters:
        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.

      • withContact

        public SearchParameterBuilder.Impl withContact​(@NonNull
                                               @NonNull com.babylonhealth.lit.core.model.ContactDetail... contact)
        Parameters:
        contact - - Contact details to assist a user in finding and communicating with the publisher.

      • withContact

        public SearchParameterBuilder.Impl withContact​(@NonNull
                                               @NonNull java.util.Collection<com.babylonhealth.lit.core.model.ContactDetail> contact)
        Parameters:
        contact - - Contact details to assist a user in finding and communicating with the publisher.

      • withContact

        public SearchParameterBuilder.Impl withContact​(@NonNull
                                               @NonNull com.babylonhealth.lit.core_java.builders.ContactDetailBuilder... contact)

      • withPurpose

        public SearchParameterBuilder.Impl withPurpose​(@NonNull
                                               @NonNull java.lang.String purpose)
        Parameters:
        purpose - - Explanation of why this search parameter is needed and why it has been designed as it has.

      • withLanguage

        public SearchParameterBuilder.Impl withLanguage​(@NonNull
                                                @NonNull com.babylonhealth.lit.core.LANGUAGES language)
        Parameters:
        language - - The base language in which the resource is written.

      • withModifier

        public SearchParameterBuilder.Impl withModifier​(@NonNull
                                                @NonNull com.babylonhealth.lit.hl7.SEARCH_MODIFIER_CODE... modifier)
        Parameters:
        modifier - - A modifier supported for the search parameter.

      • withModifier

        public SearchParameterBuilder.Impl withModifier​(@NonNull
                                                @NonNull java.util.Collection<com.babylonhealth.lit.hl7.SEARCH_MODIFIER_CODE> modifier)
        Parameters:
        modifier - - A modifier supported for the search parameter.

      • withContained

        public SearchParameterBuilder.Impl withContained​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core.model.Resource... contained)
        Parameters:
        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.

      • withContained

        public SearchParameterBuilder.Impl withContained​(@NonNull
                                                 @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Resource> contained)
        Parameters:
        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.

      • withContained

        public SearchParameterBuilder.Impl withContained​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core_java.builders.ResourceBuilder... contained)

      • withExtension

        public SearchParameterBuilder.Impl withExtension​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core.model.Extension... extension)
        Parameters:
        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.

      • withExtension

        public SearchParameterBuilder.Impl withExtension​(@NonNull
                                                 @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Extension> extension)
        Parameters:
        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.

      • withExtension

        public SearchParameterBuilder.Impl withExtension​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... extension)

      • withPublisher

        public SearchParameterBuilder.Impl withPublisher​(@NonNull
                                                 @NonNull java.lang.String publisher)
        Parameters:
        publisher - - The name of the organization or individual that published the search parameter.

      • withUseContext

        public SearchParameterBuilder.Impl withUseContext​(@NonNull
                                                  @NonNull com.babylonhealth.lit.core.model.UsageContext... useContext)
        Parameters:
        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.

      • withUseContext

        public SearchParameterBuilder.Impl withUseContext​(@NonNull
                                                  @NonNull java.util.Collection<com.babylonhealth.lit.core.model.UsageContext> useContext)
        Parameters:
        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.

      • withUseContext

        public SearchParameterBuilder.Impl withUseContext​(@NonNull
                                                  @NonNull com.babylonhealth.lit.core_java.builders.UsageContextBuilder... useContext)

      • withExpression

        public SearchParameterBuilder.Impl withExpression​(@NonNull
                                                  @NonNull java.lang.String expression)
        Parameters:
        expression - - A FHIRPath expression that returns a set of elements for the search parameter.

      • withXpathUsage

        public SearchParameterBuilder.Impl withXpathUsage​(@NonNull
                                                  @NonNull com.babylonhealth.lit.hl7.SEARCH_XPATH_USAGE xpathUsage)
        Parameters:
        xpathUsage - - How the search parameter relates to the set of elements returned by evaluating the xpath query.

      • withMultipleOr

        public SearchParameterBuilder.Impl withMultipleOr​(@NonNull
                                                  @NonNull java.lang.Boolean multipleOr)
        Parameters:
        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.

      • withComparator

        public SearchParameterBuilder.Impl withComparator​(@NonNull
                                                  @NonNull com.babylonhealth.lit.hl7.SEARCH_COMPARATOR... comparator)
        Parameters:
        comparator - - Comparators supported for the search parameter.

      • withComparator

        public SearchParameterBuilder.Impl withComparator​(@NonNull
                                                  @NonNull java.util.Collection<com.babylonhealth.lit.hl7.SEARCH_COMPARATOR> comparator)
        Parameters:
        comparator - - Comparators supported for the search parameter.

      • withDerivedFrom

        public SearchParameterBuilder.Impl withDerivedFrom​(@NonNull
                                                   @NonNull java.lang.String derivedFrom)
        Parameters:
        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.

      • withMultipleAnd

        public SearchParameterBuilder.Impl withMultipleAnd​(@NonNull
                                                   @NonNull java.lang.Boolean multipleAnd)
        Parameters:
        multipleAnd - - Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.

      • withExperimental

        public SearchParameterBuilder.Impl withExperimental​(@NonNull
                                                    @NonNull java.lang.Boolean experimental)
        Parameters:
        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.

      • withJurisdiction

        public SearchParameterBuilder.Impl withJurisdiction​(@NonNull
                                                    @NonNull com.babylonhealth.lit.core.model.CodeableConcept... jurisdiction)
        Parameters:
        jurisdiction - - A legal or geographic region in which the search parameter is intended to be used.

      • withJurisdiction

        public SearchParameterBuilder.Impl withJurisdiction​(@NonNull
                                                    @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> jurisdiction)
        Parameters:
        jurisdiction - - A legal or geographic region in which the search parameter is intended to be used.

      • withJurisdiction

        public SearchParameterBuilder.Impl withJurisdiction​(@NonNull
                                                    @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... jurisdiction)

      • withImplicitRules

        public SearchParameterBuilder.Impl withImplicitRules​(@NonNull
                                                     @NonNull java.lang.String implicitRules)
        Parameters:
        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.

      • withModifierExtension

        public SearchParameterBuilder.Impl withModifierExtension​(@NonNull
                                                         @NonNull com.babylonhealth.lit.core.model.Extension... modifierExtension)
        Parameters:
        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).

      • withModifierExtension

        public SearchParameterBuilder.Impl withModifierExtension​(@NonNull
                                                         @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Extension> modifierExtension)
        Parameters:
        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).

      • withModifierExtension

        public SearchParameterBuilder.Impl withModifierExtension​(@NonNull
                                                         @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... modifierExtension)

      • withComponent

        public SearchParameterBuilder.Impl withComponent​(@NonNull
                                                 @NonNull com.babylonhealth.lit.hl7.model.SearchParameter.Component... component)
        Parameters:
        component - - Used to define the parts of a composite search parameter.

      • withComponent

        public SearchParameterBuilder.Impl withComponent​(@NonNull
                                                 @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.SearchParameter.Component> component)
        Parameters:
        component - - Used to define the parts of a composite search parameter.

      • build

        public com.babylonhealth.lit.hl7.model.SearchParameter build()
        Specified by:
        build in interface DomainResourceBuilder
        Specified by:
        build in interface com.babylonhealth.lit.core_java.builders.ResourceBuilder
        Specified by:
        build in interface SearchParameterBuilder