Package org.linuxforhealth.fhir.model.resource

Class MedicationDispense.Builder

    • Method Detail

      • id

        public MedicationDispense.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 MedicationDispense.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 MedicationDispense.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 MedicationDispense.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 MedicationDispense.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 MedicationDispense.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 MedicationDispense.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 MedicationDispense.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 MedicationDispense.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 MedicationDispense.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 MedicationDispense.Builder identifier​(Identifier... identifier)
        Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

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

        Parameters:
        identifier - External identifier
        Returns:
        A reference to this Builder instance

      • identifier

        public MedicationDispense.Builder identifier​(java.util.Collection<Identifier> identifier)
        Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

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

      • partOf

        public MedicationDispense.Builder partOf​(Reference... partOf)
        The procedure that trigger the dispense.

        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:
        partOf - Event that dispense is part of
        Returns:
        A reference to this Builder instance

      • partOf

        public MedicationDispense.Builder partOf​(java.util.Collection<Reference> partOf)
        The procedure that trigger the dispense.

        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:
        partOf - Event that dispense is part of
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • status

        public MedicationDispense.Builder status​(MedicationDispenseStatus status)
        A code specifying the state of the set of dispense events.

        This element is required.

        Parameters:
        status - preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
        Returns:
        A reference to this Builder instance

      • statusReason

        public MedicationDispense.Builder statusReason​(Element statusReason)
        Indicates the reason why a dispense was not performed.

        This is a choice element with the following allowed types:

        When of type Reference, the allowed resource types for this reference are:
        Parameters:
        statusReason - Why a dispense was not performed
        Returns:
        A reference to this Builder instance

      • category

        public MedicationDispense.Builder category​(CodeableConcept category)
        Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
        Parameters:
        category - Type of medication dispense
        Returns:
        A reference to this Builder instance

      • medication

        public MedicationDispense.Builder medication​(Element medication)
        Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

        This element is required.

        This is a choice element with the following allowed types:

        When of type Reference, the allowed resource types for this reference are:
        Parameters:
        medication - What medication was supplied
        Returns:
        A reference to this Builder instance

      • subject

        public MedicationDispense.Builder subject​(Reference subject)
        A link to a resource representing the person or the group to whom the medication will be given.

        Allowed resource types for this reference:

        Parameters:
        subject - Who the dispense is for
        Returns:
        A reference to this Builder instance

      • context

        public MedicationDispense.Builder context​(Reference context)
        The encounter or episode of care that establishes the context for this event.

        Allowed resource types for this reference:

        Parameters:
        context - Encounter / Episode associated with event
        Returns:
        A reference to this Builder instance

      • supportingInformation

        public MedicationDispense.Builder supportingInformation​(Reference... supportingInformation)
        Additional information that supports the medication being dispensed.

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

        Parameters:
        supportingInformation - Information that supports the dispensing of the medication
        Returns:
        A reference to this Builder instance

      • supportingInformation

        public MedicationDispense.Builder supportingInformation​(java.util.Collection<Reference> supportingInformation)
        Additional information that supports the medication being dispensed.

        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:
        supportingInformation - Information that supports the dispensing of the medication
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • performer

        public MedicationDispense.Builder performer​(MedicationDispense.Performer... performer)
        Indicates who or what performed the event.

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

        Parameters:
        performer - Who performed event
        Returns:
        A reference to this Builder instance

      • performer

        public MedicationDispense.Builder performer​(java.util.Collection<MedicationDispense.Performer> performer)
        Indicates who or what performed the event.

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

      • location

        public MedicationDispense.Builder location​(Reference location)
        The principal physical location where the dispense was performed.

        Allowed resource types for this reference:

        Parameters:
        location - Where the dispense occurred
        Returns:
        A reference to this Builder instance

      • authorizingPrescription

        public MedicationDispense.Builder authorizingPrescription​(Reference... authorizingPrescription)
        Indicates the medication order that is being dispensed against.

        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:
        authorizingPrescription - Medication order that authorizes the dispense
        Returns:
        A reference to this Builder instance

      • authorizingPrescription

        public MedicationDispense.Builder authorizingPrescription​(java.util.Collection<Reference> authorizingPrescription)
        Indicates the medication order that is being dispensed against.

        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:
        authorizingPrescription - Medication order that authorizes the dispense
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • type

        public MedicationDispense.Builder type​(CodeableConcept type)
        Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
        Parameters:
        type - Trial fill, partial fill, emergency fill, etc.
        Returns:
        A reference to this Builder instance

      • quantity

        public MedicationDispense.Builder quantity​(SimpleQuantity quantity)
        The amount of medication that has been dispensed. Includes unit of measure.
        Parameters:
        quantity - Amount dispensed
        Returns:
        A reference to this Builder instance

      • daysSupply

        public MedicationDispense.Builder daysSupply​(SimpleQuantity daysSupply)
        The amount of medication expressed as a timing amount.
        Parameters:
        daysSupply - Amount of medication expressed as a timing amount
        Returns:
        A reference to this Builder instance

      • whenPrepared

        public MedicationDispense.Builder whenPrepared​(DateTime whenPrepared)
        The time when the dispensed product was packaged and reviewed.
        Parameters:
        whenPrepared - When product was packaged and reviewed
        Returns:
        A reference to this Builder instance

      • whenHandedOver

        public MedicationDispense.Builder whenHandedOver​(DateTime whenHandedOver)
        The time the dispensed product was provided to the patient or their representative.
        Parameters:
        whenHandedOver - When product was given out
        Returns:
        A reference to this Builder instance

      • destination

        public MedicationDispense.Builder destination​(Reference destination)
        Identification of the facility/location where the medication was shipped to, as part of the dispense event.

        Allowed resource types for this reference:

        Parameters:
        destination - Where the medication was sent
        Returns:
        A reference to this Builder instance

      • receiver

        public MedicationDispense.Builder receiver​(Reference... receiver)
        Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.

        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:
        receiver - Who collected the medication
        Returns:
        A reference to this Builder instance

      • receiver

        public MedicationDispense.Builder receiver​(java.util.Collection<Reference> receiver)
        Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.

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

      • note

        public MedicationDispense.Builder note​(Annotation... note)
        Extra information about the dispense that could not be conveyed in the other attributes.

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

        Parameters:
        note - Information about the dispense
        Returns:
        A reference to this Builder instance

      • note

        public MedicationDispense.Builder note​(java.util.Collection<Annotation> note)
        Extra information about the dispense that could not be conveyed in the other attributes.

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

      • dosageInstruction

        public MedicationDispense.Builder dosageInstruction​(Dosage... dosageInstruction)
        Indicates how the medication is to be used by the patient.

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

        Parameters:
        dosageInstruction - How the medication is to be used by the patient or administered by the caregiver
        Returns:
        A reference to this Builder instance

      • dosageInstruction

        public MedicationDispense.Builder dosageInstruction​(java.util.Collection<Dosage> dosageInstruction)
        Indicates how the medication is to be used by the patient.

        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:
        dosageInstruction - How the medication is to be used by the patient or administered by the caregiver
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • substitution

        public MedicationDispense.Builder substitution​(MedicationDispense.Substitution substitution)
        Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.
        Parameters:
        substitution - Whether a substitution was performed on the dispense
        Returns:
        A reference to this Builder instance

      • detectedIssue

        public MedicationDispense.Builder detectedIssue​(Reference... detectedIssue)
        Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert 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:
        detectedIssue - Clinical issue with action
        Returns:
        A reference to this Builder instance

      • detectedIssue

        public MedicationDispense.Builder detectedIssue​(java.util.Collection<Reference> detectedIssue)
        Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert 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:
        detectedIssue - Clinical issue with action
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • eventHistory

        public MedicationDispense.Builder eventHistory​(Reference... eventHistory)
        A summary of the events of interest that have occurred, such as when the dispense was verified.

        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:
        eventHistory - A list of relevant lifecycle events
        Returns:
        A reference to this Builder instance

      • eventHistory

        public MedicationDispense.Builder eventHistory​(java.util.Collection<Reference> eventHistory)
        A summary of the events of interest that have occurred, such as when the dispense was verified.

        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:
        eventHistory - A list of relevant lifecycle events
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null