Package org.linuxforhealth.fhir.model.resource

Class MedicationAdministration.Builder

    • Method Detail

      • id

        public MedicationAdministration.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 MedicationAdministration.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 MedicationAdministration.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 MedicationAdministration.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 MedicationAdministration.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 MedicationAdministration.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 MedicationAdministration.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 MedicationAdministration.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 MedicationAdministration.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 MedicationAdministration.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 MedicationAdministration.Builder identifier​(Identifier... identifier)
        Identifiers associated with this Medication Administration 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 MedicationAdministration.Builder identifier​(java.util.Collection<Identifier> identifier)
        Identifiers associated with this Medication Administration 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

      • instantiates

        public MedicationAdministration.Builder instantiates​(Uri... instantiates)
        A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.

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

        Parameters:
        instantiates - Instantiates protocol or definition
        Returns:
        A reference to this Builder instance

      • instantiates

        public MedicationAdministration.Builder instantiates​(java.util.Collection<Uri> instantiates)
        A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this 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:
        instantiates - Instantiates protocol or definition
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • partOf

        public MedicationAdministration.Builder partOf​(Reference... partOf)
        A larger event of which this particular event is a component or step.

        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 - Part of referenced event
        Returns:
        A reference to this Builder instance

      • partOf

        public MedicationAdministration.Builder partOf​(java.util.Collection<Reference> partOf)
        A larger event of which this particular event is a component or step.

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

      • status

        public MedicationAdministration.Builder status​(MedicationAdministrationStatus status)
        Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.

        This element is required.

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

      • statusReason

        public MedicationAdministration.Builder statusReason​(CodeableConcept... statusReason)
        A code indicating why the administration was not performed.

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

        Parameters:
        statusReason - Reason administration not performed
        Returns:
        A reference to this Builder instance

      • statusReason

        public MedicationAdministration.Builder statusReason​(java.util.Collection<CodeableConcept> statusReason)
        A code indicating why the administration was not performed.

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

      • category

        public MedicationAdministration.Builder category​(CodeableConcept category)
        Indicates where the medication is expected to be consumed or administered.
        Parameters:
        category - Type of medication usage
        Returns:
        A reference to this Builder instance

      • medication

        public MedicationAdministration.Builder medication​(Element medication)
        Identifies the medication that was 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 was administered
        Returns:
        A reference to this Builder instance

      • subject

        public MedicationAdministration.Builder subject​(Reference subject)
        The person or animal or group receiving the medication.

        This element is required.

        Allowed resource types for this reference:

        Parameters:
        subject - Who received medication
        Returns:
        A reference to this Builder instance

      • context

        public MedicationAdministration.Builder context​(Reference context)
        The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.

        Allowed resource types for this reference:

        Parameters:
        context - Encounter or Episode of Care administered as part of
        Returns:
        A reference to this Builder instance

      • supportingInformation

        public MedicationAdministration.Builder supportingInformation​(Reference... supportingInformation)
        Additional information (for example, patient height and weight) that supports 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:
        supportingInformation - Additional information to support administration
        Returns:
        A reference to this Builder instance

      • supportingInformation

        public MedicationAdministration.Builder supportingInformation​(java.util.Collection<Reference> supportingInformation)
        Additional information (for example, patient height and weight) that supports 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:
        supportingInformation - Additional information to support administration
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • effective

        public MedicationAdministration.Builder effective​(Element effective)
        A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.

        This element is required.

        This is a choice element with the following allowed types:

        Parameters:
        effective - Start and end time of administration
        Returns:
        A reference to this Builder instance

      • performer

        public MedicationAdministration.Builder performer​(MedicationAdministration.Performer... performer)
        Indicates who or what performed the medication administration and how they were involved.

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

        Parameters:
        performer - Who performed the medication administration and what they did
        Returns:
        A reference to this Builder instance

      • performer

        public MedicationAdministration.Builder performer​(java.util.Collection<MedicationAdministration.Performer> performer)
        Indicates who or what performed the medication administration and how they were involved.

        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 the medication administration and what they did
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • reasonCode

        public MedicationAdministration.Builder reasonCode​(CodeableConcept... reasonCode)
        A code indicating why the medication was given.

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

        Parameters:
        reasonCode - Reason administration performed
        Returns:
        A reference to this Builder instance

      • reasonCode

        public MedicationAdministration.Builder reasonCode​(java.util.Collection<CodeableConcept> reasonCode)
        A code indicating why the medication was given.

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

      • reasonReference

        public MedicationAdministration.Builder reasonReference​(Reference... reasonReference)
        Condition or observation that supports why the medication was administered.

        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:
        reasonReference - Condition or observation that supports why the medication was administered
        Returns:
        A reference to this Builder instance

      • reasonReference

        public MedicationAdministration.Builder reasonReference​(java.util.Collection<Reference> reasonReference)
        Condition or observation that supports why the medication was administered.

        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:
        reasonReference - Condition or observation that supports why the medication was administered
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • request

        public MedicationAdministration.Builder request​(Reference request)
        The original request, instruction or authority to perform the administration.

        Allowed resource types for this reference:

        Parameters:
        request - Request administration performed against
        Returns:
        A reference to this Builder instance

      • device

        public MedicationAdministration.Builder device​(Reference... device)
        The device used in administering the medication to the patient. For example, a particular infusion pump.

        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:
        device - Device used to administer
        Returns:
        A reference to this Builder instance

      • device

        public MedicationAdministration.Builder device​(java.util.Collection<Reference> device)
        The device used in administering the medication to the patient. For example, a particular infusion pump.

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

      • note

        public MedicationAdministration.Builder note​(Annotation... note)
        Extra information about the medication administration that is not conveyed by 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 administration
        Returns:
        A reference to this Builder instance

      • note

        public MedicationAdministration.Builder note​(java.util.Collection<Annotation> note)
        Extra information about the medication administration that is not conveyed by 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 administration
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • eventHistory

        public MedicationAdministration.Builder eventHistory​(Reference... eventHistory)
        A summary of the events of interest that have occurred, such as when the administration 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 events of interest in the lifecycle
        Returns:
        A reference to this Builder instance

      • eventHistory

        public MedicationAdministration.Builder eventHistory​(java.util.Collection<Reference> eventHistory)
        A summary of the events of interest that have occurred, such as when the administration 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 events of interest in the lifecycle
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null