Package com.ibm.fhir.model.resource

Class MedicationKnowledge.Builder

    • Method Detail

      • id

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

      • code

        public MedicationKnowledge.Builder code​(CodeableConcept code)
        A code that specifies this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
        Parameters:
        code - Code that identifies this medication
        Returns:
        A reference to this Builder instance

      • status

        public MedicationKnowledge.Builder status​(MedicationKnowledgeStatus status)
        A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties.
        Parameters:
        status - active | inactive | entered-in-error
        Returns:
        A reference to this Builder instance

      • manufacturer

        public MedicationKnowledge.Builder manufacturer​(Reference manufacturer)
        Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.

        Allowed resource types for this reference:

        Parameters:
        manufacturer - Manufacturer of the item
        Returns:
        A reference to this Builder instance

      • doseForm

        public MedicationKnowledge.Builder doseForm​(CodeableConcept doseForm)
        Describes the form of the item. Powder; tablets; capsule.
        Parameters:
        doseForm - powder | tablets | capsule +
        Returns:
        A reference to this Builder instance

      • amount

        public MedicationKnowledge.Builder amount​(SimpleQuantity amount)
        Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).
        Parameters:
        amount - Amount of drug in package
        Returns:
        A reference to this Builder instance

      • synonym

        public MedicationKnowledge.Builder synonym​(String... synonym)
        Convenience method for setting synonym.

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

        Parameters:
        synonym - Additional names for a medication
        Returns:
        A reference to this Builder instance
        See Also:
        #synonym(com.ibm.fhir.model.type.String)

      • synonym

        public MedicationKnowledge.Builder synonym​(String... synonym)
        Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.

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

        Parameters:
        synonym - Additional names for a medication
        Returns:
        A reference to this Builder instance

      • synonym

        public MedicationKnowledge.Builder synonym​(Collection<String> synonym)
        Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.

        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:
        synonym - Additional names for a medication
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • relatedMedicationKnowledge

        public MedicationKnowledge.Builder relatedMedicationKnowledge​(MedicationKnowledge.RelatedMedicationKnowledge... relatedMedicationKnowledge)
        Associated or related knowledge about a medication.

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

        Parameters:
        relatedMedicationKnowledge - Associated or related medication information
        Returns:
        A reference to this Builder instance

      • relatedMedicationKnowledge

        public MedicationKnowledge.Builder relatedMedicationKnowledge​(Collection<MedicationKnowledge.RelatedMedicationKnowledge> relatedMedicationKnowledge)
        Associated or related knowledge about a medication.

        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:
        relatedMedicationKnowledge - Associated or related medication information
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • associatedMedication

        public MedicationKnowledge.Builder associatedMedication​(Reference... associatedMedication)
        Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).

        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:
        associatedMedication - A medication resource that is associated with this medication
        Returns:
        A reference to this Builder instance

      • associatedMedication

        public MedicationKnowledge.Builder associatedMedication​(Collection<Reference> associatedMedication)
        Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).

        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:
        associatedMedication - A medication resource that is associated with this medication
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • productType

        public MedicationKnowledge.Builder productType​(CodeableConcept... productType)
        Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).

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

        Parameters:
        productType - Category of the medication or product
        Returns:
        A reference to this Builder instance

      • productType

        public MedicationKnowledge.Builder productType​(Collection<CodeableConcept> productType)
        Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).

        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:
        productType - Category of the medication or product
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • monograph

        public MedicationKnowledge.Builder monograph​(MedicationKnowledge.Monograph... monograph)
        Associated documentation about the medication.

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

        Parameters:
        monograph - Associated documentation about the medication
        Returns:
        A reference to this Builder instance

      • monograph

        public MedicationKnowledge.Builder monograph​(Collection<MedicationKnowledge.Monograph> monograph)
        Associated documentation about the medication.

        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:
        monograph - Associated documentation about the medication
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • ingredient

        public MedicationKnowledge.Builder ingredient​(MedicationKnowledge.Ingredient... ingredient)
        Identifies a particular constituent of interest in the product.

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

        Parameters:
        ingredient - Active or inactive ingredient
        Returns:
        A reference to this Builder instance

      • ingredient

        public MedicationKnowledge.Builder ingredient​(Collection<MedicationKnowledge.Ingredient> ingredient)
        Identifies a particular constituent of interest in 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.

        Parameters:
        ingredient - Active or inactive ingredient
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • preparationInstruction

        public MedicationKnowledge.Builder preparationInstruction​(Markdown preparationInstruction)
        The instructions for preparing the medication.
        Parameters:
        preparationInstruction - The instructions for preparing the medication
        Returns:
        A reference to this Builder instance

      • intendedRoute

        public MedicationKnowledge.Builder intendedRoute​(CodeableConcept... intendedRoute)
        The intended or approved route of administration.

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

        Parameters:
        intendedRoute - The intended or approved route of administration
        Returns:
        A reference to this Builder instance

      • intendedRoute

        public MedicationKnowledge.Builder intendedRoute​(Collection<CodeableConcept> intendedRoute)
        The intended or approved route of administration.

        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:
        intendedRoute - The intended or approved route of administration
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • cost

        public MedicationKnowledge.Builder cost​(MedicationKnowledge.Cost... cost)
        The price of the medication.

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

        Parameters:
        cost - The pricing of the medication
        Returns:
        A reference to this Builder instance

      • monitoringProgram

        public MedicationKnowledge.Builder monitoringProgram​(MedicationKnowledge.MonitoringProgram... monitoringProgram)
        The program under which the medication is reviewed.

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

        Parameters:
        monitoringProgram - Program under which a medication is reviewed
        Returns:
        A reference to this Builder instance

      • monitoringProgram

        public MedicationKnowledge.Builder monitoringProgram​(Collection<MedicationKnowledge.MonitoringProgram> monitoringProgram)
        The program under which the medication is reviewed.

        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:
        monitoringProgram - Program under which a medication is reviewed
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • administrationGuidelines

        public MedicationKnowledge.Builder administrationGuidelines​(MedicationKnowledge.AdministrationGuidelines... administrationGuidelines)
        Guidelines for the administration of the medication.

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

        Parameters:
        administrationGuidelines - Guidelines for administration of the medication
        Returns:
        A reference to this Builder instance

      • administrationGuidelines

        public MedicationKnowledge.Builder administrationGuidelines​(Collection<MedicationKnowledge.AdministrationGuidelines> administrationGuidelines)
        Guidelines for the administration of the medication.

        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:
        administrationGuidelines - Guidelines for administration of the medication
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • medicineClassification

        public MedicationKnowledge.Builder medicineClassification​(MedicationKnowledge.MedicineClassification... medicineClassification)
        Categorization of the medication within a formulary or classification system.

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

        Parameters:
        medicineClassification - Categorization of the medication within a formulary or classification system
        Returns:
        A reference to this Builder instance

      • medicineClassification

        public MedicationKnowledge.Builder medicineClassification​(Collection<MedicationKnowledge.MedicineClassification> medicineClassification)
        Categorization of the medication within a formulary or classification system.

        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:
        medicineClassification - Categorization of the medication within a formulary or classification system
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • drugCharacteristic

        public MedicationKnowledge.Builder drugCharacteristic​(MedicationKnowledge.DrugCharacteristic... drugCharacteristic)
        Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.

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

        Parameters:
        drugCharacteristic - Specifies descriptive properties of the medicine
        Returns:
        A reference to this Builder instance

      • drugCharacteristic

        public MedicationKnowledge.Builder drugCharacteristic​(Collection<MedicationKnowledge.DrugCharacteristic> drugCharacteristic)
        Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.

        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:
        drugCharacteristic - Specifies descriptive properties of the medicine
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • contraindication

        public MedicationKnowledge.Builder contraindication​(Reference... contraindication)
        Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).

        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:
        contraindication - Potential clinical issue with or between medication(s)
        Returns:
        A reference to this Builder instance

      • contraindication

        public MedicationKnowledge.Builder contraindication​(Collection<Reference> contraindication)
        Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).

        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:
        contraindication - Potential clinical issue with or between medication(s)
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • regulatory

        public MedicationKnowledge.Builder regulatory​(MedicationKnowledge.Regulatory... regulatory)
        Regulatory information about a medication.

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

        Parameters:
        regulatory - Regulatory information about a medication
        Returns:
        A reference to this Builder instance

      • regulatory

        public MedicationKnowledge.Builder regulatory​(Collection<MedicationKnowledge.Regulatory> regulatory)
        Regulatory information about a medication.

        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:
        regulatory - Regulatory information about a medication
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • kinetics

        public MedicationKnowledge.Builder kinetics​(MedicationKnowledge.Kinetics... kinetics)
        The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.

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

        Parameters:
        kinetics - The time course of drug absorption, distribution, metabolism and excretion of a medication from the body
        Returns:
        A reference to this Builder instance

      • kinetics

        public MedicationKnowledge.Builder kinetics​(Collection<MedicationKnowledge.Kinetics> kinetics)
        The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.

        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:
        kinetics - The time course of drug absorption, distribution, metabolism and excretion of a medication from the body
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null