ca.uhn.fhir.model.dstu.resource

Class Specimen.Collection

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

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

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions

Enclosing class:

Specimen

public static class Specimen.Collection
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: Specimen.collection (Collection details)

Definition: Details concerning the specimen collection

Constructor Summary

Constructors

Constructor and Description
Specimen.Collection()

Method Summary

Methods

Modifier and Type	Method and Description
StringDt	addComment() Adds and returns a new value for comment (Collector comments)
Specimen.Collection	addComment(String theString) Adds a new value for comment (Collector comments)
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
IDatatype	getCollected() Gets the value(s) for collected[x] (Collection time).
ResourceReferenceDt	getCollector() Gets the value(s) for collector (Who collected the specimen).
List<StringDt>	getComment() Gets the value(s) for comment (Collector comments).
StringDt	getCommentFirstRep() Gets the first repetition for comment (Collector comments), creating it if it does not already exist.
BoundCodeableConceptDt<SpecimenCollectionMethodEnum>	getMethod() Gets the value(s) for method (Technique used to perform collection).
QuantityDt	getQuantity() Gets the value(s) for quantity (The quantity of specimen collected).
CodeableConceptDt	getSourceSite() Gets the value(s) for sourceSite (Anatomical collection site).
boolean	isEmpty()
Specimen.Collection	setCollected(IDatatype theValue) Sets the value(s) for collected[x] (Collection time)
Specimen.Collection	setCollector(ResourceReferenceDt theValue) Sets the value(s) for collector (Who collected the specimen)
Specimen.Collection	setComment(List<StringDt> theValue) Sets the value(s) for comment (Collector comments)
Specimen.Collection	setMethod(BoundCodeableConceptDt<SpecimenCollectionMethodEnum> theValue) Sets the value(s) for method (Technique used to perform collection)
Specimen.Collection	setMethod(SpecimenCollectionMethodEnum theValue) Sets the value(s) for method (Technique used to perform collection)
Specimen.Collection	setQuantity(double theValue) Sets the value for quantity (The quantity of specimen collected)
Specimen.Collection	setQuantity(long theValue) Sets the value for quantity (The quantity of specimen collected)
Specimen.Collection	setQuantity(QuantityCompararatorEnum theComparator, double theValue, String theUnits) Sets the value for quantity (The quantity of specimen collected)
Specimen.Collection	setQuantity(QuantityCompararatorEnum theComparator, double theValue, String theSystem, String theUnits) Sets the value for quantity (The quantity of specimen collected)
Specimen.Collection	setQuantity(QuantityCompararatorEnum theComparator, long theValue, String theUnits) Sets the value for quantity (The quantity of specimen collected)
Specimen.Collection	setQuantity(QuantityCompararatorEnum theComparator, long theValue, String theSystem, String theUnits) Sets the value for quantity (The quantity of specimen collected)
Specimen.Collection	setQuantity(QuantityDt theValue) Sets the value(s) for quantity (The quantity of specimen collected)
Specimen.Collection	setSourceSite(CodeableConceptDt theValue) Sets the value(s) for sourceSite (Anatomical collection site)

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.Collection

public Specimen.Collection()

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

getCollector

public ResourceReferenceDt getCollector()

Gets the value(s) for collector (Who collected the specimen). creating it if it does not exist. Will not return null.

Definition: Person who collected the specimen

setCollector

public Specimen.Collection setCollector(ResourceReferenceDt theValue)

Sets the value(s) for collector (Who collected the specimen)

Definition: Person who collected the specimen

getComment

public List<StringDt> getComment()

Gets the value(s) for comment (Collector comments). creating it if it does not exist. Will not return null.

Definition: To communicate any details or issues encountered during the specimen collection procedure.

setComment

public Specimen.Collection setComment(List<StringDt> theValue)

Sets the value(s) for comment (Collector comments)

Definition: To communicate any details or issues encountered during the specimen collection procedure.

addComment

public StringDt addComment()

Adds and returns a new value for comment (Collector comments)

Definition: To communicate any details or issues encountered during the specimen collection procedure.

getCommentFirstRep

public StringDt getCommentFirstRep()

Gets the first repetition for comment (Collector comments), creating it if it does not already exist.

Definition: To communicate any details or issues encountered during the specimen collection procedure.

addComment

public Specimen.Collection addComment(String theString)

Adds a new value for comment (Collector comments)

Definition: To communicate any details or issues encountered during the specimen collection procedure.

Returns:

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

getCollected

public IDatatype getCollected()

Gets the value(s) for collected[x] (Collection time). creating it if it does not exist. Will not return null.

Definition: Time when specimen was collected from subject - the physiologically relevant time

setCollected

public Specimen.Collection setCollected(IDatatype theValue)

Sets the value(s) for collected[x] (Collection time)

Definition: Time when specimen was collected from subject - the physiologically relevant time

getQuantity

public QuantityDt getQuantity()

Gets the value(s) for quantity (The quantity of specimen collected). creating it if it does not exist. Will not return null.

Definition: The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample

setQuantity

public Specimen.Collection setQuantity(QuantityDt theValue)

Sets the value(s) for quantity (The quantity of specimen collected)

Definition: The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample

setQuantity

public Specimen.Collection setQuantity(QuantityCompararatorEnum theComparator,
                              double theValue,
                              String theUnits)

Sets the value for quantity (The quantity of specimen collected)

Definition: The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample

setQuantity

public Specimen.Collection setQuantity(QuantityCompararatorEnum theComparator,
                              long theValue,
                              String theUnits)

Sets the value for quantity (The quantity of specimen collected)

Definition: The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample

setQuantity

public Specimen.Collection setQuantity(QuantityCompararatorEnum theComparator,
                              double theValue,
                              String theSystem,
                              String theUnits)

Sets the value for quantity (The quantity of specimen collected)

Definition: The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample

setQuantity

public Specimen.Collection setQuantity(QuantityCompararatorEnum theComparator,
                              long theValue,
                              String theSystem,
                              String theUnits)

Sets the value for quantity (The quantity of specimen collected)

Definition: The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample

setQuantity

public Specimen.Collection setQuantity(double theValue)

Sets the value for quantity (The quantity of specimen collected)

Definition: The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample

setQuantity

public Specimen.Collection setQuantity(long theValue)

Sets the value for quantity (The quantity of specimen collected)

Definition: The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample

getMethod

public BoundCodeableConceptDt<SpecimenCollectionMethodEnum> getMethod()

Gets the value(s) for method (Technique used to perform collection). creating it if it does not exist. Will not return null.

Definition: A coded value specifying the technique that is used to perform the procedure

setMethod

public Specimen.Collection setMethod(BoundCodeableConceptDt<SpecimenCollectionMethodEnum> theValue)

Sets the value(s) for method (Technique used to perform collection)

Definition: A coded value specifying the technique that is used to perform the procedure

setMethod

public Specimen.Collection setMethod(SpecimenCollectionMethodEnum theValue)

Sets the value(s) for method (Technique used to perform collection)

Definition: A coded value specifying the technique that is used to perform the procedure

getSourceSite

public CodeableConceptDt getSourceSite()

Gets the value(s) for sourceSite (Anatomical collection site). creating it if it does not exist. Will not return null.

Definition: Anatomical location from which the specimen should be collected (if subject is a patient). This element is not used for environmental specimens.

setSourceSite

public Specimen.Collection setSourceSite(CodeableConceptDt theValue)

Sets the value(s) for sourceSite (Anatomical collection site)

Definition: Anatomical location from which the specimen should be collected (if subject is a patient). This element is not used for environmental specimens.