Class 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
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for accessionprotected Identifier
The identifier assigned by the lab when accessioning specimen(s).static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for bodysitestatic final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for collectedprotected Specimen.SpecimenCollectionComponent
Details concerning the specimen collection.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for collectorprotected List
<CodeableConcept> A mode or state of being that describes the nature of the specimen.protected List
<Specimen.SpecimenContainerComponent> The container holding the specimen.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for containerstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for container-idprotected List
<Identifier> Id for specimen.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected List
<Annotation> To communicate any details or issues about the specimen or during the specimen collection.Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for parentThe 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 final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientprotected List
<Specimen.SpecimenProcessingComponent> Details concerning processing and processing steps for the specimen.protected DateTimeType
Time when specimen was received for processing or testing.Details concerning a service request that required a specimen to be collected.protected List
<ServiceRequest> The actual objects that are the target of the reference (Details concerning a service request that required a specimen to be collected.)static final String
Search parameter: accessionstatic final String
Search parameter: bodysitestatic final String
Search parameter: collectedstatic final String
Search parameter: collectorstatic final String
Search parameter: containerstatic final String
Search parameter: container-idstatic final String
Search parameter: identifierstatic final String
Search parameter: parentstatic final String
Search parameter: patientstatic final String
Search parameter: statusstatic final String
Search parameter: subjectstatic final String
Search parameter: typeprotected Enumeration
<Specimen.SpecimenStatus> The availability of the specimen.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected Reference
Where the specimen came from.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectprotected Resource
The actual object that is the target of the reference (Where the specimen came from.protected CodeableConcept
The kind of material that forms the specimen.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for typeFields 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
-
Method Summary
Modifier and TypeMethodDescriptionaddNote()
Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadcopy()
void
copyValues
(Specimen dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getNamedProperty
(int _hash, String _name, boolean _checkValid) getNote()
Deprecated.Use Reference#setResource(IBaseResource) insteadBase[]
getProperty
(int hash, String name, boolean checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadgetType()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasType()
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAccessionIdentifier
(Identifier value) setCondition
(List<CodeableConcept> theCondition) setContainer
(List<Specimen.SpecimenContainerComponent> theContainer) setIdentifier
(List<Identifier> theIdentifier) setNote
(List<Annotation> theNote) setProcessing
(List<Specimen.SpecimenProcessingComponent> theProcessing) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setReceivedTime
(Date value) setRequest
(List<Reference> theRequest) setStatus
(Specimen.SpecimenStatus value) setSubject
(Reference value) setSubjectTarget
(Resource value) setType
(CodeableConcept value) protected Specimen
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
Id for specimen. -
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
The availability of the specimen. -
type
The kind of material that forms the specimen. -
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
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
Time when specimen was received for processing or testing. -
parent
Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another 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
Details concerning a service request that required a specimen to be collected. -
requestTarget
The actual objects that are the target of the reference (Details concerning a service request that required a specimen to be collected.) -
collection
Details concerning the specimen collection. -
processing
Details concerning processing and processing steps for the specimen. -
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
A mode or state of being that describes the nature of the specimen. -
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
Search parameter: containerDescription: The kind of specimen container
Type: token
Path: Specimen.container.type
- See Also:
-
CONTAINER
Fluent Client search parameter constant for containerDescription: The kind of specimen container
Type: token
Path: Specimen.container.type
-
SP_IDENTIFIER
Search parameter: identifierDescription: The unique identifier associated with the specimen
Type: token
Path: Specimen.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: The unique identifier associated with the specimen
Type: token
Path: Specimen.identifier
-
SP_PARENT
Search parameter: parentDescription: The parent of the specimen
Type: reference
Path: Specimen.parent
- See Also:
-
PARENT
Fluent Client search parameter constant for parentDescription: The parent of the specimen
Type: reference
Path: Specimen.parent
-
INCLUDE_PARENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:parent". -
SP_CONTAINER_ID
Search parameter: container-idDescription: The unique identifier associated with the specimen container
Type: token
Path: Specimen.container.identifier
- See Also:
-
CONTAINER_ID
Fluent Client search parameter constant for container-idDescription: The unique identifier associated with the specimen container
Type: token
Path: Specimen.container.identifier
-
SP_BODYSITE
Search parameter: bodysiteDescription: The code for the body site from where the specimen originated
Type: token
Path: Specimen.collection.bodySite
- See Also:
-
BODYSITE
Fluent Client search parameter constant for bodysiteDescription: The code for the body site from where the specimen originated
Type: token
Path: Specimen.collection.bodySite
-
SP_SUBJECT
Search parameter: subjectDescription: The subject of the specimen
Type: reference
Path: Specimen.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: The subject of the specimen
Type: reference
Path: Specimen.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:subject". -
SP_PATIENT
Search parameter: patientDescription: The patient the specimen comes from
Type: reference
Path: Specimen.subject
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: The patient the specimen comes from
Type: reference
Path: Specimen.subject
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:patient". -
SP_COLLECTED
Search parameter: collectedDescription: The date the specimen was collected
Type: date
Path: Specimen.collection.collected[x]
- See Also:
-
COLLECTED
Fluent Client search parameter constant for collectedDescription: The date the specimen was collected
Type: date
Path: Specimen.collection.collected[x]
-
SP_ACCESSION
Search parameter: accessionDescription: The accession number associated with the specimen
Type: token
Path: Specimen.accessionIdentifier
- See Also:
-
ACCESSION
Fluent Client search parameter constant for accessionDescription: The accession number associated with the specimen
Type: token
Path: Specimen.accessionIdentifier
-
SP_TYPE
Search parameter: typeDescription: The specimen type
Type: token
Path: Specimen.type
- See Also:
-
TYPE
Fluent Client search parameter constant for typeDescription: The specimen type
Type: token
Path: Specimen.type
-
SP_COLLECTOR
Search parameter: collectorDescription: Who collected the specimen
Type: reference
Path: Specimen.collection.collector
- See Also:
-
COLLECTOR
Fluent Client search parameter constant for collectorDescription: Who collected the specimen
Type: reference
Path: Specimen.collection.collector
-
INCLUDE_COLLECTOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:collector". -
SP_STATUS
Search parameter: statusDescription: available | unavailable | unsatisfactory | entered-in-error
Type: token
Path: Specimen.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: available | unavailable | unsatisfactory | entered-in-error
Type: token
Path: Specimen.status
-
-
Constructor Details
-
Specimen
public Specimen()Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Id for specimen.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
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
-
setAccessionIdentifier
- 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
- 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
-
hasStatus
-
setStatusElement
- 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
- Returns:
- The availability of the specimen.
-
setStatus
- Parameters:
value
- The availability of the specimen.
-
getType
- Returns:
type
(The kind of material that forms the specimen.)
-
hasType
-
setType
- Parameters:
value
-type
(The kind of material that forms the specimen.)
-
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
-
setSubject
- 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
- 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
- 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
- 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
-
hasReceivedTime
-
setReceivedTimeElement
- 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
- Returns:
- Time when specimen was received for processing or testing.
-
setReceivedTime
- Parameters:
value
- Time when specimen was received for processing or testing.
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasParent
-
addParent
-
addParent
-
getParentFirstRep
- Returns:
- The first repetition of repeating field
parent
, creating it if it does not already exist
-
getParentTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addParentTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getRequest
- Returns:
request
(Details concerning a service request that required a specimen to be collected.)
-
setRequest
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRequest
-
addRequest
-
addRequest
-
getRequestFirstRep
- Returns:
- The first repetition of repeating field
request
, creating it if it does not already exist
-
getRequestTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addRequestTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getCollection
- Returns:
collection
(Details concerning the specimen collection.)
-
hasCollection
-
setCollection
- Parameters:
value
-collection
(Details concerning the specimen collection.)
-
getProcessing
- Returns:
processing
(Details concerning processing and processing steps for the specimen.)
-
setProcessing
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasProcessing
-
addProcessing
-
addProcessing
-
getProcessingFirstRep
- Returns:
- The first repetition of repeating field
processing
, creating it if it does not already exist
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContainer
-
addContainer
-
addContainer
-
getContainerFirstRep
- Returns:
- The first repetition of repeating field
container
, creating it if it does not already exist
-
getCondition
- Returns:
condition
(A mode or state of being that describes the nature of the specimen.)
-
setCondition
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCondition
-
addCondition
-
addCondition
-
getConditionFirstRep
- Returns:
- The first repetition of repeating field
condition
, creating it if it does not already exist
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasNote
-
addNote
-
addNote
-
getNoteFirstRep
- Returns:
- The first repetition of repeating field
note
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-