Package org.linuxforhealth.fhir.model.resource

Class PackagedProductDefinition.Builder

    • Method Detail

      • id

        public PackagedProductDefinition.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 PackagedProductDefinition.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 PackagedProductDefinition.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 PackagedProductDefinition.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 PackagedProductDefinition.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 PackagedProductDefinition.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 PackagedProductDefinition.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 PackagedProductDefinition.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 PackagedProductDefinition.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 PackagedProductDefinition.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 PackagedProductDefinition.Builder identifier​(Identifier... identifier)
        A unique identifier for this package as whole. Unique instance identifiers assigned to a package by manufacturers, regulators, drug catalogue custodians or other organizations.

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

        Parameters:
        identifier - A unique identifier for this package as whole
        Returns:
        A reference to this Builder instance

      • identifier

        public PackagedProductDefinition.Builder identifier​(java.util.Collection<Identifier> identifier)
        A unique identifier for this package as whole. Unique instance identifiers assigned to a package by manufacturers, regulators, drug catalogue custodians or other organizations.

        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 - A unique identifier for this package as whole
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • name

        public PackagedProductDefinition.Builder name​(String name)
        A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.
        Parameters:
        name - A name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
        Returns:
        A reference to this Builder instance

      • type

        public PackagedProductDefinition.Builder type​(CodeableConcept type)
        A high level category e.g. medicinal product, raw material, shipping/transport container, etc.
        Parameters:
        type - A high level category e.g. medicinal product, raw material, shipping container etc
        Returns:
        A reference to this Builder instance

      • packageFor

        public PackagedProductDefinition.Builder packageFor​(Reference... packageFor)
        The product that this is a pack for.

        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:
        packageFor - The product that this is a pack for
        Returns:
        A reference to this Builder instance

      • packageFor

        public PackagedProductDefinition.Builder packageFor​(java.util.Collection<Reference> packageFor)
        The product that this is a pack for.

        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:
        packageFor - The product that this is a pack for
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • status

        public PackagedProductDefinition.Builder status​(CodeableConcept status)
        The status within the lifecycle of this item. A high level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization or marketing status.
        Parameters:
        status - The status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
        Returns:
        A reference to this Builder instance

      • statusDate

        public PackagedProductDefinition.Builder statusDate​(DateTime statusDate)
        The date at which the given status became applicable.
        Parameters:
        statusDate - The date at which the given status became applicable
        Returns:
        A reference to this Builder instance

      • containedItemQuantity

        public PackagedProductDefinition.Builder containedItemQuantity​(Quantity... containedItemQuantity)
        A total of the complete count of contained items of a particular type/form, independent of sub-packaging or organization. This can be considered as the pack size. This attribute differs from containedItem.amount in that it can give a single aggregated count of all tablet types in a pack, even when these are different manufactured items. For example a pill pack of 21 tablets plus 7 sugar tablets, can be denoted here as '28 tablets'. This attribute is repeatable so that the different item types in one pack type can be counted (e.g. a count of vials and count of syringes). Each repeat must have different units, so that it is clear what the different sets of counted items are, and it is not intended to allow different counts of similar items (e.g. not '2 tubes and 3 tubes'). Repeats are not to be used to represent different pack sizes (e.g. 20 pack vs. 50 pack) - which would be different instances of this resource.

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

        Parameters:
        containedItemQuantity - A total of the complete count of contained items of a particular type/form, independent of sub-packaging or organization. This can be considered as the pack size
        Returns:
        A reference to this Builder instance

      • containedItemQuantity

        public PackagedProductDefinition.Builder containedItemQuantity​(java.util.Collection<Quantity> containedItemQuantity)
        A total of the complete count of contained items of a particular type/form, independent of sub-packaging or organization. This can be considered as the pack size. This attribute differs from containedItem.amount in that it can give a single aggregated count of all tablet types in a pack, even when these are different manufactured items. For example a pill pack of 21 tablets plus 7 sugar tablets, can be denoted here as '28 tablets'. This attribute is repeatable so that the different item types in one pack type can be counted (e.g. a count of vials and count of syringes). Each repeat must have different units, so that it is clear what the different sets of counted items are, and it is not intended to allow different counts of similar items (e.g. not '2 tubes and 3 tubes'). Repeats are not to be used to represent different pack sizes (e.g. 20 pack vs. 50 pack) - which would be different instances of this resource.

        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:
        containedItemQuantity - A total of the complete count of contained items of a particular type/form, independent of sub-packaging or organization. This can be considered as the pack size
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • description

        public PackagedProductDefinition.Builder description​(Markdown description)
        Textual description. Note that this is not the name of the package or product.
        Parameters:
        description - Textual description. Note that this is not the name of the package or product
        Returns:
        A reference to this Builder instance

      • legalStatusOfSupply

        public PackagedProductDefinition.Builder legalStatusOfSupply​(PackagedProductDefinition.LegalStatusOfSupply... legalStatusOfSupply)
        The legal status of supply of the packaged item as classified by the regulator.

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

        Parameters:
        legalStatusOfSupply - The legal status of supply of the packaged item as classified by the regulator
        Returns:
        A reference to this Builder instance

      • legalStatusOfSupply

        public PackagedProductDefinition.Builder legalStatusOfSupply​(java.util.Collection<PackagedProductDefinition.LegalStatusOfSupply> legalStatusOfSupply)
        The legal status of supply of the packaged item as classified by the regulator.

        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:
        legalStatusOfSupply - The legal status of supply of the packaged item as classified by the regulator
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • marketingStatus

        public PackagedProductDefinition.Builder marketingStatus​(MarketingStatus... marketingStatus)
        Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated.

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

        Parameters:
        marketingStatus - Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated
        Returns:
        A reference to this Builder instance

      • marketingStatus

        public PackagedProductDefinition.Builder marketingStatus​(java.util.Collection<MarketingStatus> marketingStatus)
        Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated.

        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:
        marketingStatus - Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • characteristic

        public PackagedProductDefinition.Builder characteristic​(CodeableConcept... characteristic)
        Allows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack".

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

        Parameters:
        characteristic - Allows the key features to be recorded, such as "hospital pack", "nurse prescribable"
        Returns:
        A reference to this Builder instance

      • characteristic

        public PackagedProductDefinition.Builder characteristic​(java.util.Collection<CodeableConcept> characteristic)
        Allows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack".

        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:
        characteristic - Allows the key features to be recorded, such as "hospital pack", "nurse prescribable"
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • copackagedIndicator

        public PackagedProductDefinition.Builder copackagedIndicator​(Boolean copackagedIndicator)
        States whether a drug product is supplied with another item such as a diluent or adjuvant.
        Parameters:
        copackagedIndicator - If the drug product is supplied with another item such as a diluent or adjuvant
        Returns:
        A reference to this Builder instance

      • manufacturer

        public PackagedProductDefinition.Builder manufacturer​(Reference... manufacturer)
        Manufacturer of this package type. When there are multiple it means these are all possible manufacturers.

        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:
        manufacturer - Manufacturer of this package type (multiple means these are all possible manufacturers)
        Returns:
        A reference to this Builder instance

      • manufacturer

        public PackagedProductDefinition.Builder manufacturer​(java.util.Collection<Reference> manufacturer)
        Manufacturer of this package type. When there are multiple it means these are all possible manufacturers.

        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:
        manufacturer - Manufacturer of this package type (multiple means these are all possible manufacturers)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • _package

        public PackagedProductDefinition.Builder _package​(PackagedProductDefinition.Package _package)
        A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap (which is not a device or a medication manufactured item).
        Parameters:
        _package - A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap
        Returns:
        A reference to this Builder instance