Package org.hl7.fhir.dstu2.model

Class Specimen

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.BaseResource

org.hl7.fhir.dstu2.model.Resource

org.hl7.fhir.dstu2.model.DomainResource

org.hl7.fhir.dstu2.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	Description
static class	Specimen.SpecimenCollectionComponent
static class	Specimen.SpecimenContainerComponent
static enum	Specimen.SpecimenStatus
static class	Specimen.SpecimenStatusEnumFactory
static class	Specimen.SpecimenTreatmentComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected Identifier	accessionIdentifier	The identifier assigned by the lab when accessioning specimen(s).
protected Specimen.SpecimenCollectionComponent	collection	Details concerning the specimen collection.
protected List<Specimen.SpecimenContainerComponent>	container	The container holding the specimen.
protected List<Identifier>	identifier	Id for specimen.
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.
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.)
protected DateTimeType	receivedTime	Time when specimen was received for processing or testing.
static final String	SP_ACCESSION
static final String	SP_BODYSITE
static final String	SP_COLLECTED
static final String	SP_COLLECTOR
static final String	SP_CONTAINER
static final String	SP_CONTAINERID
static final String	SP_IDENTIFIER
static final String	SP_PARENT
static final String	SP_PATIENT
static final String	SP_SUBJECT
static final String	SP_TYPE
protected Enumeration<Specimen.SpecimenStatus>	status	The availability of the specimen.
protected Reference	subject	Where the specimen came from.
protected Resource	subjectTarget	The actual object that is the target of the reference (Where the specimen came from.
protected List<Specimen.SpecimenTreatmentComponent>	treatment	Details concerning treatment and processing steps for the specimen.
protected CodeableConcept	type	The kind of material that forms the specimen.

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Specimen()
Specimen(Reference subject)

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Specimen.SpecimenContainerComponent	addContainer()
Specimen	addContainer(Specimen.SpecimenContainerComponent t)
Identifier	addIdentifier()
Specimen	addIdentifier(Identifier t)
Reference	addParent()
Specimen	addParent(Reference t)
Specimen	addParentTarget()
Specimen.SpecimenTreatmentComponent	addTreatment()
Specimen	addTreatment(Specimen.SpecimenTreatmentComponent t)
Specimen	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
Identifier	getAccessionIdentifier()
Specimen.SpecimenCollectionComponent	getCollection()
List<Specimen.SpecimenContainerComponent>	getContainer()
List<Identifier>	getIdentifier()
List<Reference>	getParent()
List<Specimen>	getParentTarget()
Date	getReceivedTime()
DateTimeType	getReceivedTimeElement()
ResourceType	getResourceType()
Specimen.SpecimenStatus	getStatus()
Enumeration<Specimen.SpecimenStatus>	getStatusElement()
Reference	getSubject()
Resource	getSubjectTarget()
List<Specimen.SpecimenTreatmentComponent>	getTreatment()
CodeableConcept	getType()
boolean	hasAccessionIdentifier()
boolean	hasCollection()
boolean	hasContainer()
boolean	hasIdentifier()
boolean	hasParent()
boolean	hasReceivedTime()
boolean	hasReceivedTimeElement()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	hasTreatment()
boolean	hasType()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Specimen	setAccessionIdentifier(Identifier value)
Specimen	setCollection(Specimen.SpecimenCollectionComponent value)
void	setProperty(String name, Base value)
Specimen	setReceivedTime(Date value)
Specimen	setReceivedTimeElement(DateTimeType value)
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.dstu2.model.DomainResource

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setText

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

copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

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

getStructureFhirVersionEnum, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

Id for specimen.

status

protected Enumeration<Specimen.SpecimenStatus> status

The availability of the specimen.

type

protected CodeableConcept type

The kind of material that forms the specimen.

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

subject

protected Reference subject

Where the specimen came from. This may be from the patient(s) or from the environment 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 the patient(s) or from the environment or a device.)

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.

receivedTime

protected DateTimeType receivedTime

Time when specimen was received for processing or testing.

collection

protected Specimen.SpecimenCollectionComponent collection

Details concerning the specimen collection.

treatment

protected List<Specimen.SpecimenTreatmentComponent> treatment

Details concerning treatment 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.

SP_CONTAINER

public static final String SP_CONTAINER

See Also:

• Constant Field Values

SP_IDENTIFIER

public static final String SP_IDENTIFIER

See Also:

• Constant Field Values

SP_PARENT

public static final String SP_PARENT

See Also:

• Constant Field Values

SP_CONTAINERID

public static final String SP_CONTAINERID

See Also:

• Constant Field Values

SP_BODYSITE

public static final String SP_BODYSITE

See Also:

• Constant Field Values

SP_SUBJECT

public static final String SP_SUBJECT

See Also:

• Constant Field Values

SP_PATIENT

public static final String SP_PATIENT

See Also:

• Constant Field Values

SP_COLLECTED

public static final String SP_COLLECTED

See Also:

• Constant Field Values

SP_ACCESSION

public static final String SP_ACCESSION

See Also:

• Constant Field Values

SP_TYPE

public static final String SP_TYPE

See Also:

• Constant Field Values

SP_COLLECTOR

public static final String SP_COLLECTOR

See Also:

• Constant Field Values

Constructor Details

Specimen

public Specimen()

Specimen

public Specimen(Reference subject)

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Id for specimen.)

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

Returns:

identifier (Id for specimen.)

addIdentifier

public Specimen addIdentifier(Identifier t)

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

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

hasParent

public boolean hasParent()

addParent

public Reference addParent()

Returns:

parent (Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.)

addParent

public Specimen addParent(Reference t)

getParentTarget

public List<Specimen> getParentTarget()

Returns:

parent (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.)

addParentTarget

public Specimen addParentTarget()

Returns:

parent (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.)

getSubject

public Reference getSubject()

Returns:

subject (Where the specimen came from. This may be from the patient(s) or from the environment 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 the patient(s) or from the environment 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 the patient(s) or from the environment 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 the patient(s) or from the environment or a device.)

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

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.

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

getTreatment

public List<Specimen.SpecimenTreatmentComponent> getTreatment()

Returns:

treatment (Details concerning treatment and processing steps for the specimen.)

hasTreatment

public boolean hasTreatment()

addTreatment

public Specimen.SpecimenTreatmentComponent addTreatment()

Returns:

treatment (Details concerning treatment and processing steps for the specimen.)

addTreatment

public Specimen addTreatment(Specimen.SpecimenTreatmentComponent t)

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

hasContainer

public boolean hasContainer()

addContainer

public Specimen.SpecimenContainerComponent addContainer()

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

addContainer

public Specimen addContainer(Specimen.SpecimenContainerComponent t)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

setProperty

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

Overrides:

setProperty 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

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