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

java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.BaseResource
  - - org.hl7.fhir.r4.model.Resource
    - - org.hl7.fhir.r4.model.DomainResource
      - org.hl7.fhir.r4.model.Specimen

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
```
public class Specimen
extends DomainResource
```
A sample to be used for analysis.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Specimen.SpecimenCollectionComponent`
`static class`	`Specimen.SpecimenContainerComponent`
`static class`	`Specimen.SpecimenProcessingComponent`
`static class`	`Specimen.SpecimenStatus`
`static class`	`Specimen.SpecimenStatusEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`ACCESSION` Fluent Client search parameter constant for accession
`protected Identifier`	`accessionIdentifier` The identifier assigned by the lab when accessioning specimen(s).
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`BODYSITE` Fluent Client search parameter constant for bodysite
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`COLLECTED` Fluent Client search parameter constant for collected
`protected Specimen.SpecimenCollectionComponent`	`collection` Details concerning the specimen collection.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`COLLECTOR` Fluent Client search parameter constant for collector
`protected List<CodeableConcept>`	`condition` A mode or state of being that describes the nature of the specimen.
`protected List<Specimen.SpecimenContainerComponent>`	`container` The container holding the specimen.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`CONTAINER` Fluent Client search parameter constant for container
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`CONTAINER_ID` Fluent Client search parameter constant for container-id
`protected List<Identifier>`	`identifier` Id for specimen.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_COLLECTOR` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PARENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`protected List<Annotation>`	`note` To communicate any details or issues about the specimen or during the specimen collection.
`protected List<Reference>`	`parent` Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PARENT` Fluent Client search parameter constant for parent
`protected List<Specimen>`	`parentTarget` The actual objects that are the target of the reference (Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.)
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`protected List<Specimen.SpecimenProcessingComponent>`	`processing` Details concerning processing and processing steps for the specimen.
`protected DateTimeType`	`receivedTime` Time when specimen was received for processing or testing.
`protected List<Reference>`	`request` Details concerning a service request that required a specimen to be collected.
`protected List<ServiceRequest>`	`requestTarget` The actual objects that are the target of the reference (Details concerning a service request that required a specimen to be collected.)
`static String`	`SP_ACCESSION` Search parameter: accession
`static String`	`SP_BODYSITE` Search parameter: bodysite
`static String`	`SP_COLLECTED` Search parameter: collected
`static String`	`SP_COLLECTOR` Search parameter: collector
`static String`	`SP_CONTAINER` Search parameter: container
`static String`	`SP_CONTAINER_ID` Search parameter: container-id
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_PARENT` Search parameter: parent
`static String`	`SP_PATIENT` Search parameter: patient
`static String`	`SP_STATUS` Search parameter: status
`static String`	`SP_SUBJECT` Search parameter: subject
`static String`	`SP_TYPE` Search parameter: type
`protected Enumeration<Specimen.SpecimenStatus>`	`status` The availability of the specimen.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`protected Reference`	`subject` Where the specimen came from.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`protected Resource`	`subjectTarget` The actual object that is the target of the reference (Where the specimen came from.
`protected CodeableConcept`	`type` The kind of material that forms the specimen.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`TYPE` Fluent Client search parameter constant for type

Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

Specimen()
Constructor

Constructors
Constructor and Description
`Specimen()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`CodeableConcept`	`addCondition()`
`Specimen`	`addCondition(CodeableConcept t)`
`Specimen.SpecimenContainerComponent`	`addContainer()`
`Specimen`	`addContainer(Specimen.SpecimenContainerComponent t)`
`Identifier`	`addIdentifier()`
`Specimen`	`addIdentifier(Identifier t)`
`Annotation`	`addNote()`
`Specimen`	`addNote(Annotation t)`
`Reference`	`addParent()`
`Specimen`	`addParent(Reference t)`
`Specimen`	`addParentTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`Specimen.SpecimenProcessingComponent`	`addProcessing()`
`Specimen`	`addProcessing(Specimen.SpecimenProcessingComponent t)`
`Reference`	`addRequest()`
`Specimen`	`addRequest(Reference t)`
`ServiceRequest`	`addRequestTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`Specimen`	`copy()`
`void`	`copyValues(Specimen dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`Identifier`	`getAccessionIdentifier()`
`Specimen.SpecimenCollectionComponent`	`getCollection()`
`List<CodeableConcept>`	`getCondition()`
`CodeableConcept`	`getConditionFirstRep()`
`List<Specimen.SpecimenContainerComponent>`	`getContainer()`
`Specimen.SpecimenContainerComponent`	`getContainerFirstRep()`
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`List<Annotation>`	`getNote()`
`Annotation`	`getNoteFirstRep()`
`List<Reference>`	`getParent()`
`Reference`	`getParentFirstRep()`
`List<Specimen>`	`getParentTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`List<Specimen.SpecimenProcessingComponent>`	`getProcessing()`
`Specimen.SpecimenProcessingComponent`	`getProcessingFirstRep()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`Date`	`getReceivedTime()`
`DateTimeType`	`getReceivedTimeElement()`
`List<Reference>`	`getRequest()`
`Reference`	`getRequestFirstRep()`
`List<ServiceRequest>`	`getRequestTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`ResourceType`	`getResourceType()`
`Specimen.SpecimenStatus`	`getStatus()`
`Enumeration<Specimen.SpecimenStatus>`	`getStatusElement()`
`Reference`	`getSubject()`
`Resource`	`getSubjectTarget()`
`CodeableConcept`	`getType()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasAccessionIdentifier()`
`boolean`	`hasCollection()`
`boolean`	`hasCondition()`
`boolean`	`hasContainer()`
`boolean`	`hasIdentifier()`
`boolean`	`hasNote()`
`boolean`	`hasParent()`
`boolean`	`hasProcessing()`
`boolean`	`hasReceivedTime()`
`boolean`	`hasReceivedTimeElement()`
`boolean`	`hasRequest()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasSubject()`
`boolean`	`hasType()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`Specimen`	`setAccessionIdentifier(Identifier value)`
`Specimen`	`setCollection(Specimen.SpecimenCollectionComponent value)`
`Specimen`	`setCondition(List<CodeableConcept> theCondition)`
`Specimen`	`setContainer(List<Specimen.SpecimenContainerComponent> theContainer)`
`Specimen`	`setIdentifier(List<Identifier> theIdentifier)`
`Specimen`	`setNote(List<Annotation> theNote)`
`Specimen`	`setParent(List<Reference> theParent)`
`Specimen`	`setProcessing(List<Specimen.SpecimenProcessingComponent> theProcessing)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Specimen`	`setReceivedTime(Date value)`
`Specimen`	`setReceivedTimeElement(DateTimeType value)`
`Specimen`	`setRequest(List<Reference> theRequest)`
`Specimen`	`setStatus(Specimen.SpecimenStatus value)`
`Specimen`	`setStatusElement(Enumeration<Specimen.SpecimenStatus> value)`
`Specimen`	`setSubject(Reference value)`
`Specimen`	`setSubjectTarget(Resource value)`
`Specimen`	`setType(CodeableConcept value)`
`protected Specimen`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

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, 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.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    Id for specimen.
  - accessionIdentifier
```
protected Identifier accessionIdentifier
```
    The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
  - status
```
protected Enumeration<Specimen.SpecimenStatus> status
```
    The availability of the specimen.
  - type
```
protected CodeableConcept type
```
    The kind of material that forms the specimen.
  - subject
```
protected Reference subject
```
    Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.
  - subjectTarget
```
protected Resource subjectTarget
```
    The actual object that is the target of the reference (Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.)
  - receivedTime
```
protected DateTimeType receivedTime
```
    Time when specimen was received for processing or testing.
  - parent
```
protected List<Reference> parent
```
    Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
  - parentTarget
```
protected List<Specimen> parentTarget
```
    The actual objects that are the target of the reference (Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.)
  - request
```
protected List<Reference> request
```
    Details concerning a service request that required a specimen to be collected.
  - requestTarget
```
protected List<ServiceRequest> requestTarget
```
    The actual objects that are the target of the reference (Details concerning a service request that required a specimen to be collected.)
  - collection
```
protected Specimen.SpecimenCollectionComponent collection
```
    Details concerning the specimen collection.
  - processing
```
protected List<Specimen.SpecimenProcessingComponent> processing
```
    Details concerning processing and processing steps for the specimen.
  - container
```
protected List<Specimen.SpecimenContainerComponent> container
```
    The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
  - condition
```
protected List<CodeableConcept> condition
```
    A mode or state of being that describes the nature of the specimen.
  - note
```
protected List<Annotation> note
```
    To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).
  - SP_CONTAINER
```
public static final String SP_CONTAINER
```
    Search parameter: container
    Description: The kind of specimen container
    Type: token
    Path: Specimen.container.type
    
    See Also:
    
    Constant Field Values
  - CONTAINER
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTAINER
```
    Fluent Client search parameter constant for container
    Description: The kind of specimen container
    Type: token
    Path: Specimen.container.type
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: The unique identifier associated with the specimen
    Type: token
    Path: Specimen.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: The unique identifier associated with the specimen
    Type: token
    Path: Specimen.identifier
  - SP_PARENT
