Package org.linuxforhealth.fhir.model.resource

Class ChargeItemDefinition.Builder

    • Method Detail

      • id

        public ChargeItemDefinition.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 ChargeItemDefinition.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 ChargeItemDefinition.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 ChargeItemDefinition.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 ChargeItemDefinition.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 ChargeItemDefinition.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 ChargeItemDefinition.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 ChargeItemDefinition.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 ChargeItemDefinition.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 ChargeItemDefinition.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 ChargeItemDefinition.Builder url​(Uri url)
        An absolute URI that is used to identify this charge item 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 charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers.

        This element is required.

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

      • identifier

        public ChargeItemDefinition.Builder identifier​(Identifier... identifier)
        A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

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

        Parameters:
        identifier - Additional identifier for the charge item definition
        Returns:
        A reference to this Builder instance

      • identifier

        public ChargeItemDefinition.Builder identifier​(java.util.Collection<Identifier> identifier)
        A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

        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:
        identifier - Additional identifier for the charge item definition
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • version

        public ChargeItemDefinition.Builder version​(String version)
        The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
        Parameters:
        version - Business version of the charge item definition
        Returns:
        A reference to this Builder instance

      • title

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

      • derivedFromUri

        public ChargeItemDefinition.Builder derivedFromUri​(Uri... derivedFromUri)
        The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.

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

        Parameters:
        derivedFromUri - Underlying externally-defined charge item definition
        Returns:
        A reference to this Builder instance

      • derivedFromUri

        public ChargeItemDefinition.Builder derivedFromUri​(java.util.Collection<Uri> derivedFromUri)
        The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.

        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:
        derivedFromUri - Underlying externally-defined charge item definition
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • partOf

        public ChargeItemDefinition.Builder partOf​(Canonical... partOf)
        A larger definition of which this particular definition is a component or step.

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

        Parameters:
        partOf - A larger definition of which this particular definition is a component or step
        Returns:
        A reference to this Builder instance

      • partOf

        public ChargeItemDefinition.Builder partOf​(java.util.Collection<Canonical> partOf)
        A larger definition of which this particular definition is a component or step.

        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:
        partOf - A larger definition of which this particular definition is a component or step
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • replaces

        public ChargeItemDefinition.Builder replaces​(Canonical... replaces)
        As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.

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

        Parameters:
        replaces - Completed or terminated request(s) whose function is taken by this new request
        Returns:
        A reference to this Builder instance

      • replaces

        public ChargeItemDefinition.Builder replaces​(java.util.Collection<Canonical> replaces)
        As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.

        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:
        replaces - Completed or terminated request(s) whose function is taken by this new request
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • status

        public ChargeItemDefinition.Builder status​(PublicationStatus status)
        The current state of the ChargeItemDefinition.

        This element is required.

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

      • experimental

        public ChargeItemDefinition.Builder experimental​(Boolean experimental)
        A Boolean value to indicate that this charge item 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 ChargeItemDefinition.Builder date​(DateTime date)
        The date (and optionally time) when the charge item 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 charge item definition changes.
        Parameters:
        date - Date last changed
        Returns:
        A reference to this Builder instance

      • publisher

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

      • contact

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

      • useContext

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

      • jurisdiction

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

      • copyright

        public ChargeItemDefinition.Builder copyright​(Markdown copyright)
        A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.
        Parameters:
        copyright - Use and/or publishing restrictions
        Returns:
        A reference to this Builder instance

      • approvalDate

        public ChargeItemDefinition.Builder approvalDate​(Date approvalDate)
        The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
        Parameters:
        approvalDate - When the charge item definition was approved by publisher
        Returns:
        A reference to this Builder instance

      • lastReviewDate

        public ChargeItemDefinition.Builder lastReviewDate​(Date lastReviewDate)
        The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
        Parameters:
        lastReviewDate - When the charge item definition was last reviewed
        Returns:
        A reference to this Builder instance

      • effectivePeriod

        public ChargeItemDefinition.Builder effectivePeriod​(Period effectivePeriod)
        The period during which the charge item definition content was or is planned to be in active use.
        Parameters:
        effectivePeriod - When the charge item definition is expected to be used
        Returns:
        A reference to this Builder instance

      • code

        public ChargeItemDefinition.Builder code​(CodeableConcept code)
        The defined billing details in this resource pertain to the given billing code.
        Parameters:
        code - Billing codes or product types this definition applies to
        Returns:
        A reference to this Builder instance

      • instance

        public ChargeItemDefinition.Builder instance​(Reference... instance)
        The defined billing details in this resource pertain to the given product instance(s).

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

        Allowed resource types for the references:

        Parameters:
        instance - Instances this definition applies to
        Returns:
        A reference to this Builder instance

      • instance

        public ChargeItemDefinition.Builder instance​(java.util.Collection<Reference> instance)
        The defined billing details in this resource pertain to the given product instance(s).

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

        Allowed resource types for the references:

        Parameters:
        instance - Instances this definition applies to
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • applicability

        public ChargeItemDefinition.Builder applicability​(ChargeItemDefinition.Applicability... applicability)
        Expressions that describe applicability criteria for the billing code.

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

        Parameters:
        applicability - Whether or not the billing code is applicable
        Returns:
        A reference to this Builder instance

      • applicability

        public ChargeItemDefinition.Builder applicability​(java.util.Collection<ChargeItemDefinition.Applicability> applicability)
        Expressions that describe applicability criteria for the billing code.

        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:
        applicability - Whether or not the billing code is applicable
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • propertyGroup

        public ChargeItemDefinition.Builder propertyGroup​(ChargeItemDefinition.PropertyGroup... propertyGroup)
        Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.

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

        Parameters:
        propertyGroup - Group of properties which are applicable under the same conditions
        Returns:
        A reference to this Builder instance

      • propertyGroup

        public ChargeItemDefinition.Builder propertyGroup​(java.util.Collection<ChargeItemDefinition.PropertyGroup> propertyGroup)
        Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.

        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:
        propertyGroup - Group of properties which are applicable under the same conditions
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null