
Class Specimen
- All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement
,ca.uhn.fhir.model.api.IElement
,ca.uhn.fhir.model.api.IResource
,ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions
,Serializable
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseResource
public class Specimen extends BaseResource implements ca.uhn.fhir.model.api.IResource
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 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 Description static ca.uhn.fhir.rest.gclient.TokenClientParam
ACCESSION
Fluent Client search parameter constant for accessionstatic ca.uhn.fhir.rest.gclient.TokenClientParam
BODYSITE
Fluent Client search parameter constant for bodysitestatic ca.uhn.fhir.rest.gclient.DateClientParam
COLLECTED
Fluent Client search parameter constant for collectedstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
COLLECTOR
Fluent Client search parameter constant for collectorstatic ca.uhn.fhir.rest.gclient.TokenClientParam
CONTAINER
Fluent Client search parameter constant for containerstatic ca.uhn.fhir.rest.gclient.TokenClientParam
CONTAINER_ID
Fluent Client search parameter constant for container-idstatic ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.Include
INCLUDE_COLLECTOR
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PARENT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
PARENT
Fluent Client search parameter constant for parentstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
PATIENT
Fluent Client search parameter constant for patientstatic String
SP_ACCESSION
Search parameter constant for accessionstatic String
SP_BODYSITE
Search parameter constant for bodysitestatic String
SP_COLLECTED
Search parameter constant for collectedstatic String
SP_COLLECTOR
Search parameter constant for collectorstatic String
SP_CONTAINER
Search parameter constant for containerstatic String
SP_CONTAINER_ID
Search parameter constant for container-idstatic String
SP_IDENTIFIER
Search parameter constant for identifierstatic String
SP_PARENT
Search parameter constant for parentstatic String
SP_PATIENT
Search parameter constant for patientstatic String
SP_SUBJECT
Search parameter constant for subjectstatic String
SP_TYPE
Search parameter constant for typestatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
SUBJECT
Fluent Client search parameter constant for subjectstatic ca.uhn.fhir.rest.gclient.TokenClientParam
TYPE
Fluent Client search parameter constant for typeFields 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 Description Specimen()
-
Method Summary
Modifier and Type Method 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 ca.uhn.fhir.model.api.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).ca.uhn.fhir.model.primitive.DateTimeDt
getReceivedTimeElement()
Gets the value(s) for receivedTime (when.done).String
getResourceName()
String
getStatus()
Gets the value(s) for status (status).ca.uhn.fhir.model.primitive.BoundCodeDt<SpecimenStatusEnum>
getStatusElement()
Gets the value(s) for status (status).ca.uhn.fhir.context.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(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
Sets the value(s) for receivedTime (when.done)Specimen
setReceivedTime(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
Sets the value for receivedTime (when.done)Specimen
setReceivedTimeWithSecondsPrecision(Date theDate)
Sets the value for receivedTime (when.done)Specimen
setStatus(SpecimenStatusEnum theValue)
Sets the value(s) for status (status)Specimen
setStatus(ca.uhn.fhir.model.primitive.BoundCodeDt<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, getMeta, 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, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, setUserData
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId
Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getMeta, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata
-
Field Details
-
SP_SUBJECT
Search parameter constant for subjectDescription: The subject of the specimen
Type: reference
Path: Specimen.subject
- See Also:
- Constant Field Values
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: The subject of the specimen
Type: reference
Path: Specimen.subject
-
SP_PATIENT
Search parameter constant for patientDescription: The patient the specimen comes from
Type: reference
Path: Specimen.subject
- See Also:
- Constant Field Values
-
PATIENT
Fluent Client search parameter constant for patientDescription: The patient the specimen comes from
Type: reference
Path: Specimen.subject
-
SP_IDENTIFIER
Search parameter constant for identifierDescription: The unique identifier associated with the specimen
Type: token
Path: Specimen.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: The unique identifier associated with the specimen
Type: token
Path: Specimen.identifier
-
SP_TYPE
Search parameter constant for typeDescription: The specimen type
Type: token
Path: Specimen.type
- See Also:
- Constant Field Values
-
TYPE
Fluent Client search parameter constant for typeDescription: The specimen type
Type: token
Path: Specimen.type
-
SP_PARENT
Search parameter constant for parentDescription: The parent of the specimen
Type: reference
Path: Specimen.parent
- See Also:
- Constant Field Values
-
PARENT
Fluent Client search parameter constant for parentDescription: The parent of the specimen
Type: reference
Path: Specimen.parent
-
SP_ACCESSION
Search parameter constant for accessionDescription: The accession number associated with the specimen
Type: token
Path: Specimen.accessionIdentifier
- See Also:
- Constant Field Values
-
ACCESSION
Fluent Client search parameter constant for accessionDescription: The accession number associated with the specimen
Type: token
Path: Specimen.accessionIdentifier
-
SP_COLLECTED
Search parameter constant for collectedDescription: The date the specimen was collected
Type: date
Path: Specimen.collection.collected[x]
- See Also:
- Constant Field Values
-
COLLECTED
Fluent Client search parameter constant for collectedDescription: The date the specimen was collected
Type: date
Path: Specimen.collection.collected[x]
-
SP_COLLECTOR
Search parameter constant for collectorDescription: Who collected the specimen
Type: reference
Path: Specimen.collection.collector
- See Also:
- Constant Field Values
-
COLLECTOR
Fluent Client search parameter constant for collectorDescription: Who collected the specimen
Type: reference
Path: Specimen.collection.collector
-
SP_BODYSITE
Search parameter constant for bodysiteDescription: The code for the body site from where the specimen originated
Type: token
Path: Specimen.collection.bodySite
- See Also:
- Constant Field Values
-
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_CONTAINER_ID
Search parameter constant for container-idDescription: The unique identifier associated with the specimen container
Type: token
Path: Specimen.container.identifier
- See Also:
- Constant Field Values
-
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_CONTAINER
Search parameter constant for containerDescription: The kind of specimen container
Type: token
Path: Specimen.container.type
- See Also:
- Constant Field Values
-
CONTAINER
Fluent Client search parameter constant for containerDescription: The kind of specimen container
Type: token
Path: Specimen.container.type
-
INCLUDE_COLLECTOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:collector". -
INCLUDE_PARENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:parent". -
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:patient". -
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:subject".
-
-
Constructor Details
-
Specimen
public Specimen()
-
-
Method Details
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
-
getAllPopulatedChildElementsOfType
public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)- Specified by:
getAllPopulatedChildElementsOfType
in interfaceca.uhn.fhir.model.api.ICompositeElement
-
getIdentifier
Gets the value(s) for identifier (id). creating it if it does not exist. Will not returnnull
.Definition: Id for specimen
-
setIdentifier
Sets the value(s) for identifier (id)Definition: Id for specimen
-
addIdentifier
Adds and returns a new value for identifier (id)Definition: Id for specimen
-
addIdentifier
Adds a given new value for identifier (id)Definition: Id for specimen
- Parameters:
theValue
- The identifier to add (must not benull
)
-
getIdentifierFirstRep
Gets the first repetition for identifier (id), creating it if it does not already exist.Definition: Id for specimen
-
getStatusElement
Gets the value(s) for status (status). creating it if it does not exist. Will not returnnull
.Definition: The availability of the specimen
-
getStatus
Gets the value(s) for status (status). creating it if it does not exist. This method may returnnull
.Definition: The availability of the specimen
-
setStatus
Sets the value(s) for status (status)Definition: The availability of the specimen
-
setStatus
Sets the value(s) for status (status)Definition: The availability of the specimen
-
getType
Gets the value(s) for type (class). creating it if it does not exist. Will not returnnull
.Definition: The kind of material that forms the specimen
-
setType
Sets the value(s) for type (class)Definition: The kind of material that forms the specimen
-
getParent
Gets the value(s) for parent (). creating it if it does not exist. Will not returnnull
.Definition: Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
-
setParent
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
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
Gets the value(s) for subject (who.focus). creating it if it does not exist. Will not returnnull
.Definition:
-
setSubject
Sets the value(s) for subject (who.focus)Definition:
-
getAccessionIdentifier
Gets the value(s) for accessionIdentifier (id). creating it if it does not exist. Will not returnnull
.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
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
Gets the value(s) for receivedTime (when.done). creating it if it does not exist. Will not returnnull
.Definition: Time when specimen was received for processing or testing
-
getReceivedTime
Gets the value(s) for receivedTime (when.done). creating it if it does not exist. This method may returnnull
.Definition: Time when specimen was received for processing or testing
-
setReceivedTime
Sets the value(s) for receivedTime (when.done)Definition: Time when specimen was received for processing or testing
-
setReceivedTime
public Specimen setReceivedTime(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)Sets the value for receivedTime (when.done)Definition: Time when specimen was received for processing or testing
-
setReceivedTimeWithSecondsPrecision
Sets the value for receivedTime (when.done)Definition: Time when specimen was received for processing or testing
-
getCollection
Gets the value(s) for collection (). creating it if it does not exist. Will not returnnull
.Definition: Details concerning the specimen collection
-
setCollection
Sets the value(s) for collection ()Definition: Details concerning the specimen collection
-
getTreatment
Gets the value(s) for treatment (). creating it if it does not exist. Will not returnnull
.Definition: Details concerning treatment and processing steps for the specimen
-
setTreatment
Sets the value(s) for treatment ()Definition: Details concerning treatment and processing steps for the specimen
-
addTreatment
Adds and returns a new value for treatment ()Definition: Details concerning treatment and processing steps for the specimen
-
addTreatment
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 benull
)
-
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
Gets the value(s) for container (). creating it if it does not exist. Will not returnnull
.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
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
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
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 benull
)
-
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
- Specified by:
getResourceName
in interfaceca.uhn.fhir.model.api.IResource
-
getStructureFhirVersionEnum
- Specified by:
getStructureFhirVersionEnum
in interfaceorg.hl7.fhir.instance.model.api.IBaseResource
- Specified by:
getStructureFhirVersionEnum
in interfaceca.uhn.fhir.model.api.IResource
-