ca.uhn.fhir.model.dstu.resource

Class Specimen.Container

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.dstu.resource.Specimen.Container

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions

Enclosing class:

Specimen

public static class Specimen.Container
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: Specimen.container (Direct container of specimen (tube/slide, etc))

Definition: The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.

Constructor Summary

Constructors

Constructor and Description
Specimen.Container()

Method Summary

Methods

Modifier and Type	Method and Description
IdentifierDt	addIdentifier() Adds and returns a new value for identifier (Id for the container)
Specimen.Container	addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel) Adds a new value for identifier (Id for the container)
Specimen.Container	addIdentifier(String theSystem, String theValue) Adds a new value for identifier (Id for the container)
ResourceReferenceDt	getAdditive() Gets the value(s) for additive (Additive associated with container).
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
QuantityDt	getCapacity() Gets the value(s) for capacity (Container volume or size).
StringDt	getDescription() Gets the value(s) for description (Textual description of the container).
List<IdentifierDt>	getIdentifier() Gets the value(s) for identifier (Id for the container).
IdentifierDt	getIdentifierFirstRep() Gets the first repetition for identifier (Id for the container), creating it if it does not already exist.
QuantityDt	getSpecimenQuantity() Gets the value(s) for specimenQuantity (Quantity of specimen within container).
CodeableConceptDt	getType() Gets the value(s) for type (Kind of container directly associated with specimen).
boolean	isEmpty()
Specimen.Container	setAdditive(ResourceReferenceDt theValue) Sets the value(s) for additive (Additive associated with container)
Specimen.Container	setCapacity(double theValue) Sets the value for capacity (Container volume or size)
Specimen.Container	setCapacity(long theValue) Sets the value for capacity (Container volume or size)
Specimen.Container	setCapacity(QuantityCompararatorEnum theComparator, double theValue, String theUnits) Sets the value for capacity (Container volume or size)
Specimen.Container	setCapacity(QuantityCompararatorEnum theComparator, double theValue, String theSystem, String theUnits) Sets the value for capacity (Container volume or size)
Specimen.Container	setCapacity(QuantityCompararatorEnum theComparator, long theValue, String theUnits) Sets the value for capacity (Container volume or size)
Specimen.Container	setCapacity(QuantityCompararatorEnum theComparator, long theValue, String theSystem, String theUnits) Sets the value for capacity (Container volume or size)
Specimen.Container	setCapacity(QuantityDt theValue) Sets the value(s) for capacity (Container volume or size)
Specimen.Container	setDescription(String theString) Sets the value for description (Textual description of the container)
Specimen.Container	setDescription(StringDt theValue) Sets the value(s) for description (Textual description of the container)
Specimen.Container	setIdentifier(List<IdentifierDt> theValue) Sets the value(s) for identifier (Id for the container)
Specimen.Container	setSpecimenQuantity(double theValue) Sets the value for specimenQuantity (Quantity of specimen within container)
Specimen.Container	setSpecimenQuantity(long theValue) Sets the value for specimenQuantity (Quantity of specimen within container)
Specimen.Container	setSpecimenQuantity(QuantityCompararatorEnum theComparator, double theValue, String theUnits) Sets the value for specimenQuantity (Quantity of specimen within container)
Specimen.Container	setSpecimenQuantity(QuantityCompararatorEnum theComparator, double theValue, String theSystem, String theUnits) Sets the value for specimenQuantity (Quantity of specimen within container)
Specimen.Container	setSpecimenQuantity(QuantityCompararatorEnum theComparator, long theValue, String theUnits) Sets the value for specimenQuantity (Quantity of specimen within container)
Specimen.Container	setSpecimenQuantity(QuantityCompararatorEnum theComparator, long theValue, String theSystem, String theUnits) Sets the value for specimenQuantity (Quantity of specimen within container)
Specimen.Container	setSpecimenQuantity(QuantityDt theValue) Sets the value(s) for specimenQuantity (Quantity of specimen within container)
Specimen.Container	setType(CodeableConceptDt theValue) Sets the value(s) for type (Kind of container directly associated with specimen)

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId, setId

Constructor Detail

Specimen.Container

public Specimen.Container()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IElement

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getIdentifier

public List<IdentifierDt> getIdentifier()

Gets the value(s) for identifier (Id for the container). creating it if it does not exist. Will not return null.

Definition: 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.Container setIdentifier(List<IdentifierDt> theValue)

Sets the value(s) for identifier (Id for the container)

Definition: 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

addIdentifier

public IdentifierDt addIdentifier()

Adds and returns a new value for identifier (Id for the container)

Definition: 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

getIdentifierFirstRep

public IdentifierDt getIdentifierFirstRep()

Gets the first repetition for identifier (Id for the container), creating it if it does not already exist.

Definition: 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

addIdentifier

public Specimen.Container addIdentifier(IdentifierUseEnum theUse,
                               String theSystem,
                               String theValue,
                               String theLabel)

Adds a new value for identifier (Id for the container)

Definition: 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

Returns:

