Package org.hl7.fhir.r5.model

Class Specimen.SpecimenCollectionComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.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

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeableReference	bodySite	Anatomical location from which the specimen was collected (if subject is a patient).
protected DataType	collected	Time when specimen was collected from subject - the physiologically relevant time.
protected Reference	collector	Person who collected the specimen.
protected CodeableReference	device	A coded value specifying the technique that is used to perform the procedure.
protected Duration	duration	The span of time over which the collection of a specimen occurred.
protected DataType	fastingStatus	Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.
protected CodeableConcept	method	A coded value specifying the technique that is used to perform the procedure.
protected Reference	procedure	The procedure event during which the specimen was collected (e.g. the surgery leading to the collection of a pathology sample).
protected Quantity	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.r5.model.BackboneElement

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
SpecimenCollectionComponent()	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Specimen.SpecimenCollectionComponent	copy()
void	copyValues(Specimen.SpecimenCollectionComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
CodeableReference	getBodySite()
DataType	getCollected()
DateTimeType	getCollectedDateTimeType()
Period	getCollectedPeriod()
Reference	getCollector()
CodeableReference	getDevice()
Duration	getDuration()
DataType	getFastingStatus()
CodeableConcept	getFastingStatusCodeableConcept()
Duration	getFastingStatusDuration()
CodeableConcept	getMethod()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Reference	getProcedure()
Base[]	getProperty(int hash, String name, boolean checkValid)
Quantity	getQuantity()
String[]	getTypesForProperty(int hash, String name)
boolean	hasBodySite()
boolean	hasCollected()
boolean	hasCollectedDateTimeType()
boolean	hasCollectedPeriod()
boolean	hasCollector()
boolean	hasDevice()
boolean	hasDuration()
boolean	hasFastingStatus()
boolean	hasFastingStatusCodeableConcept()
boolean	hasFastingStatusDuration()
boolean	hasMethod()
boolean	hasProcedure()
boolean	hasQuantity()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Specimen.SpecimenCollectionComponent	setBodySite(CodeableReference value)
Specimen.SpecimenCollectionComponent	setCollected(DataType value)
Specimen.SpecimenCollectionComponent	setCollector(Reference value)
Specimen.SpecimenCollectionComponent	setDevice(CodeableReference value)
Specimen.SpecimenCollectionComponent	setDuration(Duration value)
Specimen.SpecimenCollectionComponent	setFastingStatus(DataType value)
Specimen.SpecimenCollectionComponent	setMethod(CodeableConcept value)
Specimen.SpecimenCollectionComponent	setProcedure(Reference value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Specimen.SpecimenCollectionComponent	setQuantity(Quantity value)

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

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getExtensionValue, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtml

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.

collected

protected DataType collected

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

duration

protected Duration duration

The span of time over which the collection of a specimen occurred.

quantity

protected Quantity 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.

device

protected CodeableReference device

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

procedure

protected Reference procedure

The procedure event during which the specimen was collected (e.g. the surgery leading to the collection of a pathology sample).

bodySite

protected CodeableReference 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.

fastingStatus

protected DataType fastingStatus

Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.

Constructor Details

SpecimenCollectionComponent

public SpecimenCollectionComponent()

Constructor

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

getCollected

public DataType 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(DataType value)

Parameters:

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

getDuration

public Duration getDuration()

Returns:

duration (The span of time over which the collection of a specimen occurred.)

hasDuration

public boolean hasDuration()

setDuration

public Specimen.SpecimenCollectionComponent setDuration(Duration value)

Parameters:

value - duration (The span of time over which the collection of a specimen occurred.)

getQuantity

public Quantity 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(Quantity 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.)

getDevice

public CodeableReference getDevice()

Returns:

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

hasDevice

public boolean hasDevice()

setDevice

public Specimen.SpecimenCollectionComponent setDevice(CodeableReference value)

Parameters:

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

getProcedure

public Reference getProcedure()

Returns:

procedure (The procedure event during which the specimen was collected (e.g. the surgery leading to the collection of a pathology sample).)

hasProcedure

public boolean hasProcedure()

setProcedure

public Specimen.SpecimenCollectionComponent setProcedure(Reference value)

Parameters:

value - procedure (The procedure event during which the specimen was collected (e.g. the surgery leading to the collection of a pathology sample).)

getBodySite

public CodeableReference 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(CodeableReference 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.)

getFastingStatus

public DataType getFastingStatus()

Returns:

fastingStatus (Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.)

getFastingStatusCodeableConcept

public CodeableConcept getFastingStatusCodeableConcept()
                                                throws org.hl7.fhir.exceptions.FHIRException

Returns:

fastingStatus (Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasFastingStatusCodeableConcept

public boolean hasFastingStatusCodeableConcept()

getFastingStatusDuration

public Duration getFastingStatusDuration()
                                  throws org.hl7.fhir.exceptions.FHIRException

Returns:

fastingStatus (Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasFastingStatusDuration

public boolean hasFastingStatusDuration()

hasFastingStatus

public boolean hasFastingStatus()

setFastingStatus

public Specimen.SpecimenCollectionComponent setFastingStatus(DataType value)

Parameters:

value - fastingStatus (Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty 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

copyValues

public void copyValues(Specimen.SpecimenCollectionComponent dst)

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

Returns:

the FHIR type name of the instance (not the java class name)