```
public static final String SP_PARENT
```
    Search parameter: parent
    Description: The parent of the specimen
    Type: reference
    Path: Specimen.parent
    
    See Also:
    
    Constant Field Values
  - PARENT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARENT
```
    Fluent Client search parameter constant for parent
    Description: The parent of the specimen
    Type: reference
    Path: Specimen.parent
  - INCLUDE_PARENT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PARENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:parent".
  - SP_CONTAINER_ID
```
public static final String SP_CONTAINER_ID
```
    Search parameter: container-id
    Description: The unique identifier associated with the specimen container
    Type: token
    Path: Specimen.container.identifier
    
    See Also:
    
    Constant Field Values
  - CONTAINER_ID
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTAINER_ID
```
    Fluent Client search parameter constant for container-id
    Description: The unique identifier associated with the specimen container
    Type: token
    Path: Specimen.container.identifier
  - SP_BODYSITE
```
public static final String SP_BODYSITE
```
    Search parameter: bodysite
    Description: The code for the body site from where the specimen originated
    Type: token
    Path: Specimen.collection.bodySite
    
    See Also:
    
    Constant Field Values
  - BODYSITE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam BODYSITE
```
    Fluent Client search parameter constant for bodysite
    Description: The code for the body site from where the specimen originated
    Type: token
    Path: Specimen.collection.bodySite
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter: subject
    Description: The subject of the specimen
    Type: reference
    Path: Specimen.subject
    
    See Also:
    
    Constant Field Values
  - SUBJECT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description: The subject of the specimen
    Type: reference
    Path: Specimen.subject
  - INCLUDE_SUBJECT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:subject".
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter: patient
    Description: The patient the specimen comes from
    Type: reference
    Path: Specimen.subject
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: The patient the specimen comes from
    Type: reference
    Path: Specimen.subject
  - INCLUDE_PATIENT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:patient".
  - SP_COLLECTED
```
public static final String SP_COLLECTED
```
    Search parameter: collected
    Description: The date the specimen was collected
    Type: date
    Path: Specimen.collection.collected[x]
    
    See Also:
    
    Constant Field Values
  - COLLECTED
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam COLLECTED
```
    Fluent Client search parameter constant for collected
    Description: The date the specimen was collected
    Type: date
    Path: Specimen.collection.collected[x]
  - SP_ACCESSION