Returns a reference to this object, to allow for simple chaining.

addIdentifier

public Specimen.Container addIdentifier(String theSystem,
                               String theValue)

Adds a new value for identifier (Id for the container)

Definition: 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

Returns:

Returns a reference to this object, to allow for simple chaining.

getDescription

public StringDt getDescription()

Gets the value(s) for description (Textual description of the container). creating it if it does not exist. Will not return null.

Definition:

setDescription

public Specimen.Container setDescription(StringDt theValue)

Sets the value(s) for description (Textual description of the container)

Definition:

setDescription

public Specimen.Container setDescription(String theString)

Sets the value for description (Textual description of the container)

Definition:

getType

public CodeableConceptDt getType()

Gets the value(s) for type (Kind of container directly associated with specimen). creating it if it does not exist. Will not return null.

Definition: The type of container associated with the specimen (e.g. slide, aliquot, etc)

setType

public Specimen.Container setType(CodeableConceptDt theValue)

Sets the value(s) for type (Kind of container directly associated with specimen)

Definition: The type of container associated with the specimen (e.g. slide, aliquot, etc)

getCapacity

public QuantityDt getCapacity()

Gets the value(s) for capacity (Container volume or size). creating it if it does not exist. Will not return null.

Definition: The capacity (volume or other measure) the container may contain.

setCapacity

public Specimen.Container setCapacity(QuantityDt theValue)

Sets the value(s) for capacity (Container volume or size)

Definition: The capacity (volume or other measure) the container may contain.

setCapacity

public Specimen.Container setCapacity(QuantityCompararatorEnum theComparator,
                             double theValue,
                             String theUnits)

Sets the value for capacity (Container volume or size)

Definition: The capacity (volume or other measure) the container may contain.

setCapacity

public Specimen.Container setCapacity(QuantityCompararatorEnum theComparator,
                             long theValue,
                             String theUnits)

Sets the value for capacity (Container volume or size)

Definition: The capacity (volume or other measure) the container may contain.

setCapacity

public Specimen.Container setCapacity(QuantityCompararatorEnum theComparator,
                             double theValue,
                             String theSystem,
                             String theUnits)

Sets the value for capacity (Container volume or size)

Definition: The capacity (volume or other measure) the container may contain.

setCapacity

public Specimen.Container setCapacity(QuantityCompararatorEnum theComparator,
                             long theValue,
                             String theSystem,
                             String theUnits)

Sets the value for capacity (Container volume or size)

Definition: The capacity (volume or other measure) the container may contain.

setCapacity

public Specimen.Container setCapacity(double theValue)

Sets the value for capacity (Container volume or size)

Definition: The capacity (volume or other measure) the container may contain.

setCapacity

public Specimen.Container setCapacity(long theValue)

Sets the value for capacity (Container volume or size)

Definition: The capacity (volume or other measure) the container may contain.

getSpecimenQuantity

public QuantityDt getSpecimenQuantity()

Gets the value(s) for specimenQuantity (Quantity of specimen within container). creating it if it does not exist. Will not return null.

Definition: The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type

setSpecimenQuantity

public Specimen.Container setSpecimenQuantity(QuantityDt theValue)

Sets the value(s) for specimenQuantity (Quantity of specimen within container)

Definition: The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type

setSpecimenQuantity

public Specimen.Container setSpecimenQuantity(QuantityCompararatorEnum theComparator,
                                     double theValue,
                                     String theUnits)

Sets the value for specimenQuantity (Quantity of specimen within container)

Definition: The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type

setSpecimenQuantity

public Specimen.Container setSpecimenQuantity(QuantityCompararatorEnum theComparator,
                                     long theValue,
                                     String theUnits)

Sets the value for specimenQuantity (Quantity of specimen within container)

Definition: The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type

setSpecimenQuantity

public Specimen.Container setSpecimenQuantity(QuantityCompararatorEnum theComparator,
                                     double theValue,
                                     String theSystem,
                                     String theUnits)

Sets the value for specimenQuantity (Quantity of specimen within container)

Definition: The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type

setSpecimenQuantity

public Specimen.Container setSpecimenQuantity(QuantityCompararatorEnum theComparator,
                                     long theValue,
                                     String theSystem,
                                     String theUnits)

Sets the value for specimenQuantity (Quantity of specimen within container)

Definition: The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type

setSpecimenQuantity

public Specimen.Container setSpecimenQuantity(double theValue)

Sets the value for specimenQuantity (Quantity of specimen within container)

Definition: The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type

setSpecimenQuantity

public Specimen.Container setSpecimenQuantity(long theValue)

Sets the value for specimenQuantity (Quantity of specimen within container)

Definition: The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type

getAdditive

public ResourceReferenceDt getAdditive()

Gets the value(s) for additive (Additive associated with container). creating it if it does not exist. Will not return null.

Definition: Additive associated with the container

setAdditive

public Specimen.Container setAdditive(ResourceReferenceDt theValue)

Sets the value(s) for additive (Additive associated with container)

Definition: Additive associated with the container