Specimen.SpecimenContainerComponent (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.dstu3.model.Base
- - org.hl7.fhir.dstu3.model.Element
  - - org.hl7.fhir.dstu3.model.BackboneElement
    - - org.hl7.fhir.dstu3.model.Specimen.SpecimenContainerComponent

All Implemented Interfaces:

IElement, Serializable, IBase, IBaseBackboneElement, IBaseElement, IBaseHasExtensions, IBaseHasModifierExtensions

Enclosing class:

Specimen
```
public static class Specimen.SpecimenContainerComponent
extends BackboneElement
implements IBaseBackboneElement
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Type`	`additive` Introduced substance to preserve, maintain or enhance the specimen.
`protected SimpleQuantity`	`capacity` The capacity (volume or other measure) the container may contain.
`protected StringType`	`description` Textual description of the container.
`protected List<Identifier>`	`identifier` Id for container.
`protected SimpleQuantity`	`specimenQuantity` The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.
`protected CodeableConcept`	`type` The type of container associated with the specimen (e.g.

Fields inherited from class org.hl7.fhir.dstu3.model.BackboneElement
modifierExtension

Fields inherited from class org.hl7.fhir.dstu3.model.Element
extension, id

Constructor Summary

Constructors
Constructor and Description

SpecimenContainerComponent()
Constructor

Constructors
Constructor and Description
`SpecimenContainerComponent()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Identifier`	`addIdentifier()`
`Specimen.SpecimenContainerComponent`	`addIdentifier(Identifier t)`
`Specimen.SpecimenContainerComponent`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`Type`	`getAdditive()`
`CodeableConcept`	`getAdditiveCodeableConcept()`
`Reference`	`getAdditiveReference()`
`SimpleQuantity`	`getCapacity()`
`String`	`getDescription()`
`StringType`	`getDescriptionElement()`
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`SimpleQuantity`	`getSpecimenQuantity()`
`CodeableConcept`	`getType()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasAdditive()`
`boolean`	`hasAdditiveCodeableConcept()`
`boolean`	`hasAdditiveReference()`
`boolean`	`hasCapacity()`
`boolean`	`hasDescription()`
`boolean`	`hasDescriptionElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasSpecimenQuantity()`
`boolean`	`hasType()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`Specimen.SpecimenContainerComponent`	`setAdditive(Type value)`
`Specimen.SpecimenContainerComponent`	`setCapacity(SimpleQuantity value)`
`Specimen.SpecimenContainerComponent`	`setDescription(String value)`
`Specimen.SpecimenContainerComponent`	`setDescriptionElement(StringType value)`
`Specimen.SpecimenContainerComponent`	`setIdentifier(List<Identifier> theIdentifier)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Specimen.SpecimenContainerComponent`	`setSpecimenQuantity(SimpleQuantity value)`
`Specimen.SpecimenContainerComponent`	`setType(CodeableConcept value)`

Methods inherited from class org.hl7.fhir.dstu3.model.BackboneElement
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.dstu3.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
addModifierExtension, getModifierExtension, hasModifierExtension

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.
  - description
```
protected StringType description
```
    Textual description of the container.
  - type
```
protected CodeableConcept type
```
    The type of container associated with the specimen (e.g. slide, aliquot, etc.).
  - capacity
```
protected SimpleQuantity capacity
```
    The capacity (volume or other measure) the container may contain.
  - specimenQuantity
```
protected SimpleQuantity specimenQuantity
```
    The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.
  - additive
```
protected Type additive
```
    Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
- Constructor Detail
  - SpecimenContainerComponent
```
public SpecimenContainerComponent()
```
    Constructor
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.)
  - setIdentifier
```
public Specimen.SpecimenContainerComponent setIdentifier(List<Identifier> theIdentifier)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
  - addIdentifier
```
public Specimen.SpecimenContainerComponent addIdentifier(Identifier t)
```
  - getIdentifierFirstRep
```
public Identifier getIdentifierFirstRep()
```
    Returns:
    
    The first repetition of repeating field identifier, creating it if it does not already exist
  - getDescriptionElement
```
public StringType getDescriptionElement()
```
    Returns:
    
    description (Textual description of the container.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
  - hasDescriptionElement
```
public boolean hasDescriptionElement()
```
  - hasDescription
```
public boolean hasDescription()
```
  - setDescriptionElement
```
public Specimen.SpecimenContainerComponent setDescriptionElement(StringType value)
```
    Parameters:
    
    value - description (Textual description of the container.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
  - getDescription
```
public String getDescription()
```
    Returns:
    
    Textual description of the container.
  - setDescription
```
public Specimen.SpecimenContainerComponent setDescription(String value)
```
    Parameters:
    
    value - Textual description of the container.
  - getType
```
public CodeableConcept getType()
```
    Returns:
    
    type (The type of container associated with the specimen (e.g. slide, aliquot, etc.).)
  - hasType
```
public boolean hasType()
```
  - setType
```
public Specimen.SpecimenContainerComponent setType(CodeableConcept value)
```
    Parameters:
    
    value - type (The type of container associated with the specimen (e.g. slide, aliquot, etc.).)
  - getCapacity
```
public SimpleQuantity getCapacity()
```
    Returns:
    
    capacity (The capacity (volume or other measure) the container may contain.)
  - hasCapacity
```
public boolean hasCapacity()
```
  - setCapacity
```
public Specimen.SpecimenContainerComponent setCapacity(SimpleQuantity value)
```
    Parameters:
    
    value - capacity (The capacity (volume or other measure) the container may contain.)
  - getSpecimenQuantity
```
public SimpleQuantity getSpecimenQuantity()
```
    Returns:
    
    specimenQuantity (The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.)
  - hasSpecimenQuantity
```
public boolean hasSpecimenQuantity()
```
  - setSpecimenQuantity
```
public Specimen.SpecimenContainerComponent setSpecimenQuantity(SimpleQuantity value)
```
    Parameters:
    
    value - specimenQuantity (The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.)
  - getAdditive
```
public Type getAdditive()
```
    Returns:
    
    additive (Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.)
  - getAdditiveCodeableConcept
```
public CodeableConcept getAdditiveCodeableConcept()
                                           throws FHIRException
```
    Returns:
    
    additive (Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.)
    
    Throws:
    
    FHIRException
  - hasAdditiveCodeableConcept
```
public boolean hasAdditiveCodeableConcept()
```
  - getAdditiveReference
```
public Reference getAdditiveReference()
                               throws FHIRException
```
    Returns:
    
    additive (Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.)
    
    Throws:
    
    FHIRException
  - hasAdditiveReference
```
public boolean hasAdditiveReference()
```
  - hasAdditive
```
public boolean hasAdditive()
```
  - setAdditive
```
public Specimen.SpecimenContainerComponent setAdditive(Type value)
```
    Parameters:
    
    value - additive (Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.)
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class BackboneElement
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException
```
    Overrides:
    
    getProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws FHIRException
```
    Overrides:
    
    makeProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException
```
    Overrides:
    
    getTypesForProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - addChild
```
public Base addChild(String name)
              throws FHIRException
```
    Overrides:
    
    addChild in class BackboneElement
    
    Throws:
    
    FHIRException
  - copy
```
public Specimen.SpecimenContainerComponent copy()
```
    Specified by:
    
    copy in class BackboneElement
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class BackboneElement
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class BackboneElement
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
    
    Overrides:
    
    isEmpty in class BackboneElement
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class BackboneElement

Class Specimen.SpecimenContainerComponent

Field Summary

Fields inherited from class org.hl7.fhir.dstu3.model.BackboneElement

Fields inherited from class org.hl7.fhir.dstu3.model.Element

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu3.model.BackboneElement

Methods inherited from class org.hl7.fhir.dstu3.model.Element

Methods inherited from class org.hl7.fhir.dstu3.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Field Detail

identifier

description

type

capacity

specimenQuantity

additive

Constructor Detail

SpecimenContainerComponent

Method Detail

getIdentifier

setIdentifier

hasIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getDescriptionElement

hasDescriptionElement

hasDescription

setDescriptionElement

getDescription

setDescription

getType

hasType

setType

getCapacity

hasCapacity

setCapacity

getSpecimenQuantity

hasSpecimenQuantity

setSpecimenQuantity

getAdditive

getAdditiveCodeableConcept

hasAdditiveCodeableConcept

getAdditiveReference

hasAdditiveReference

hasAdditive

setAdditive

listChildren

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty

addChild

copy

equalsDeep

equalsShallow

isEmpty

fhirType