Package org.linuxforhealth.fhir.model.resource

Class MedicationStatement.Builder

    • Method Detail

      • id

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

      • basedOn

        public MedicationStatement.Builder basedOn​(Reference... basedOn)
        A plan, proposal or order that is fulfilled 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.

        Allowed resource types for the references:

        Parameters:
        basedOn - Fulfils plan, proposal or order
        Returns:
        A reference to this Builder instance

      • basedOn

        public MedicationStatement.Builder basedOn​(java.util.Collection<Reference> basedOn)
        A plan, proposal or order that is fulfilled 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.

        Allowed resource types for the references:

        Parameters:
        basedOn - Fulfils plan, proposal or order
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • status

        public MedicationStatement.Builder status​(MedicationStatementStatus status)
        A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally, this will be active or completed.

        This element is required.

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

      • statusReason

        public MedicationStatement.Builder statusReason​(CodeableConcept... statusReason)
        Captures the reason for the current state of the MedicationStatement.

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

        Parameters:
        statusReason - Reason for current status
        Returns:
        A reference to this Builder instance

      • statusReason

        public MedicationStatement.Builder statusReason​(java.util.Collection<CodeableConcept> statusReason)
        Captures the reason for the current state of the MedicationStatement.

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

      • category

        public MedicationStatement.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 MedicationStatement.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 taken
        Returns:
        A reference to this Builder instance

      • subject

        public MedicationStatement.Builder subject​(Reference subject)
        The person, animal or group who is/was taking the medication.

        This element is required.

        Allowed resource types for this reference:

        Parameters:
        subject - Who is/was taking the medication
        Returns:
        A reference to this Builder instance

      • context

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

        Allowed resource types for this reference:

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

      • effective

        public MedicationStatement.Builder effective​(Element effective)
        The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No).

        This is a choice element with the following allowed types:

        Parameters:
        effective - The date/time or interval when the medication is/was/will be taken
        Returns:
        A reference to this Builder instance

      • dateAsserted

        public MedicationStatement.Builder dateAsserted​(DateTime dateAsserted)
        The date when the medication statement was asserted by the information source.
        Parameters:
        dateAsserted - When the statement was asserted?
        Returns:
        A reference to this Builder instance

      • informationSource

        public MedicationStatement.Builder informationSource​(Reference informationSource)
        The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest.

        Allowed resource types for this reference:

        Parameters:
        informationSource - Person or organization that provided the information about the taking of this medication
        Returns:
        A reference to this Builder instance

      • derivedFrom

        public MedicationStatement.Builder derivedFrom​(Reference... derivedFrom)
        Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.

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

        Parameters:
        derivedFrom - Additional supporting information
        Returns:
        A reference to this Builder instance

      • derivedFrom

        public MedicationStatement.Builder derivedFrom​(java.util.Collection<Reference> derivedFrom)
        Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.

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

      • reasonCode

        public MedicationStatement.Builder reasonCode​(CodeableConcept... reasonCode)
        A reason for why the medication is being/was taken.

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

        Parameters:
        reasonCode - Reason for why the medication is being/was taken
        Returns:
        A reference to this Builder instance

      • reasonCode

        public MedicationStatement.Builder reasonCode​(java.util.Collection<CodeableConcept> reasonCode)
        A reason for why the medication is being/was taken.

        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 for why the medication is being/was taken
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • reasonReference

        public MedicationStatement.Builder reasonReference​(Reference... reasonReference)
        Condition or observation that supports why the medication is being/was taken.

        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 is being/was taken
        Returns:
        A reference to this Builder instance

      • reasonReference

        public MedicationStatement.Builder reasonReference​(java.util.Collection<Reference> reasonReference)
        Condition or observation that supports why the medication is being/was taken.

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

      • note

        public MedicationStatement.Builder note​(Annotation... note)
        Provides extra information about the medication statement 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 - Further information about the statement
        Returns:
        A reference to this Builder instance

      • note

        public MedicationStatement.Builder note​(java.util.Collection<Annotation> note)
        Provides extra information about the medication statement 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 - Further information about the statement
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • dosage

        public MedicationStatement.Builder dosage​(Dosage... dosage)
        Indicates how the medication is/was or should be taken by the patient.

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

        Parameters:
        dosage - Details of how medication is/was taken or should be taken
        Returns:
        A reference to this Builder instance

      • dosage

        public MedicationStatement.Builder dosage​(java.util.Collection<Dosage> dosage)
        Indicates how the medication is/was or should be taken 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:
        dosage - Details of how medication is/was taken or should be taken
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null