Package com.babylonhealth.lit.hl7_java.builders

Class OperationDefinitionBuilder.Impl

    • Constructor Detail

      • Impl

        public Impl​(java.lang.String name,
            com.babylonhealth.lit.hl7.OPERATION_KIND kind,
            java.lang.String code,
            java.lang.Boolean _type,
            com.babylonhealth.lit.hl7.PUBLICATION_STATUS status,
            java.lang.Boolean system,
            java.lang.Boolean instance)
        Required fields for OperationDefinition
        Parameters:
        name - - A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        kind - - Whether this is an operation or a named query.
        code - - The name used to invoke the operation.
        _type - - Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).
        status - - The status of this operation definition. Enables tracking the life-cycle of the content.
        system - - Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).
        instance - - Indicates whether this operation can be invoked on a particular instance of one of the given types.

    • Method Detail

      • withId

        public OperationDefinitionBuilder.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.

      • withUrl

        public OperationDefinitionBuilder.Impl withUrl​(@NonNull
                                               @NonNull java.lang.String url)
        Parameters:
        url - - An absolute URI that is used to identify this operation definition 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 operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.

      • withMeta

        public OperationDefinitionBuilder.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.

      • withText

        public OperationDefinitionBuilder.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 OperationDefinitionBuilder.Impl withDate​(@NonNull
                                                @NonNull com.babylonhealth.lit.core.FHIRDateTime date)
        Parameters:
        date - - The date (and optionally time) when the operation definition 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 operation definition changes.

      • withBase

        public OperationDefinitionBuilder.Impl withBase​(@NonNull
                                                @NonNull java.lang.String base)
        Parameters:
        base - - Indicates that this operation definition is a constraining profile on the base.

      • withTitle

        public OperationDefinitionBuilder.Impl withTitle​(@NonNull
                                                 @NonNull java.lang.String title)
        Parameters:
        title - - A short, descriptive, user-friendly title for the operation definition.

      • withVersion

        public OperationDefinitionBuilder.Impl withVersion​(@NonNull
                                                   @NonNull java.lang.String version)
        Parameters:
        version - - The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition 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 OperationDefinitionBuilder.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 OperationDefinitionBuilder.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 OperationDefinitionBuilder.Impl withContact​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core_java.builders.ContactDetailBuilder... contact)

      • withPurpose

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

      • withComment

        public OperationDefinitionBuilder.Impl withComment​(@NonNull
                                                   @NonNull java.lang.String comment)
        Parameters:
        comment - - Additional information about how to use this operation or named query.

      • withLanguage

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

      • withResource

        public OperationDefinitionBuilder.Impl withResource​(@NonNull
                                                    @NonNull com.babylonhealth.lit.hl7.RESOURCE_TYPES... resource)
        Parameters:
        resource - - The types on which this operation can be executed.

      • withResource

        public OperationDefinitionBuilder.Impl withResource​(@NonNull
                                                    @NonNull java.util.Collection<com.babylonhealth.lit.hl7.RESOURCE_TYPES> resource)
        Parameters:
        resource - - The types on which this operation can be executed.

      • withContained

        public OperationDefinitionBuilder.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 OperationDefinitionBuilder.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 OperationDefinitionBuilder.Impl withContained​(@NonNull
                                                     @NonNull com.babylonhealth.lit.core_java.builders.ResourceBuilder... contained)

      • withExtension

        public OperationDefinitionBuilder.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 OperationDefinitionBuilder.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 OperationDefinitionBuilder.Impl withExtension​(@NonNull
                                                     @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... extension)

      • withPublisher

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

      • withUseContext

        public OperationDefinitionBuilder.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 operation definition instances.

      • withUseContext

        public OperationDefinitionBuilder.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 operation definition instances.

      • withUseContext

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

      • withDescription

        public OperationDefinitionBuilder.Impl withDescription​(@NonNull
                                                       @NonNull java.lang.String description)
        Parameters:
        description - - A free text natural language description of the operation definition from a consumer's perspective.

      • withExperimental

        public OperationDefinitionBuilder.Impl withExperimental​(@NonNull
                                                        @NonNull java.lang.Boolean experimental)
        Parameters:
        experimental - - A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

      • withJurisdiction

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

      • withJurisdiction

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

      • withJurisdiction

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

      • withAffectsState

        public OperationDefinitionBuilder.Impl withAffectsState​(@NonNull
                                                        @NonNull java.lang.Boolean affectsState)
        Parameters:
        affectsState - - Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.

      • withInputProfile

        public OperationDefinitionBuilder.Impl withInputProfile​(@NonNull
                                                        @NonNull java.lang.String inputProfile)
        Parameters:
        inputProfile - - Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.

      • withImplicitRules

        public OperationDefinitionBuilder.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.

      • withOutputProfile

        public OperationDefinitionBuilder.Impl withOutputProfile​(@NonNull
                                                         @NonNull java.lang.String outputProfile)
        Parameters:
        outputProfile - - Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.

      • withModifierExtension

        public OperationDefinitionBuilder.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 OperationDefinitionBuilder.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 OperationDefinitionBuilder.Impl withModifierExtension​(@NonNull
                                                             @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... modifierExtension)

      • withOverload

        public OperationDefinitionBuilder.Impl withOverload​(@NonNull
                                                    @NonNull com.babylonhealth.lit.hl7.model.OperationDefinition.Overload... overload)
        Parameters:
        overload - - Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.

      • withOverload

        public OperationDefinitionBuilder.Impl withOverload​(@NonNull
                                                    @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.OperationDefinition.Overload> overload)
        Parameters:
        overload - - Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.

      • withParameter

        public OperationDefinitionBuilder.Impl withParameter​(@NonNull
                                                     @NonNull com.babylonhealth.lit.hl7.model.OperationDefinition.Parameter... parameter)
        Parameters:
        parameter - - The parameters for the operation/query.

      • withParameter

        public OperationDefinitionBuilder.Impl withParameter​(@NonNull
                                                     @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.OperationDefinition.Parameter> parameter)
        Parameters:
        parameter - - The parameters for the operation/query.

      • build

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