Specimen.SpecimenCollectionComponent (org.hl7.fhir.r4 5.4.0 API)

java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.Element
  - - org.hl7.fhir.r4.model.BackboneElement
    - - org.hl7.fhir.r4.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 and 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 Resource`	`collectorTarget` The actual object that is the target of the reference (Person who collected the specimen.)
`protected Duration`	`duration` The span of time over which the collection of a specimen occurred.
`protected Type`	`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 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.r4.model.BackboneElement
modifierExtension

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

Constructor Summary

Constructors
Constructor and Description

SpecimenCollectionComponent()
Constructor

Constructors
Constructor and Description
`SpecimenCollectionComponent()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Specimen.SpecimenCollectionComponent`	`copy()`
`void`	`copyValues(Specimen.SpecimenCollectionComponent dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`CodeableConcept`	`getBodySite()`
`Type`	`getCollected()`
`DateTimeType`	`getCollectedDateTimeType()`
`Period`	`getCollectedPeriod()`
`Reference`	`getCollector()`
`Resource`	`getCollectorTarget()`
`Duration`	`getDuration()`
`Type`	`getFastingStatus()`
`CodeableConcept`	`getFastingStatusCodeableConcept()`
`Duration`	`getFastingStatusDuration()`
`CodeableConcept`	`getMethod()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`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`	`hasDuration()`
`boolean`	`hasFastingStatus()`
`boolean`	`hasFastingStatusCodeableConcept()`
`boolean`	`hasFastingStatusDuration()`
`boolean`	`hasMethod()`
`boolean`	`hasQuantity()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`Specimen.SpecimenCollectionComponent`	`setBodySite(CodeableConcept value)`
`Specimen.SpecimenCollectionComponent`	`setCollected(Type value)`
`Specimen.SpecimenCollectionComponent`	`setCollector(Reference value)`
`Specimen.SpecimenCollectionComponent`	`setCollectorTarget(Resource value)`
`Specimen.SpecimenCollectionComponent`	`setDuration(Duration value)`
`Specimen.SpecimenCollectionComponent`	`setFastingStatus(Type value)`
`Specimen.SpecimenCollectionComponent`	`setMethod(CodeableConcept 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.r4.model.BackboneElement
addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.r4.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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.IBaseHasExtensions
addExtension, getExtension, hasExtension

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.IBaseHasModifierExtensions
addModifierExtension, getModifierExtension, hasModifierExtension

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

- Field Detail
  - collector
```
protected Reference collector
```
    Person who collected the specimen.
  - collectorTarget
```
protected Resource collectorTarget
```
    The actual object that is the target of the reference (Person who collected the specimen.)
  - collected
```
protected Type 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.
  - 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.
  - fastingStatus
```
protected Type fastingStatus
```
    Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.
- Constructor Detail
  - SpecimenCollectionComponent
```
public SpecimenCollectionComponent()
```
    Constructor
- Method Detail
  - 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 Resource 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(Resource 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.)
  - 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.)
  - 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.)
  - 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.)
  - getFastingStatus
```
public Type 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(Type 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
  - 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

Class Specimen.SpecimenCollectionComponent

Field Summary

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

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

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

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

Field Detail

collector

collectorTarget

collected

duration

quantity

method

bodySite

fastingStatus

Constructor Detail

SpecimenCollectionComponent

Method Detail

getCollector

hasCollector

setCollector

getCollectorTarget

setCollectorTarget

getCollected

getCollectedDateTimeType

hasCollectedDateTimeType

getCollectedPeriod

hasCollectedPeriod

hasCollected

setCollected

getDuration

hasDuration

setDuration

getQuantity

hasQuantity

setQuantity

getMethod

hasMethod

setMethod

getBodySite

hasBodySite

setBodySite

getFastingStatus

getFastingStatusCodeableConcept

hasFastingStatusCodeableConcept

getFastingStatusDuration

hasFastingStatusDuration

hasFastingStatus

setFastingStatus

listChildren

getNamedProperty

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty

addChild

copy

copyValues

equalsDeep

equalsShallow

isEmpty

fhirType