Package org.hl7.fhir.dstu2.model

Class Specimen.SpecimenCollectionComponent

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.Element

org.hl7.fhir.dstu2.model.BackboneElement

org.hl7.fhir.dstu2.model.Specimen.SpecimenCollectionComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

Specimen

public static class Specimen.SpecimenCollectionComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeableConcept	bodySite	Anatomical location from which the specimen was collected (if subject is a patient).
protected Type	collected	Time when specimen was collected from subject - the physiologically relevant time.
protected Reference	collector	Person who collected the specimen.
protected Practitioner	collectorTarget	The actual object that is the target of the reference (Person who collected the specimen.)
protected List<StringType>	comment	To communicate any details or issues encountered during the specimen collection procedure.
protected CodeableConcept	method	A coded value specifying the technique that is used to perform the procedure.
protected SimpleQuantity	quantity	The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
SpecimenCollectionComponent()

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Specimen.SpecimenCollectionComponent	addComment(String value)
StringType	addCommentElement()
Specimen.SpecimenCollectionComponent	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
CodeableConcept	getBodySite()
Type	getCollected()
DateTimeType	getCollectedDateTimeType()
Period	getCollectedPeriod()
Reference	getCollector()
Practitioner	getCollectorTarget()
List<StringType>	getComment()
CodeableConcept	getMethod()
SimpleQuantity	getQuantity()
boolean	hasBodySite()
boolean	hasCollected()
boolean	hasCollectedDateTimeType()
boolean	hasCollectedPeriod()
boolean	hasCollector()
boolean	hasComment()
boolean	hasComment(String value)
boolean	hasMethod()
boolean	hasQuantity()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Specimen.SpecimenCollectionComponent	setBodySite(CodeableConcept value)
Specimen.SpecimenCollectionComponent	setCollected(Type value)
Specimen.SpecimenCollectionComponent	setCollector(Reference value)
Specimen.SpecimenCollectionComponent	setCollectorTarget(Practitioner value)
Specimen.SpecimenCollectionComponent	setMethod(CodeableConcept value)
void	setProperty(String name, Base value)
Specimen.SpecimenCollectionComponent	setQuantity(SimpleQuantity value)

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

addModifierExtension, addModifierExtension, copyValues, getModifierExtension, hasModifierExtension

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

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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, getUserData, hasFormatComment, setUserData

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

getUserData, setUserData

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 Details

collector

protected Reference collector

Person who collected the specimen.

collectorTarget

protected Practitioner collectorTarget

The actual object that is the target of the reference (Person who collected the specimen.)

comment

protected List<StringType> comment

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

collected

protected Type collected

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

quantity

protected SimpleQuantity quantity

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

method

protected CodeableConcept method

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

bodySite

protected CodeableConcept bodySite

Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.

Constructor Details

SpecimenCollectionComponent

public SpecimenCollectionComponent()

Method Details

getCollector

public Reference getCollector()

Returns:

collector (Person who collected the specimen.)

hasCollector

public boolean hasCollector()

setCollector

public Specimen.SpecimenCollectionComponent setCollector(Reference value)

Parameters:

value - collector (Person who collected the specimen.)

getCollectorTarget

public Practitioner getCollectorTarget()

Returns:

collector The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Person who collected the specimen.)

setCollectorTarget

public Specimen.SpecimenCollectionComponent setCollectorTarget(Practitioner value)

Parameters:

value - collector The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Person who collected the specimen.)

getComment

public List<StringType> getComment()

Returns:

comment (To communicate any details or issues encountered during the specimen collection procedure.)

hasComment

public boolean hasComment()

addCommentElement

public StringType addCommentElement()

Returns:

comment (To communicate any details or issues encountered during the specimen collection procedure.)

addComment

public Specimen.SpecimenCollectionComponent addComment(String value)

Parameters:

value - comment (To communicate any details or issues encountered during the specimen collection procedure.)

hasComment

public boolean hasComment(String value)

Parameters:

value - comment (To communicate any details or issues encountered during the specimen collection procedure.)

getCollected

public Type getCollected()

Returns:

collected (Time when specimen was collected from subject - the physiologically relevant time.)

getCollectedDateTimeType

public DateTimeType getCollectedDateTimeType()
                                      throws org.hl7.fhir.exceptions.FHIRException

Returns:

collected (Time when specimen was collected from subject - the physiologically relevant time.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasCollectedDateTimeType

public boolean hasCollectedDateTimeType()

getCollectedPeriod

public Period getCollectedPeriod()
                          throws org.hl7.fhir.exceptions.FHIRException

Returns:

collected (Time when specimen was collected from subject - the physiologically relevant time.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasCollectedPeriod

public boolean hasCollectedPeriod()

hasCollected

public boolean hasCollected()

setCollected

public Specimen.SpecimenCollectionComponent setCollected(Type value)

Parameters:

value - collected (Time when specimen was collected from subject - the physiologically relevant time.)

getQuantity

public SimpleQuantity getQuantity()

Returns:

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

hasQuantity

public boolean hasQuantity()

setQuantity

public Specimen.SpecimenCollectionComponent setQuantity(SimpleQuantity value)

Parameters:

value - quantity (The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.)

getMethod

public CodeableConcept getMethod()

Returns:

method (A coded value specifying the technique that is used to perform the procedure.)

hasMethod

public boolean hasMethod()

setMethod

public Specimen.SpecimenCollectionComponent setMethod(CodeableConcept value)

Parameters:

value - method (A coded value specifying the technique that is used to perform the procedure.)

getBodySite

public CodeableConcept getBodySite()

Returns:

bodySite (Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.)

hasBodySite

public boolean hasBodySite()

setBodySite

public Specimen.SpecimenCollectionComponent setBodySite(CodeableConcept value)

Parameters:

value - bodySite (Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class BackboneElement

setProperty

public void setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public Specimen.SpecimenCollectionComponent 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 org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class BackboneElement