Package com.ibm.fhir.model.resource

Class Specimen.Collection.Builder

    • Method Detail

      • id

        public Specimen.Collection.Builder id​(String id)
        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
        Overrides:
        id in class BackboneElement.Builder
        Parameters:
        id - Unique id for inter-element referencing
        Returns:
        A reference to this Builder instance

      • extension

        public Specimen.Collection.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the element. 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 BackboneElement.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public Specimen.Collection.Builder extension​(Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the element. 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 BackboneElement.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 Specimen.Collection.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public Specimen.Collection.Builder modifierExtension​(Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • collected

        public Specimen.Collection.Builder collected​(Element collected)
        Time when specimen was collected from subject - the physiologically relevant time.

        This is a choice element with the following allowed types:

        Parameters:
        collected - Collection time
        Returns:
        A reference to this Builder instance

      • duration

        public Specimen.Collection.Builder duration​(Duration duration)
        The span of time over which the collection of a specimen occurred.
        Parameters:
        duration - How long it took to collect specimen
        Returns:
        A reference to this Builder instance

      • quantity

        public Specimen.Collection.Builder quantity​(SimpleQuantity quantity)
        The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.
        Parameters:
        quantity - The quantity of specimen collected
        Returns:
        A reference to this Builder instance

      • method

        public Specimen.Collection.Builder method​(CodeableConcept method)
        A coded value specifying the technique that is used to perform the procedure.
        Parameters:
        method - Technique used to perform collection
        Returns:
        A reference to this Builder instance

      • bodySite

        public Specimen.Collection.Builder bodySite​(CodeableConcept bodySite)
        Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.
        Parameters:
        bodySite - Anatomical collection site
        Returns:
        A reference to this Builder instance

      • fastingStatus

        public Specimen.Collection.Builder fastingStatus​(Element fastingStatus)
        Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.

        This is a choice element with the following allowed types:

        Parameters:
        fastingStatus - Whether or how long patient abstained from food and/or drink
        Returns:
        A reference to this Builder instance