```
public static final String SP_ACCESSION
```
    Search parameter: accession
    Description: The accession number associated with the specimen
    Type: token
    Path: Specimen.accessionIdentifier
    
    See Also:
    
    Constant Field Values
  - ACCESSION
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACCESSION
```
    Fluent Client search parameter constant for accession
    Description: The accession number associated with the specimen
    Type: token
    Path: Specimen.accessionIdentifier
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter: type
    Description: The specimen type
    Type: token
    Path: Specimen.type
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
```
    Fluent Client search parameter constant for type
    Description: The specimen type
    Type: token
    Path: Specimen.type
  - SP_COLLECTOR
```
public static final String SP_COLLECTOR
```
    Search parameter: collector
    Description: Who collected the specimen
    Type: reference
    Path: Specimen.collection.collector
    
    See Also:
    
    Constant Field Values
  - COLLECTOR
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam COLLECTOR
```
    Fluent Client search parameter constant for collector
    Description: Who collected the specimen
    Type: reference
    Path: Specimen.collection.collector
  - INCLUDE_COLLECTOR
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_COLLECTOR
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:collector".
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter: status
    Description: available | unavailable | unsatisfactory | entered-in-error
    Type: token
    Path: Specimen.status
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description: available | unavailable | unsatisfactory | entered-in-error
    Type: token
    Path: Specimen.status
- Constructor Detail
  - Specimen
```
public Specimen()
```
    Constructor
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (Id for specimen.)
  - setIdentifier
```
public Specimen setIdentifier(List<Identifier> theIdentifier)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
  - addIdentifier
