Package com.ibm.fhir.model.resource

Class MedicinalProduct.Builder

    • Method Detail

      • id

        public MedicinalProduct.Builder id​(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 MedicinalProduct.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 MedicinalProduct.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 MedicinalProduct.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 MedicinalProduct.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 MedicinalProduct.Builder contained​(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:
        NullPointerException - If the passed collection is null

      • extension

        public MedicinalProduct.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 MedicinalProduct.Builder extension​(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:
        NullPointerException - If the passed collection is null

      • modifierExtension

        public MedicinalProduct.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 MedicinalProduct.Builder modifierExtension​(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:
        NullPointerException - If the passed collection is null

      • identifier

        public MedicinalProduct.Builder identifier​(Identifier... identifier)
        Business identifier for this product. Could be an MPID.

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

        Parameters:
        identifier - Business identifier for this product. Could be an MPID
        Returns:
        A reference to this Builder instance

      • identifier

        public MedicinalProduct.Builder identifier​(Collection<Identifier> identifier)
        Business identifier for this product. Could be an MPID.

        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 - Business identifier for this product. Could be an MPID
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • type

        public MedicinalProduct.Builder type​(CodeableConcept type)
        Regulatory type, e.g. Investigational or Authorized.
        Parameters:
        type - Regulatory type, e.g. Investigational or Authorized
        Returns:
        A reference to this Builder instance

      • domain

        public MedicinalProduct.Builder domain​(Coding domain)
        If this medicine applies to human or veterinary uses.
        Parameters:
        domain - If this medicine applies to human or veterinary uses
        Returns:
        A reference to this Builder instance

      • combinedPharmaceuticalDoseForm

        public MedicinalProduct.Builder combinedPharmaceuticalDoseForm​(CodeableConcept combinedPharmaceuticalDoseForm)
        The dose form for a single part product, or combined form of a multiple part product.
        Parameters:
        combinedPharmaceuticalDoseForm - The dose form for a single part product, or combined form of a multiple part product
        Returns:
        A reference to this Builder instance

      • legalStatusOfSupply

        public MedicinalProduct.Builder legalStatusOfSupply​(CodeableConcept legalStatusOfSupply)
        The legal status of supply of the medicinal product as classified by the regulator.
        Parameters:
        legalStatusOfSupply - The legal status of supply of the medicinal product as classified by the regulator
        Returns:
        A reference to this Builder instance

      • additionalMonitoringIndicator

        public MedicinalProduct.Builder additionalMonitoringIndicator​(CodeableConcept additionalMonitoringIndicator)
        Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.
        Parameters:
        additionalMonitoringIndicator - Whether the Medicinal Product is subject to additional monitoring for regulatory reasons
        Returns:
        A reference to this Builder instance

      • specialMeasures

        public MedicinalProduct.Builder specialMeasures​(String... specialMeasures)
        Convenience method for setting specialMeasures.

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

        Parameters:
        specialMeasures - Whether the Medicinal Product is subject to special measures for regulatory reasons
        Returns:
        A reference to this Builder instance
        See Also:
        #specialMeasures(com.ibm.fhir.model.type.String)

      • specialMeasures

        public MedicinalProduct.Builder specialMeasures​(String... specialMeasures)
        Whether the Medicinal Product is subject to special measures for regulatory reasons.

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

        Parameters:
        specialMeasures - Whether the Medicinal Product is subject to special measures for regulatory reasons
        Returns:
        A reference to this Builder instance

      • specialMeasures

        public MedicinalProduct.Builder specialMeasures​(Collection<String> specialMeasures)
        Whether the Medicinal Product is subject to special measures for regulatory reasons.

        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:
        specialMeasures - Whether the Medicinal Product is subject to special measures for regulatory reasons
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • paediatricUseIndicator

        public MedicinalProduct.Builder paediatricUseIndicator​(CodeableConcept paediatricUseIndicator)
        If authorised for use in children.
        Parameters:
        paediatricUseIndicator - If authorised for use in children
        Returns:
        A reference to this Builder instance

      • productClassification

        public MedicinalProduct.Builder productClassification​(CodeableConcept... productClassification)
        Allows the product to be classified by various systems.

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

        Parameters:
        productClassification - Allows the product to be classified by various systems
        Returns:
        A reference to this Builder instance

      • productClassification

        public MedicinalProduct.Builder productClassification​(Collection<CodeableConcept> productClassification)
        Allows the product to be classified by various systems.

        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:
        productClassification - Allows the product to be classified by various systems
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • marketingStatus

        public MedicinalProduct.Builder marketingStatus​(MarketingStatus... marketingStatus)
        Marketing status of the medicinal product, in contrast to marketing authorizaton.

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

        Parameters:
        marketingStatus - Marketing status of the medicinal product, in contrast to marketing authorizaton
        Returns:
        A reference to this Builder instance

      • marketingStatus

        public MedicinalProduct.Builder marketingStatus​(Collection<MarketingStatus> marketingStatus)
        Marketing status of the medicinal product, in contrast to marketing authorizaton.

        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 - Marketing status of the medicinal product, in contrast to marketing authorizaton
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • pharmaceuticalProduct

        public MedicinalProduct.Builder pharmaceuticalProduct​(Reference... pharmaceuticalProduct)
        Pharmaceutical aspects of product.

        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:
        pharmaceuticalProduct - Pharmaceutical aspects of product
        Returns:
        A reference to this Builder instance

      • pharmaceuticalProduct

        public MedicinalProduct.Builder pharmaceuticalProduct​(Collection<Reference> pharmaceuticalProduct)
        Pharmaceutical aspects of product.

        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:
        pharmaceuticalProduct - Pharmaceutical aspects of product
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • packagedMedicinalProduct

        public MedicinalProduct.Builder packagedMedicinalProduct​(Reference... packagedMedicinalProduct)
        Package representation for the product.

        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:
        packagedMedicinalProduct - Package representation for the product
        Returns:
        A reference to this Builder instance

      • packagedMedicinalProduct

        public MedicinalProduct.Builder packagedMedicinalProduct​(Collection<Reference> packagedMedicinalProduct)
        Package representation for the product.

        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:
        packagedMedicinalProduct - Package representation for the product
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • attachedDocument

        public MedicinalProduct.Builder attachedDocument​(Reference... attachedDocument)
        Supporting documentation, typically for regulatory submission.

        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:
        attachedDocument - Supporting documentation, typically for regulatory submission
        Returns:
        A reference to this Builder instance

      • attachedDocument

        public MedicinalProduct.Builder attachedDocument​(Collection<Reference> attachedDocument)
        Supporting documentation, typically for regulatory submission.

        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:
        attachedDocument - Supporting documentation, typically for regulatory submission
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • masterFile

        public MedicinalProduct.Builder masterFile​(Reference... masterFile)
        A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).

        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:
        masterFile - A master file for to the medicinal product (e.g. Pharmacovigilance System Master File)
        Returns:
        A reference to this Builder instance

      • masterFile

        public MedicinalProduct.Builder masterFile​(Collection<Reference> masterFile)
        A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).

        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:
        masterFile - A master file for to the medicinal product (e.g. Pharmacovigilance System Master File)
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • contact

        public MedicinalProduct.Builder contact​(Reference... contact)
        A product specific contact, person (in a role), or an organization.

        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:
        contact - A product specific contact, person (in a role), or an organization
        Returns:
        A reference to this Builder instance

      • contact

        public MedicinalProduct.Builder contact​(Collection<Reference> contact)
        A product specific contact, person (in a role), or an organization.

        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:
        contact - A product specific contact, person (in a role), or an organization
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • clinicalTrial

        public MedicinalProduct.Builder clinicalTrial​(Reference... clinicalTrial)
        Clinical trials or studies that this product is involved in.

        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:
        clinicalTrial - Clinical trials or studies that this product is involved in
        Returns:
        A reference to this Builder instance

      • clinicalTrial

        public MedicinalProduct.Builder clinicalTrial​(Collection<Reference> clinicalTrial)
        Clinical trials or studies that this product is involved in.

        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:
        clinicalTrial - Clinical trials or studies that this product is involved in
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • name

        public MedicinalProduct.Builder name​(MedicinalProduct.Name... name)
        The product's name, including full name and possibly coded parts.

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

        This element is required.

        Parameters:
        name - The product's name, including full name and possibly coded parts
        Returns:
        A reference to this Builder instance

      • name

        public MedicinalProduct.Builder name​(Collection<MedicinalProduct.Name> name)
        The product's name, including full name and possibly coded parts.

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

        This element is required.

        Parameters:
        name - The product's name, including full name and possibly coded parts
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • crossReference

        public MedicinalProduct.Builder crossReference​(Identifier... crossReference)
        Reference to another product, e.g. for linking authorised to investigational product.

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

        Parameters:
        crossReference - Reference to another product, e.g. for linking authorised to investigational product
        Returns:
        A reference to this Builder instance

      • crossReference

        public MedicinalProduct.Builder crossReference​(Collection<Identifier> crossReference)
        Reference to another product, e.g. for linking authorised to investigational product.

        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:
        crossReference - Reference to another product, e.g. for linking authorised to investigational product
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • manufacturingBusinessOperation

        public MedicinalProduct.Builder manufacturingBusinessOperation​(MedicinalProduct.ManufacturingBusinessOperation... manufacturingBusinessOperation)
        An operation applied to the product, for manufacturing or adminsitrative purpose.

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

        Parameters:
        manufacturingBusinessOperation - An operation applied to the product, for manufacturing or adminsitrative purpose
        Returns:
        A reference to this Builder instance

      • manufacturingBusinessOperation

        public MedicinalProduct.Builder manufacturingBusinessOperation​(Collection<MedicinalProduct.ManufacturingBusinessOperation> manufacturingBusinessOperation)
        An operation applied to the product, for manufacturing or adminsitrative purpose.

        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:
        manufacturingBusinessOperation - An operation applied to the product, for manufacturing or adminsitrative purpose
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • specialDesignation

        public MedicinalProduct.Builder specialDesignation​(MedicinalProduct.SpecialDesignation... specialDesignation)
        Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.

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

        Parameters:
        specialDesignation - Indicates if the medicinal product has an orphan designation for the treatment of a rare disease
        Returns:
        A reference to this Builder instance

      • specialDesignation

        public MedicinalProduct.Builder specialDesignation​(Collection<MedicinalProduct.SpecialDesignation> specialDesignation)
        Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.

        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:
        specialDesignation - Indicates if the medicinal product has an orphan designation for the treatment of a rare disease
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null