Package org.hl7.fhir.r4.model

Class SpecimenDefinition

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

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 SpecimenDefinition
extends DomainResource

A kind of specimen with associated set of requirements.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SpecimenDefinition.SpecimenContainedPreference
static class	SpecimenDefinition.SpecimenContainedPreferenceEnumFactory
static class	SpecimenDefinition.SpecimenDefinitionTypeTestedComponent
static class	SpecimenDefinition.SpecimenDefinitionTypeTestedContainerAdditiveComponent
static class	SpecimenDefinition.SpecimenDefinitionTypeTestedContainerComponent
static class	SpecimenDefinition.SpecimenDefinitionTypeTestedHandlingComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected List<CodeableConcept>	collection	The action to be performed for collecting the specimen.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CONTAINER	Fluent Client search parameter constant for container
protected Identifier	identifier	A business identifier associated with the kind of specimen.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
protected List<CodeableConcept>	patientPreparation	Preparation of the patient for specimen collection.
static final String	SP_CONTAINER	Search parameter: container
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_TYPE	Search parameter: type
protected StringType	timeAspect	Time aspect of specimen collection (duration or offset).
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TYPE	Fluent Client search parameter constant for type
protected CodeableConcept	typeCollected	The kind of material to be collected.
protected List<SpecimenDefinition.SpecimenDefinitionTypeTestedComponent>	typeTested	Specimen conditioned in a container as expected by the testing laboratory.

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, 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
SpecimenDefinition()	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CodeableConcept	addCollection()
SpecimenDefinition	addCollection(CodeableConcept t)
CodeableConcept	addPatientPreparation()
SpecimenDefinition	addPatientPreparation(CodeableConcept t)
SpecimenDefinition.SpecimenDefinitionTypeTestedComponent	addTypeTested()
SpecimenDefinition	addTypeTested(SpecimenDefinition.SpecimenDefinitionTypeTestedComponent t)
SpecimenDefinition	copy()
void	copyValues(SpecimenDefinition dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<CodeableConcept>	getCollection()
CodeableConcept	getCollectionFirstRep()
Identifier	getIdentifier()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<CodeableConcept>	getPatientPreparation()
CodeableConcept	getPatientPreparationFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
String	getTimeAspect()
StringType	getTimeAspectElement()
CodeableConcept	getTypeCollected()
String[]	getTypesForProperty(int hash, String name)
List<SpecimenDefinition.SpecimenDefinitionTypeTestedComponent>	getTypeTested()
SpecimenDefinition.SpecimenDefinitionTypeTestedComponent	getTypeTestedFirstRep()
boolean	hasCollection()
boolean	hasIdentifier()
boolean	hasPatientPreparation()
boolean	hasTimeAspect()
boolean	hasTimeAspectElement()
boolean	hasTypeCollected()
boolean	hasTypeTested()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
SpecimenDefinition	setCollection(List<CodeableConcept> theCollection)
SpecimenDefinition	setIdentifier(Identifier value)
SpecimenDefinition	setPatientPreparation(List<CodeableConcept> thePatientPreparation)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
SpecimenDefinition	setTimeAspect(String value)
SpecimenDefinition	setTimeAspectElement(StringType value)
SpecimenDefinition	setTypeCollected(CodeableConcept value)
SpecimenDefinition	setTypeTested(List<SpecimenDefinition.SpecimenDefinitionTypeTestedComponent> theTypeTested)
protected SpecimenDefinition	typedCopy()

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

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, 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, getIdPart, 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, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, 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.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected Identifier identifier

A business identifier associated with the kind of specimen.

typeCollected

protected CodeableConcept typeCollected

The kind of material to be collected.

patientPreparation

protected List<CodeableConcept> patientPreparation

Preparation of the patient for specimen collection.

timeAspect

protected StringType timeAspect

Time aspect of specimen collection (duration or offset).

collection

protected List<CodeableConcept> collection

The action to be performed for collecting the specimen.

typeTested

protected List<SpecimenDefinition.SpecimenDefinitionTypeTestedComponent> typeTested

Specimen conditioned in a container as expected by the testing laboratory.

SP_CONTAINER

public static final String SP_CONTAINER

Search parameter: container

Description: The type of specimen conditioned in container expected by the lab
Type: token
Path: SpecimenDefinition.typeTested.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 type of specimen conditioned in container expected by the lab
Type: token
Path: SpecimenDefinition.typeTested.container.type

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: The unique identifier associated with the specimen
Type: token
Path: SpecimenDefinition.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: SpecimenDefinition.identifier

SP_TYPE

public static final String SP_TYPE

Search parameter: type

Description: The type of collected specimen
Type: token
Path: SpecimenDefinition.typeCollected

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 type of collected specimen
Type: token
Path: SpecimenDefinition.typeCollected

Constructor Details

SpecimenDefinition

public SpecimenDefinition()

Constructor

Method Details

getIdentifier

public Identifier getIdentifier()

Returns:

identifier (A business identifier associated with the kind of specimen.)

hasIdentifier

public boolean hasIdentifier()

setIdentifier

public SpecimenDefinition setIdentifier(Identifier value)

Parameters:

value - identifier (A business identifier associated with the kind of specimen.)

getTypeCollected

public CodeableConcept getTypeCollected()

Returns:

typeCollected (The kind of material to be collected.)

hasTypeCollected

public boolean hasTypeCollected()

setTypeCollected

public SpecimenDefinition setTypeCollected(CodeableConcept value)

Parameters:

value - typeCollected (The kind of material to be collected.)

getPatientPreparation

public List<CodeableConcept> getPatientPreparation()

Returns:

patientPreparation (Preparation of the patient for specimen collection.)

setPatientPreparation

public SpecimenDefinition setPatientPreparation(List<CodeableConcept> thePatientPreparation)

Returns:

Returns a reference to this for easy method chaining

hasPatientPreparation

public boolean hasPatientPreparation()

addPatientPreparation

public CodeableConcept addPatientPreparation()

addPatientPreparation

public SpecimenDefinition addPatientPreparation(CodeableConcept t)

getPatientPreparationFirstRep

public CodeableConcept getPatientPreparationFirstRep()

Returns:

The first repetition of repeating field patientPreparation, creating it if it does not already exist

getTimeAspectElement

public StringType getTimeAspectElement()

Returns:

timeAspect (Time aspect of specimen collection (duration or offset).). This is the underlying object with id, value and extensions. The accessor "getTimeAspect" gives direct access to the value

hasTimeAspectElement

public boolean hasTimeAspectElement()

hasTimeAspect

public boolean hasTimeAspect()

setTimeAspectElement

public SpecimenDefinition setTimeAspectElement(StringType value)

Parameters:

value - timeAspect (Time aspect of specimen collection (duration or offset).). This is the underlying object with id, value and extensions. The accessor "getTimeAspect" gives direct access to the value

getTimeAspect

public String getTimeAspect()

Returns:

Time aspect of specimen collection (duration or offset).

setTimeAspect

public SpecimenDefinition setTimeAspect(String value)

Parameters:

value - Time aspect of specimen collection (duration or offset).

getCollection

public List<CodeableConcept> getCollection()

Returns:

collection (The action to be performed for collecting the specimen.)

setCollection

public SpecimenDefinition setCollection(List<CodeableConcept> theCollection)

Returns:

Returns a reference to this for easy method chaining

hasCollection

public boolean hasCollection()

addCollection

public CodeableConcept addCollection()

addCollection

public SpecimenDefinition addCollection(CodeableConcept t)

getCollectionFirstRep

public CodeableConcept getCollectionFirstRep()

Returns:

The first repetition of repeating field collection, creating it if it does not already exist

getTypeTested

public List<SpecimenDefinition.SpecimenDefinitionTypeTestedComponent> getTypeTested()

Returns:

typeTested (Specimen conditioned in a container as expected by the testing laboratory.)

setTypeTested

public SpecimenDefinition setTypeTested(List<SpecimenDefinition.SpecimenDefinitionTypeTestedComponent> theTypeTested)

Returns:

Returns a reference to this for easy method chaining

hasTypeTested

public boolean hasTypeTested()

addTypeTested

public SpecimenDefinition.SpecimenDefinitionTypeTestedComponent addTypeTested()

addTypeTested

public SpecimenDefinition addTypeTested(SpecimenDefinition.SpecimenDefinitionTypeTestedComponent t)

getTypeTestedFirstRep

public SpecimenDefinition.SpecimenDefinitionTypeTestedComponent getTypeTestedFirstRep()

Returns:

The first repetition of repeating field typeTested, 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

removeChild

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

Overrides:

removeChild 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 SpecimenDefinition copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(SpecimenDefinition dst)

typedCopy

protected SpecimenDefinition 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