Package com.ibm.fhir.model.resource

Class OperationDefinition.Builder

    • Method Detail

      • id

        public OperationDefinition.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 OperationDefinition.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 OperationDefinition.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 OperationDefinition.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 OperationDefinition.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 OperationDefinition.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 OperationDefinition.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 OperationDefinition.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 OperationDefinition.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 OperationDefinition.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 OperationDefinition.Builder url​(Uri 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.
        Parameters:
        url - Canonical identifier for this operation definition, represented as a URI (globally unique)
        Returns:
        A reference to this Builder instance

      • version

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

      • name

        public OperationDefinition.Builder name​(String 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.

        This element is required.

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

      • title

        public OperationDefinition.Builder title​(String title)
        A short, descriptive, user-friendly title for the operation definition.
        Parameters:
        title - Name for this operation definition (human friendly)
        Returns:
        A reference to this Builder instance

      • status

        public OperationDefinition.Builder status​(PublicationStatus status)
        The status of this operation definition. 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

      • kind

        public OperationDefinition.Builder kind​(OperationKind kind)
        Whether this is an operation or a named query.

        This element is required.

        Parameters:
        kind - operation | query
        Returns:
        A reference to this Builder instance

      • experimental

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

      • date

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

      • publisher

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

      • contact

        public OperationDefinition.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 OperationDefinition.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 OperationDefinition.Builder description​(Markdown description)
        A free text natural language description of the operation definition from a consumer's perspective.
        Parameters:
        description - Natural language description of the operation definition
        Returns:
        A reference to this Builder instance

      • useContext

        public OperationDefinition.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 operation definition 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 OperationDefinition.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 operation definition 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 OperationDefinition.Builder jurisdiction​(CodeableConcept... jurisdiction)
        A legal or geographic region in which the operation definition 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 operation definition (if applicable)
        Returns:
        A reference to this Builder instance

      • jurisdiction

        public OperationDefinition.Builder jurisdiction​(java.util.Collection<CodeableConcept> jurisdiction)
        A legal or geographic region in which the operation definition 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 operation definition (if applicable)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • purpose

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

      • affectsState

        public OperationDefinition.Builder affectsState​(Boolean affectsState)
        Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.
        Parameters:
        affectsState - Whether content is changed by the operation
        Returns:
        A reference to this Builder instance

      • code

        public OperationDefinition.Builder code​(Code code)
        The name used to invoke the operation.

        This element is required.

        Parameters:
        code - Name used to invoke the operation
        Returns:
        A reference to this Builder instance

      • comment

        public OperationDefinition.Builder comment​(Markdown comment)
        Additional information about how to use this operation or named query.
        Parameters:
        comment - Additional information about use
        Returns:
        A reference to this Builder instance

      • base

        public OperationDefinition.Builder base​(Canonical base)
        Indicates that this operation definition is a constraining profile on the base.
        Parameters:
        base - Marks this as a profile of the base
        Returns:
        A reference to this Builder instance

      • resource

        public OperationDefinition.Builder resource​(ResourceType... resource)
        The types on which this operation can be executed.

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

        Parameters:
        resource - Types this operation applies to
        Returns:
        A reference to this Builder instance

      • resource

        public OperationDefinition.Builder resource​(java.util.Collection<ResourceType> resource)
        The types on which this operation can be executed.

        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:
        resource - Types this operation applies to
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • system

        public OperationDefinition.Builder system​(Boolean 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).

        This element is required.

        Parameters:
        system - Invoke at the system level?
        Returns:
        A reference to this Builder instance

      • type

        public OperationDefinition.Builder type​(Boolean 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).

        This element is required.

        Parameters:
        type - Invoke at the type level?
        Returns:
        A reference to this Builder instance

      • instance

        public OperationDefinition.Builder instance​(Boolean instance)
        Indicates whether this operation can be invoked on a particular instance of one of the given types.

        This element is required.

        Parameters:
        instance - Invoke on an instance?
        Returns:
        A reference to this Builder instance

      • inputProfile

        public OperationDefinition.Builder inputProfile​(Canonical 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.
        Parameters:
        inputProfile - Validation information for in parameters
        Returns:
        A reference to this Builder instance

      • outputProfile

        public OperationDefinition.Builder outputProfile​(Canonical 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.
        Parameters:
        outputProfile - Validation information for out parameters
        Returns:
        A reference to this Builder instance

      • parameter

        public OperationDefinition.Builder parameter​(OperationDefinition.Parameter... parameter)
        The parameters for the operation/query.

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

        Parameters:
        parameter - Parameters for the operation/query
        Returns:
        A reference to this Builder instance

      • parameter

        public OperationDefinition.Builder parameter​(java.util.Collection<OperationDefinition.Parameter> parameter)
        The parameters for the operation/query.

        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:
        parameter - Parameters for the operation/query
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • overload

        public OperationDefinition.Builder overload​(OperationDefinition.Overload... 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.

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

        Parameters:
        overload - Define overloaded variants for when generating code
        Returns:
        A reference to this Builder instance

      • overload

        public OperationDefinition.Builder overload​(java.util.Collection<OperationDefinition.Overload> 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.

        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:
        overload - Define overloaded variants for when generating code
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null