Specimen (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.Specimen

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class Specimen
extends BaseResource
implements IResource
```
HAPI/FHIR Specimen Resource (clinical.diagnostics)
Definition: A sample to be used for analysis.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/Specimen

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Specimen.Collection` Block class for child element: Specimen.collection ()
`static class`	`Specimen.Container` Block class for child element: Specimen.container ()
`static class`	`Specimen.Treatment` Block class for child element: Specimen.treatment ()

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`ACCESSION` Fluent Client search parameter constant for accession
`static TokenClientParam`	`BODYSITE` Fluent Client search parameter constant for bodysite
`static DateClientParam`	`COLLECTED` Fluent Client search parameter constant for collected
`static ReferenceClientParam`	`COLLECTOR` Fluent Client search parameter constant for collector
`static TokenClientParam`	`CONTAINER` Fluent Client search parameter constant for container
`static TokenClientParam`	`CONTAINER_ID` Fluent Client search parameter constant for container-id
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_COLLECTOR` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PARENT` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`PARENT` Fluent Client search parameter constant for parent
`static ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static String`	`SP_ACCESSION` Search parameter constant for accession
`static String`	`SP_BODYSITE` Search parameter constant for bodysite
`static String`	`SP_COLLECTED` Search parameter constant for collected
`static String`	`SP_COLLECTOR` Search parameter constant for collector
`static String`	`SP_CONTAINER` Search parameter constant for container
`static String`	`SP_CONTAINER_ID` Search parameter constant for container-id
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_PARENT` Search parameter constant for parent
`static String`	`SP_PATIENT` Search parameter constant for patient
`static String`	`SP_SUBJECT` Search parameter constant for subject
`static String`	`SP_TYPE` Search parameter constant for type
`static ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`static TokenClientParam`	`TYPE` Fluent Client search parameter constant for type

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
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()

Constructors
Constructor and Description
`Specimen()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Specimen.Container`	`addContainer()` Adds and returns a new value for container ()
`Specimen`	`addContainer(Specimen.Container theValue)` Adds a given new value for container ()
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (id)
`Specimen`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier (id)
`ResourceReferenceDt`	`addParent()` Adds and returns a new value for parent ()
`Specimen.Treatment`	`addTreatment()` Adds and returns a new value for treatment ()
`Specimen`	`addTreatment(Specimen.Treatment theValue)` Adds a given new value for treatment ()
`IdentifierDt`	`getAccessionIdentifier()` Gets the value(s) for accessionIdentifier (id).
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`Specimen.Collection`	`getCollection()` Gets the value(s) for collection ().
`List<Specimen.Container>`	`getContainer()` Gets the value(s) for container ().
`Specimen.Container`	`getContainerFirstRep()` Gets the first repetition for container (), creating it if it does not already exist.
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (id).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (id), creating it if it does not already exist.
`List<ResourceReferenceDt>`	`getParent()` Gets the value(s) for parent ().
`Date`	`getReceivedTime()` Gets the value(s) for receivedTime (when.done).
`DateTimeDt`	`getReceivedTimeElement()` Gets the value(s) for receivedTime (when.done).
`String`	`getResourceName()`
`String`	`getStatus()` Gets the value(s) for status (status).
`BoundCodeDt<SpecimenStatusEnum>`	`getStatusElement()` Gets the value(s) for status (status).
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`ResourceReferenceDt`	`getSubject()` Gets the value(s) for subject (who.focus).
`List<Specimen.Treatment>`	`getTreatment()` Gets the value(s) for treatment ().
`Specimen.Treatment`	`getTreatmentFirstRep()` Gets the first repetition for treatment (), creating it if it does not already exist.
`CodeableConceptDt`	`getType()` Gets the value(s) for type (class).
`boolean`	`isEmpty()`
`Specimen`	`setAccessionIdentifier(IdentifierDt theValue)` Sets the value(s) for accessionIdentifier (id)
`Specimen`	`setCollection(Specimen.Collection theValue)` Sets the value(s) for collection ()
`Specimen`	`setContainer(List<Specimen.Container> theValue)` Sets the value(s) for container ()
`Specimen`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (id)
`Specimen`	`setParent(List<ResourceReferenceDt> theValue)` Sets the value(s) for parent ()
`Specimen`	`setReceivedTime(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for receivedTime (when.done)
`Specimen`	`setReceivedTime(DateTimeDt theValue)` Sets the value(s) for receivedTime (when.done)
`Specimen`	`setReceivedTimeWithSecondsPrecision(Date theDate)` Sets the value for receivedTime (when.done)
`Specimen`	`setStatus(BoundCodeDt<SpecimenStatusEnum> theValue)` Sets the value(s) for status (status)
`Specimen`	`setStatus(SpecimenStatusEnum theValue)` Sets the value(s) for status (status)
`Specimen`	`setSubject(ResourceReferenceDt theValue)` Sets the value(s) for subject (who.focus)
`Specimen`	`setTreatment(List<Specimen.Treatment> theValue)` Sets the value(s) for treatment ()
`Specimen`	`setType(CodeableConceptDt theValue)` Sets the value(s) for type (class)

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

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

- Field Detail
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter constant for subject
    Description: The subject of the specimen
    Type: reference
    Path: Specimen.subject
    
    See Also:
    
    Constant Field Values
  - SUBJECT
```
public static final ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description: The subject of the specimen
    Type: reference
    Path: Specimen.subject
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description: The patient the specimen comes from
    Type: reference
    Path: Specimen.subject
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: The patient the specimen comes from
    Type: reference
    Path: Specimen.subject
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description: The unique identifier associated with the specimen
    Type: token
    Path: Specimen.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: The unique identifier associated with the specimen
    Type: token
    Path: Specimen.identifier
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter constant for type
    Description: The specimen type
    Type: token
    Path: Specimen.type
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final TokenClientParam TYPE
```
    Fluent Client search parameter constant for type
    Description: The specimen type
    Type: token
    Path: Specimen.type
  - SP_PARENT
```
public static final String SP_PARENT
```
    Search parameter constant for parent
    Description: The parent of the specimen
    Type: reference
    Path: Specimen.parent
    
    See Also:
    
    Constant Field Values
  - PARENT
```
public static final ReferenceClientParam PARENT
```
    Fluent Client search parameter constant for parent
    Description: The parent of the specimen
    Type: reference
    Path: Specimen.parent
  - SP_ACCESSION
```
public static final String SP_ACCESSION
```
    Search parameter constant for accession
    Description: The accession number associated with the specimen
    Type: token
    Path: Specimen.accessionIdentifier
    
    See Also:
    
    Constant Field Values
  - ACCESSION
```
public static final TokenClientParam ACCESSION
```
    Fluent Client search parameter constant for accession
    Description: The accession number associated with the specimen
    Type: token
    Path: Specimen.accessionIdentifier
  - SP_COLLECTED
```
public static final String SP_COLLECTED
```
    Search parameter constant for collected
    Description: The date the specimen was collected
    Type: date
    Path: Specimen.collection.collected[x]
    
    See Also:
    
    Constant Field Values
  - COLLECTED
```
public static final DateClientParam COLLECTED
```
    Fluent Client search parameter constant for collected
    Description: The date the specimen was collected
    Type: date
    Path: Specimen.collection.collected[x]
  - SP_COLLECTOR
```
public static final String SP_COLLECTOR
```
    Search parameter constant for collector
    Description: Who collected the specimen
    Type: reference
    Path: Specimen.collection.collector
    
    See Also:
    
    Constant Field Values
  - COLLECTOR
```
public static final ReferenceClientParam COLLECTOR
```
    Fluent Client search parameter constant for collector
    Description: Who collected the specimen
    Type: reference
    Path: Specimen.collection.collector
  - SP_BODYSITE
```
public static final String SP_BODYSITE
```
    Search parameter constant for 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 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_CONTAINER_ID
```
public static final String SP_CONTAINER_ID
```
    Search parameter constant for 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 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_CONTAINER
```
public static final String SP_CONTAINER
```
    Search parameter constant for container
    Description: The kind of specimen container
    Type: token
    Path: Specimen.container.type
    
    See Also:
    
    Constant Field Values
  - CONTAINER
```
public static final TokenClientParam CONTAINER
```
    Fluent Client search parameter constant for container
    Description: The kind of specimen container
    Type: token
    Path: Specimen.container.type
  - INCLUDE_COLLECTOR
```
public static final Include INCLUDE_COLLECTOR
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:collector".
  - INCLUDE_PARENT
```
public static final Include INCLUDE_PARENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:parent".
  - INCLUDE_PATIENT
```
public static final Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:patient".
  - INCLUDE_SUBJECT
```
public static final Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:subject".
- Constructor Detail
  - Specimen
```
public Specimen()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.
    Definition: Id for specimen
  - setIdentifier
```
public Specimen setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (id)
    Definition: Id for specimen
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier (id)
    Definition: Id for specimen
  - addIdentifier
```
public Specimen addIdentifier(IdentifierDt theValue)
```
    Adds a given new value for identifier (id)
    Definition: Id for specimen
    
    Parameters:
    
    theValue - The identifier to add (must not be null)
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (id), creating it if it does not already exist.
    Definition: Id for specimen
  - getStatusElement
```
public BoundCodeDt<SpecimenStatusEnum> getStatusElement()
```
    Gets the value(s) for status (status). creating it if it does not exist. Will not return null.
    Definition: The availability of the specimen
  - getStatus
```
public String getStatus()
```
    Gets the value(s) for status (status). creating it if it does not exist. Will not return null.
    Definition: The availability of the specimen
  - setStatus
```
public Specimen setStatus(BoundCodeDt<SpecimenStatusEnum> theValue)
```
    Sets the value(s) for status (status)
    Definition: The availability of the specimen
  - setStatus
```
public Specimen setStatus(SpecimenStatusEnum theValue)
```
    Sets the value(s) for status (status)
    Definition: The availability of the specimen
  - getType
```
public CodeableConceptDt getType()
```
    Gets the value(s) for type (class). creating it if it does not exist. Will not return null.
    Definition: The kind of material that forms the specimen
  - setType
```
public Specimen setType(CodeableConceptDt theValue)
```
    Sets the value(s) for type (class)
    Definition: The kind of material that forms the specimen
  - getParent
```
public List<ResourceReferenceDt> getParent()
```
    Gets the value(s) for parent (). creating it if it does not exist. Will not return null.
    Definition: 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<ResourceReferenceDt> theValue)
```
    Sets the value(s) for parent ()
    Definition: Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
  - addParent
```
public ResourceReferenceDt addParent()
```
    Adds and returns a new value for parent ()
    Definition: Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
  - getSubject
```
public ResourceReferenceDt getSubject()
```
    Gets the value(s) for subject (who.focus). creating it if it does not exist. Will not return null.
    Definition:
  - setSubject
```
public Specimen setSubject(ResourceReferenceDt theValue)
```
    Sets the value(s) for subject (who.focus)
    Definition:
  - getAccessionIdentifier
```
public IdentifierDt getAccessionIdentifier()
```
    Gets the value(s) for accessionIdentifier (id). creating it if it does not exist. Will not return null.
    Definition: 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.
  - setAccessionIdentifier
```
public Specimen setAccessionIdentifier(IdentifierDt theValue)
```
    Sets the value(s) for accessionIdentifier (id)
    Definition: 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.
  - getReceivedTimeElement
```
public DateTimeDt getReceivedTimeElement()
```
    Gets the value(s) for receivedTime (when.done). creating it if it does not exist. Will not return null.
    Definition: Time when specimen was received for processing or testing
  - getReceivedTime
```
public Date getReceivedTime()
```
    Gets the value(s) for receivedTime (when.done). creating it if it does not exist. Will not return null.
    Definition: Time when specimen was received for processing or testing
  - setReceivedTime
```
public Specimen setReceivedTime(DateTimeDt theValue)
```
    Sets the value(s) for receivedTime (when.done)
    Definition: Time when specimen was received for processing or testing
  - setReceivedTime
```
public Specimen setReceivedTime(Date theDate,
                                TemporalPrecisionEnum thePrecision)
```
    Sets the value for receivedTime (when.done)
    Definition: Time when specimen was received for processing or testing
  - setReceivedTimeWithSecondsPrecision
```
public Specimen setReceivedTimeWithSecondsPrecision(Date theDate)
```
    Sets the value for receivedTime (when.done)
    Definition: Time when specimen was received for processing or testing
  - getCollection
```
public Specimen.Collection getCollection()
```
    Gets the value(s) for collection (). creating it if it does not exist. Will not return null.
    Definition: Details concerning the specimen collection
  - setCollection
```
public Specimen setCollection(Specimen.Collection theValue)
```
    Sets the value(s) for collection ()
    Definition: Details concerning the specimen collection
  - getTreatment
```
public List<Specimen.Treatment> getTreatment()
```
    Gets the value(s) for treatment (). creating it if it does not exist. Will not return null.
    Definition: Details concerning treatment and processing steps for the specimen
  - setTreatment
```
public Specimen setTreatment(List<Specimen.Treatment> theValue)
```
    Sets the value(s) for treatment ()
    Definition: Details concerning treatment and processing steps for the specimen
  - addTreatment
```
public Specimen.Treatment addTreatment()
```
    Adds and returns a new value for treatment ()
    Definition: Details concerning treatment and processing steps for the specimen
  - addTreatment
```
public Specimen addTreatment(Specimen.Treatment theValue)
```
    Adds a given new value for treatment ()
    Definition: Details concerning treatment and processing steps for the specimen
    
    Parameters:
    
    theValue - The treatment to add (must not be null)
  - getTreatmentFirstRep
```
public Specimen.Treatment getTreatmentFirstRep()
```
    Gets the first repetition for treatment (), creating it if it does not already exist.
    Definition: Details concerning treatment and processing steps for the specimen
  - getContainer
```
public List<Specimen.Container> getContainer()
```
    Gets the value(s) for container (). creating it if it does not exist. Will not return null.
    Definition: 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.Container> theValue)