```
public Specimen addIdentifier(Identifier t)
```
  - getIdentifierFirstRep
```
public Identifier getIdentifierFirstRep()
```
    Returns:
    
    The first repetition of repeating field identifier, creating it if it does not already exist
  - getAccessionIdentifier
```
public Identifier getAccessionIdentifier()
```
    Returns:
    
    accessionIdentifier (The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.)
  - hasAccessionIdentifier
```
public boolean hasAccessionIdentifier()
```
  - setAccessionIdentifier
```
public Specimen setAccessionIdentifier(Identifier value)
```
    Parameters:
    
    value - accessionIdentifier (The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.)
  - getStatusElement
```
public Enumeration<Specimen.SpecimenStatus> getStatusElement()
```
    Returns:
    
    status (The availability of the specimen.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - setStatusElement
```
public Specimen setStatusElement(Enumeration<Specimen.SpecimenStatus> value)
```
    Parameters:
    
    value - status (The availability of the specimen.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public Specimen.SpecimenStatus getStatus()
```
    Returns:
    
    The availability of the specimen.
  - setStatus
```
public Specimen setStatus(Specimen.SpecimenStatus value)
```
    Parameters:
    
    value - The availability of the specimen.
  - getType
```
public CodeableConcept getType()
```
    Returns:
    
    type (The kind of material that forms the specimen.)
  - hasType
```
public boolean hasType()
```
  - setType
```
public Specimen setType(CodeableConcept value)
```
    Parameters:
    
    value - type (The kind of material that forms the specimen.)
  - getSubject
```
public Reference getSubject()
```
    Returns:
    
    subject (Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.)
  - hasSubject
```
public boolean hasSubject()
```
  - setSubject
```
public Specimen setSubject(Reference value)
```
    Parameters:
    
    value - subject (Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.)
  - getSubjectTarget
```
public Resource getSubjectTarget()
```
    Returns:
    
    subject 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. (Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.)
  - setSubjectTarget
```
public Specimen setSubjectTarget(Resource value)
```
    Parameters:
    
    value - subject 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. (Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.)
  - getReceivedTimeElement
```
public DateTimeType getReceivedTimeElement()
```
    Returns:
    
    receivedTime (Time when specimen was received for processing or testing.). This is the underlying object with id, value and extensions. The accessor "getReceivedTime" gives direct access to the value
  - hasReceivedTimeElement
```
public boolean hasReceivedTimeElement()
```
  - hasReceivedTime
```
public boolean hasReceivedTime()
```
  - setReceivedTimeElement
```
public Specimen setReceivedTimeElement(DateTimeType value)
```
    Parameters:
    
    value - receivedTime (Time when specimen was received for processing or testing.). This is the underlying object with id, value and extensions. The accessor "getReceivedTime" gives direct access to the value
  - getReceivedTime
```
public Date getReceivedTime()
```
    Returns:
    
    Time when specimen was received for processing or testing.
  - setReceivedTime
```
public Specimen setReceivedTime(Date value)
```
    Parameters:
    
    value - Time when specimen was received for processing or testing.
  - getParent
```
public List<Reference> getParent()
```
    Returns:
    
    parent (Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.)
  - setParent
```
public Specimen setParent(List<Reference> theParent)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasParent
```
public boolean hasParent()
```
  - addParent
```
public Reference addParent()
```
  - addParent
```
public Specimen addParent(Reference t)
```
  - getParentFirstRep
```
public Reference getParentFirstRep()
```
    Returns:
    
    The first repetition of repeating field parent, creating it if it does not already exist
  - getParentTarget
```
@Deprecated
public List<Specimen> getParentTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - addParentTarget
```
@Deprecated
public Specimen addParentTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - getRequest
```
public List<Reference> getRequest()
```
    Returns:
    
    request (Details concerning a service request that required a specimen to be collected.)
  - setRequest
```
public Specimen setRequest(List<Reference> theRequest)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasRequest
```
public boolean hasRequest()
```
  - addRequest
```
public Reference addRequest()
```
  - addRequest
```
public Specimen addRequest(Reference t)
```
  - getRequestFirstRep
```
public Reference getRequestFirstRep()
```
    Returns:
    
    The first repetition of repeating field request, creating it if it does not already exist
  - getRequestTarget
```
@Deprecated
public List<ServiceRequest> getRequestTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - addRequestTarget
```
@Deprecated
public ServiceRequest addRequestTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - getCollection
```
public Specimen.SpecimenCollectionComponent getCollection()
```
    Returns:
    
    collection (Details concerning the specimen collection.)
  - hasCollection
```
public boolean hasCollection()
```
  - setCollection
```
public Specimen setCollection(Specimen.SpecimenCollectionComponent value)
```
    Parameters:
    
    value - collection (Details concerning the specimen collection.)
  - getProcessing
```
public List<Specimen.SpecimenProcessingComponent> getProcessing()
```
    Returns:
    
    processing (Details concerning processing and processing steps for the specimen.)
  - setProcessing
```
public Specimen setProcessing(List<Specimen.SpecimenProcessingComponent> theProcessing)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasProcessing
```
public boolean hasProcessing()
```
  - addProcessing
```
public Specimen.SpecimenProcessingComponent addProcessing()
```
  - addProcessing
```
public Specimen addProcessing(Specimen.SpecimenProcessingComponent t)
```
  - getProcessingFirstRep
```
public Specimen.SpecimenProcessingComponent getProcessingFirstRep()
```
    Returns:
    
    The first repetition of repeating field processing, creating it if it does not already exist
  - getContainer
```
public List<Specimen.SpecimenContainerComponent> getContainer()
```
    Returns:
    
    container (The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.)
  - setContainer
```
public Specimen setContainer(List<Specimen.SpecimenContainerComponent> theContainer)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasContainer
```
public boolean hasContainer()
```
  - addContainer
```
public Specimen.SpecimenContainerComponent addContainer()
```
  - addContainer
```
public Specimen addContainer(Specimen.SpecimenContainerComponent t)
```
  - getContainerFirstRep
```
public Specimen.SpecimenContainerComponent getContainerFirstRep()
```
    Returns:
    
    The first repetition of repeating field container, creating it if it does not already exist
  - getCondition
```
public List<CodeableConcept> getCondition()
```
    Returns:
    
    condition (A mode or state of being that describes the nature of the specimen.)
  - setCondition
```
public Specimen setCondition(List<CodeableConcept> theCondition)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasCondition
```
public boolean hasCondition()
```
  - addCondition
```
public CodeableConcept addCondition()
```
  - addCondition
```
public Specimen addCondition(CodeableConcept t)
```
  - getConditionFirstRep
```
public CodeableConcept getConditionFirstRep()
```
    Returns:
    
    The first repetition of repeating field condition, creating it if it does not already exist
  - getNote
```
public List<Annotation> getNote()
```
    Returns:
    
    note (To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).)
  - setNote
```
public Specimen setNote(List<Annotation> theNote)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasNote
```
public boolean hasNote()
```
  - addNote
```
public Annotation addNote()
```
  - addNote
```
public Specimen addNote(Annotation t)
```
  - getNoteFirstRep
```
public Annotation getNoteFirstRep()
```
    Returns:
    
    The first repetition of repeating field note, creating it if it does not already exist
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class DomainResource
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class DomainResource
    
    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 DomainResource
    
    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 DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Specified by:
    
    fhirType in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public Specimen copy()
```
    Specified by:
    
    copy in class DomainResource
  - copyValues
```
public void copyValues(Specimen dst)
```
  - typedCopy
```
protected Specimen typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other_)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other_)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class Specimen

Nested Class Summary

Field Summary

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

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

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

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

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

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

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

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

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

Field Detail

identifier

accessionIdentifier

status

type

subject

subjectTarget

receivedTime

parent

parentTarget

request

requestTarget

collection

processing

container

condition

note

SP_CONTAINER

CONTAINER

SP_IDENTIFIER

IDENTIFIER

SP_PARENT

PARENT

INCLUDE_PARENT

SP_CONTAINER_ID

CONTAINER_ID

SP_BODYSITE

BODYSITE

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_COLLECTED

COLLECTED

SP_ACCESSION

ACCESSION

SP_TYPE

TYPE

SP_COLLECTOR

COLLECTOR

INCLUDE_COLLECTOR

SP_STATUS

STATUS

Constructor Detail

Specimen

Method Detail

getIdentifier

setIdentifier

hasIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getAccessionIdentifier

hasAccessionIdentifier

setAccessionIdentifier

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus