Package com.ibm.fhir.model.resource

Class Specimen

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class Specimen
extends DomainResource
    A sample to be used for analysis.

    Maturity level: FMM2 (Trial Use)

    • Method Detail

      • getIdentifier

        public List<Identifier> getIdentifier()
        Id for specimen.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getAccessionIdentifier

        public Identifier getAccessionIdentifier()
        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.
        Returns:
        An immutable object of type Identifier that may be null.

      • getStatus

        public SpecimenStatus getStatus()
        The availability of the specimen.
        Returns:
        An immutable object of type SpecimenStatus that may be null.

      • getType

        public CodeableConcept getType()
        The kind of material that forms the specimen.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getSubject

        public Reference getSubject()
        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:
        An immutable object of type Reference that may be null.

      • getReceivedTime

        public DateTime getReceivedTime()
        Time when specimen was received for processing or testing.
        Returns:
        An immutable object of type DateTime that may be null.

      • getParent

        public List<Reference> getParent()
        Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getRequest

        public List<Reference> getRequest()
        Details concerning a service request that required a specimen to be collected.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getProcessing

        public List<Specimen.Processing> getProcessing()
        Details concerning processing and processing steps for the specimen.
        Returns:
        An unmodifiable list containing immutable objects of type Specimen.Processing that may be empty.

      • getContainer

        public List<Specimen.Container> getContainer()
        The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
        Returns:
        An unmodifiable list containing immutable objects of type Specimen.Container that may be empty.

      • getCondition

        public List<CodeableConcept> getCondition()
        A mode or state of being that describes the nature of the specimen.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getNote

        public List<Annotation> getNote()
        To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).
        Returns:
        An unmodifiable list containing immutable objects of type Annotation that may be empty.

      • accept

        public void accept​(String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object