```
    Sets the value(s) for container ()
    Definition: The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
  - addContainer
```
public Specimen.Container addContainer()
```
    Adds and returns a new value for container ()
    Definition: The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
  - addContainer
```
public Specimen addContainer(Specimen.Container theValue)
```
    Adds a given new value for container ()
    Definition: The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
    
    Parameters:
    
    theValue - The container to add (must not be null)
  - getContainerFirstRep
```
public Specimen.Container getContainerFirstRep()
```
    Gets the first repetition for container (), creating it if it does not already exist.
    Definition: The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class Specimen

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

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

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

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

Field Detail

SP_SUBJECT

SUBJECT

SP_PATIENT

PATIENT

SP_IDENTIFIER

IDENTIFIER

SP_TYPE

TYPE

SP_PARENT

PARENT

SP_ACCESSION

ACCESSION

SP_COLLECTED

COLLECTED

SP_COLLECTOR

COLLECTOR

SP_BODYSITE

BODYSITE

SP_CONTAINER_ID

CONTAINER_ID

SP_CONTAINER

CONTAINER

INCLUDE_COLLECTOR

INCLUDE_PARENT

INCLUDE_PATIENT

INCLUDE_SUBJECT

Constructor Detail

Specimen

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getStatusElement

getStatus

setStatus

setStatus

getType

setType

getParent

setParent

addParent

getSubject

setSubject

getAccessionIdentifier

setAccessionIdentifier

getReceivedTimeElement

getReceivedTime

setReceivedTime

setReceivedTime

setReceivedTimeWithSecondsPrecision

getCollection

setCollection

getTreatment

setTreatment

addTreatment

addTreatment

getTreatmentFirstRep

getContainer

setContainer

addContainer

addContainer

getContainerFirstRep

getResourceName