ca.uhn.fhir.model.dstu.resource

Class Specimen

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseResource

ca.uhn.fhir.model.dstu.resource.Specimen

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions

public class Specimen
extends BaseResource
implements IResource

HAPI/FHIR Specimen Resource (Sample for analysis)

Definition: Sample for analysis

Requirements:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Specimen.Collection Block class for child element: Specimen.collection (Collection details)
static class	Specimen.Container Block class for child element: Specimen.container (Direct container of specimen (tube/slide, etc))
static class	Specimen.Source Block class for child element: Specimen.source (Parent of specimen)
static class	Specimen.Treatment Block class for child element: Specimen.treatment (Treatment and processing step details)

Field Summary

Fields

Modifier and Type	Field and Description
static Include	INCLUDE_SUBJECT Constant for fluent queries to be used to add include statements.
static String	SP_SUBJECT Search parameter constant for subject
static ReferenceClientParam	SUBJECT Fluent Client search parameter constant for subject

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors

Constructor and Description
Specimen()

Method Summary

Methods

Modifier and Type	Method and Description
Specimen.Container	addContainer() Adds and returns a new value for container (Direct container of specimen (tube/slide, etc))
IdentifierDt	addIdentifier() Adds and returns a new value for identifier (External Identifier)
Specimen	addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel) Adds a new value for identifier (External Identifier)
Specimen	addIdentifier(String theSystem, String theValue) Adds a new value for identifier (External Identifier)
Specimen.Source	addSource() Adds and returns a new value for source (Parent of specimen)
Specimen.Treatment	addTreatment() Adds and returns a new value for treatment (Treatment and processing step details)
IdentifierDt	getAccessionIdentifier() Gets the value(s) for accessionIdentifier (Identifier assigned by the lab).
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
Specimen.Collection	getCollection() Gets the value(s) for collection (Collection details).
List<Specimen.Container>	getContainer() Gets the value(s) for container (Direct container of specimen (tube/slide, etc)).
Specimen.Container	getContainerFirstRep() Gets the first repetition for container (Direct container of specimen (tube/slide, etc)), creating it if it does not already exist.
List<IdentifierDt>	getIdentifier() Gets the value(s) for identifier (External Identifier).
IdentifierDt	getIdentifierFirstRep() Gets the first repetition for identifier (External Identifier), creating it if it does not already exist.
DateTimeDt	getReceivedTime() Gets the value(s) for receivedTime (The time when specimen was received for processing).
List<Specimen.Source>	getSource() Gets the value(s) for source (Parent of specimen).
Specimen.Source	getSourceFirstRep() Gets the first repetition for source (Parent of specimen), creating it if it does not already exist.
ResourceReferenceDt	getSubject() Gets the value(s) for subject (Where the specimen came from.
List<Specimen.Treatment>	getTreatment() Gets the value(s) for treatment (Treatment and processing step details).
Specimen.Treatment	getTreatmentFirstRep() Gets the first repetition for treatment (Treatment and processing step details), creating it if it does not already exist.
CodeableConceptDt	getType() Gets the value(s) for type (Kind of material that forms the specimen).
boolean	isEmpty()
Specimen	setAccessionIdentifier(IdentifierDt theValue) Sets the value(s) for accessionIdentifier (Identifier assigned by the lab)
Specimen	setAccessionIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel) Sets the value for accessionIdentifier (Identifier assigned by the lab)
Specimen	setAccessionIdentifier(String theSystem, String theValue) Sets the value for accessionIdentifier (Identifier assigned by the lab)
Specimen	setCollection(Specimen.Collection theValue) Sets the value(s) for collection (Collection details)
Specimen	setContainer(List<Specimen.Container> theValue) Sets the value(s) for container (Direct container of specimen (tube/slide, etc))
Specimen	setIdentifier(List<IdentifierDt> theValue) Sets the value(s) for identifier (External Identifier)
Specimen	setReceivedTime(Date theDate, TemporalPrecisionEnum thePrecision) Sets the value for receivedTime (The time when specimen was received for processing)
Specimen	setReceivedTime(DateTimeDt theValue) Sets the value(s) for receivedTime (The time when specimen was received for processing)
Specimen	setReceivedTimeWithSecondsPrecision(Date theDate) Sets the value for receivedTime (The time when specimen was received for processing)
Specimen	setSource(List<Specimen.Source> theValue) Sets the value(s) for source (Parent of specimen)
Specimen	setSubject(ResourceReferenceDt theValue) Sets the value(s) for subject (Where the specimen came from.
Specimen	setTreatment(List<Specimen.Treatment> theValue) Sets the value(s) for treatment (Treatment and processing step details)
Specimen	setType(CodeableConceptDt theValue) Sets the value(s) for type (Kind of material that forms the specimen)

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

getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, 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

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

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 IElement

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getIdentifier

public List<IdentifierDt> getIdentifier()

Gets the value(s) for identifier (External Identifier). 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 (External Identifier)

Definition: Id for specimen

addIdentifier

public IdentifierDt addIdentifier()

Adds and returns a new value for identifier (External Identifier)

Definition: Id for specimen

getIdentifierFirstRep

public IdentifierDt getIdentifierFirstRep()

Gets the first repetition for identifier (External Identifier), creating it if it does not already exist.

Definition: Id for specimen

addIdentifier

public Specimen addIdentifier(IdentifierUseEnum theUse,
                     String theSystem,
                     String theValue,
                     String theLabel)

Adds a new value for identifier (External Identifier)

Definition: Id for specimen

Returns:

Returns a reference to this object, to allow for simple chaining.

addIdentifier

public Specimen addIdentifier(String theSystem,
                     String theValue)

Adds a new value for identifier (External Identifier)

Definition: Id for specimen

Returns:

Returns a reference to this object, to allow for simple chaining.

getType

public CodeableConceptDt getType()

Gets the value(s) for type (Kind of material that forms the specimen). creating it if it does not exist. Will not return null.

Definition: Kind of material that forms the specimen

setType

public Specimen setType(CodeableConceptDt theValue)

Sets the value(s) for type (Kind of material that forms the specimen)

Definition: Kind of material that forms the specimen

getSource

public List<Specimen.Source> getSource()

Gets the value(s) for source (Parent of specimen). creating it if it does not exist. Will not return null.

Definition: Parent specimen from which the focal specimen was a component

setSource

public Specimen setSource(List<Specimen.Source> theValue)

Sets the value(s) for source (Parent of specimen)

Definition: Parent specimen from which the focal specimen was a component

addSource

public Specimen.Source addSource()

Adds and returns a new value for source (Parent of specimen)

Definition: Parent specimen from which the focal specimen was a component

getSourceFirstRep

public Specimen.Source getSourceFirstRep()

Gets the first repetition for source (Parent of specimen), creating it if it does not already exist.

Definition: Parent specimen from which the focal specimen was a component

getSubject

public ResourceReferenceDt getSubject()

Gets the value(s) for subject (Where the specimen came from. This may be the patient(s) or from the environment or a device). creating it if it does not exist. Will not return null.

Definition:

setSubject

public Specimen setSubject(ResourceReferenceDt theValue)

Sets the value(s) for subject (Where the specimen came from. This may be the patient(s) or from the environment or a device)

Definition:

getAccessionIdentifier

public IdentifierDt getAccessionIdentifier()

Gets the value(s) for accessionIdentifier (Identifier assigned by the lab). 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 (Identifier assigned by the lab)

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(IdentifierUseEnum theUse,
                              String theSystem,
                              String theValue,
                              String theLabel)

Sets the value for accessionIdentifier (Identifier assigned by the lab)

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(String theSystem,
                              String theValue)

Sets the value for accessionIdentifier (Identifier assigned by the lab)

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.

getReceivedTime

public DateTimeDt getReceivedTime()

Gets the value(s) for receivedTime (The time when specimen was received for processing). 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 (The time when specimen was received for processing)

Definition: Time when specimen was received for processing or testing

setReceivedTimeWithSecondsPrecision

public Specimen setReceivedTimeWithSecondsPrecision(Date theDate)

Sets the value for receivedTime (The time when specimen was received for processing)

Definition: Time when specimen was received for processing or testing

setReceivedTime

public Specimen setReceivedTime(Date theDate,
                       TemporalPrecisionEnum thePrecision)

Sets the value for receivedTime (The time when specimen was received for processing)

Definition: Time when specimen was received for processing or testing

getCollection

public Specimen.Collection getCollection()

Gets the value(s) for collection (Collection details). 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 (Collection details)

Definition: Details concerning the specimen collection

getTreatment

public List<Specimen.Treatment> getTreatment()

Gets the value(s) for treatment (Treatment and processing step details). 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 (Treatment and processing step details)

Definition: Details concerning treatment and processing steps for the specimen

addTreatment

public Specimen.Treatment addTreatment()

Adds and returns a new value for treatment (Treatment and processing step details)

Definition: Details concerning treatment and processing steps for the specimen

getTreatmentFirstRep

public Specimen.Treatment getTreatmentFirstRep()

Gets the first repetition for treatment (Treatment and processing step details), 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 (Direct container of specimen (tube/slide, etc)). 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 (Direct container of specimen (tube/slide, etc))

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 (Direct container of specimen (tube/slide, etc))

Definition: The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.

getContainerFirstRep

public Specimen.Container getContainerFirstRep()

Gets the first repetition for container (Direct container of specimen (tube/slide, etc)), 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.