Package org.linuxforhealth.fhir.model.resource

Class Account.Builder

    • Method Detail

      • id

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

      • language

        public Account.Builder language​(Code language)
        The base language in which the resource is written.
        Overrides:
        language in class DomainResource.Builder
        Parameters:
        language - Language of the resource content
        Returns:
        A reference to this Builder instance

      • text

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

      • identifier

        public Account.Builder identifier​(Identifier... identifier)
        Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number).

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

        Parameters:
        identifier - Account number
        Returns:
        A reference to this Builder instance

      • identifier

        public Account.Builder identifier​(java.util.Collection<Identifier> identifier)
        Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number).

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

      • status

        public Account.Builder status​(AccountStatus status)
        Indicates whether the account is presently used/usable or not.

        This element is required.

        Parameters:
        status - active | inactive | entered-in-error | on-hold | unknown
        Returns:
        A reference to this Builder instance

      • type

        public Account.Builder type​(CodeableConcept type)
        Categorizes the account for reporting and searching purposes.
        Parameters:
        type - E.g. patient, expense, depreciation
        Returns:
        A reference to this Builder instance

      • name

        public Account.Builder name​(String name)
        Name used for the account when displaying it to humans in reports, etc.
        Parameters:
        name - Human-readable label
        Returns:
        A reference to this Builder instance

      • subject

        public Account.Builder subject​(Reference... subject)
        Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.

        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:
        subject - The entity that caused the expenses
        Returns:
        A reference to this Builder instance

      • subject

        public Account.Builder subject​(java.util.Collection<Reference> subject)
        Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.

        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:
        subject - The entity that caused the expenses
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • servicePeriod

        public Account.Builder servicePeriod​(Period servicePeriod)
        The date range of services associated with this account.
        Parameters:
        servicePeriod - Transaction window
        Returns:
        A reference to this Builder instance

      • coverage

        public Account.Builder coverage​(Account.Coverage... coverage)
        The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.

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

        Parameters:
        coverage - The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
        Returns:
        A reference to this Builder instance

      • coverage

        public Account.Builder coverage​(java.util.Collection<Account.Coverage> coverage)
        The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.

        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:
        coverage - The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • owner

        public Account.Builder owner​(Reference owner)
        Indicates the service area, hospital, department, etc. with responsibility for managing the Account.

        Allowed resource types for this reference:

        Parameters:
        owner - Entity managing the Account
        Returns:
        A reference to this Builder instance

      • description

        public Account.Builder description​(String description)
        Provides additional information about what the account tracks and how it is used.
        Parameters:
        description - Explanation of purpose/use
        Returns:
        A reference to this Builder instance

      • guarantor

        public Account.Builder guarantor​(Account.Guarantor... guarantor)
        The parties responsible for balancing the account if other payment options fall short.

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

        Parameters:
        guarantor - The parties ultimately responsible for balancing the Account
        Returns:
        A reference to this Builder instance

      • guarantor

        public Account.Builder guarantor​(java.util.Collection<Account.Guarantor> guarantor)
        The parties responsible for balancing the account if other payment options fall short.

        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:
        guarantor - The parties ultimately responsible for balancing the Account
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • partOf

        public Account.Builder partOf​(Reference partOf)
        Reference to a parent Account.

        Allowed resource types for this reference:

        Parameters:
        partOf - Reference to a parent Account
        Returns:
        A reference to this Builder instance

      • build

        public Account build()
        Build the Account

        Required elements:

        • status
        Specified by:
        build in interface Builder<Resource>
        Specified by:
        build in class DomainResource.Builder
        Returns:
        An immutable object of type Account
        Throws:
        java.lang.IllegalStateException - if the current state cannot be built into a valid Account per the base specification

      • validate

        protected void validate​(Account account)