Package org.linuxforhealth.fhir.model.resource

Class Specimen.Builder

    • Method Detail

      • id

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

      • language

        public Specimen.Builder language​(Code language)
        The base language in which the resource is written.
        Overrides:
        language in class DomainResource.Builder
        Parameters:
        language - Language of the resource content
        Returns:
        A reference to this Builder instance

      • text

        public Specimen.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 Specimen.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 Specimen.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 Specimen.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 Specimen.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 Specimen.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 Specimen.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 Specimen.Builder identifier​(Identifier... identifier)
        Id for specimen.

        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 Specimen.Builder identifier​(java.util.Collection<Identifier> identifier)
        Id for specimen.

        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

      • accessionIdentifier

        public Specimen.Builder accessionIdentifier​(Identifier accessionIdentifier)
        The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
        Parameters:
        accessionIdentifier - Identifier assigned by the lab
        Returns:
        A reference to this Builder instance

      • status

        public Specimen.Builder status​(SpecimenStatus status)
        The availability of the specimen.
        Parameters:
        status - available | unavailable | unsatisfactory | entered-in-error
        Returns:
        A reference to this Builder instance

      • type

        public Specimen.Builder type​(CodeableConcept type)
        The kind of material that forms the specimen.
        Parameters:
        type - Kind of material that forms the specimen
        Returns:
        A reference to this Builder instance

      • subject

        public Specimen.Builder subject​(Reference subject)
        Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.

        Allowed resource types for this reference:

        Parameters:
        subject - Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
        Returns:
        A reference to this Builder instance

      • receivedTime

        public Specimen.Builder receivedTime​(DateTime receivedTime)
        Time when specimen was received for processing or testing.
        Parameters:
        receivedTime - The time when specimen was received for processing
        Returns:
        A reference to this Builder instance

      • parent

        public Specimen.Builder parent​(Reference... parent)
        Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.

        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:
        parent - Specimen from which this specimen originated
        Returns:
        A reference to this Builder instance

      • parent

        public Specimen.Builder parent​(java.util.Collection<Reference> parent)
        Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.

        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:
        parent - Specimen from which this specimen originated
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • request

        public Specimen.Builder request​(Reference... request)
        Details concerning a service request that required a specimen to be collected.

        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:
        request - Why the specimen was collected
        Returns:
        A reference to this Builder instance

      • request

        public Specimen.Builder request​(java.util.Collection<Reference> request)
        Details concerning a service request that required a specimen to be collected.

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

      • collection

        public Specimen.Builder collection​(Specimen.Collection collection)
        Details concerning the specimen collection.
        Parameters:
        collection - Collection details
        Returns:
        A reference to this Builder instance

      • processing

        public Specimen.Builder processing​(Specimen.Processing... processing)
        Details concerning processing and processing steps for the specimen.

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

        Parameters:
        processing - Processing and processing step details
        Returns:
        A reference to this Builder instance

      • processing

        public Specimen.Builder processing​(java.util.Collection<Specimen.Processing> processing)
        Details concerning processing and processing steps for the specimen.

        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:
        processing - Processing and processing step details
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • container

        public Specimen.Builder container​(Specimen.Container... container)
        The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.

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

        Parameters:
        container - Direct container of specimen (tube/slide, etc.)
        Returns:
        A reference to this Builder instance

      • container

        public Specimen.Builder container​(java.util.Collection<Specimen.Container> container)
        The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.

        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:
        container - Direct container of specimen (tube/slide, etc.)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • condition

        public Specimen.Builder condition​(CodeableConcept... condition)
        A mode or state of being that describes the nature of the specimen.

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

        Parameters:
        condition - State of the specimen
        Returns:
        A reference to this Builder instance

      • condition

        public Specimen.Builder condition​(java.util.Collection<CodeableConcept> condition)
        A mode or state of being that describes the nature of the specimen.

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

      • note

        public Specimen.Builder note​(Annotation... note)
        To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).

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

        Parameters:
        note - Comments
        Returns:
        A reference to this Builder instance

      • note

        public Specimen.Builder note​(java.util.Collection<Annotation> note)
        To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).

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

      • validate

        protected void validate​(Specimen specimen)