Class Specimen
- java.lang.Object
-
- org.hl7.fhir.dstu2016may.model.Base
-
- org.hl7.fhir.dstu2016may.model.BaseResource
-
- org.hl7.fhir.dstu2016may.model.Resource
-
- org.hl7.fhir.dstu2016may.model.DomainResource
-
- org.hl7.fhir.dstu2016may.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 classSpecimen.SpecimenCollectionComponentstatic classSpecimen.SpecimenContainerComponentstatic classSpecimen.SpecimenStatusstatic classSpecimen.SpecimenStatusEnumFactorystatic classSpecimen.SpecimenTreatmentComponent
-
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.TokenClientParamACCESSIONFluent Client search parameter constant for accessionprotected IdentifieraccessionIdentifierThe identifier assigned by the lab when accessioning specimen(s).static ca.uhn.fhir.rest.gclient.TokenClientParamBODYSITEFluent Client search parameter constant for bodysitestatic ca.uhn.fhir.rest.gclient.DateClientParamCOLLECTEDFluent Client search parameter constant for collectedprotected Specimen.SpecimenCollectionComponentcollectionDetails concerning the specimen collection.static ca.uhn.fhir.rest.gclient.ReferenceClientParamCOLLECTORFluent Client search parameter constant for collectorprotected List<Specimen.SpecimenContainerComponent>containerThe container holding the specimen.static ca.uhn.fhir.rest.gclient.TokenClientParamCONTAINERFluent Client search parameter constant for containerstatic ca.uhn.fhir.rest.gclient.TokenClientParamCONTAINER_IDFluent Client search parameter constant for container-idprotected List<Identifier>identifierId for specimen.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_COLLECTORConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PARENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBJECTConstant for fluent queries to be used to add include statements.protected List<Reference>parentReference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPARENTFluent Client search parameter constant for parentprotected List<Specimen>parentTargetThe 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 ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientprotected DateTimeTypereceivedTimeTime when specimen was received for processing or testing.static StringSP_ACCESSIONSearch parameter: accessionstatic StringSP_BODYSITESearch parameter: bodysitestatic StringSP_COLLECTEDSearch parameter: collectedstatic StringSP_COLLECTORSearch parameter: collectorstatic StringSP_CONTAINERSearch parameter: containerstatic StringSP_CONTAINER_IDSearch parameter: container-idstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_PARENTSearch parameter: parentstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_SUBJECTSearch parameter: subjectstatic StringSP_TYPESearch parameter: typeprotected Enumeration<Specimen.SpecimenStatus>statusThe availability of the specimen.protected ReferencesubjectWhere the specimen came from.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectprotected ResourcesubjectTargetThe actual object that is the target of the reference (Where the specimen came from.protected List<Specimen.SpecimenTreatmentComponent>treatmentDetails concerning treatment and processing steps for the specimen.protected CodeableConcepttypeThe kind of material that forms the specimen.static ca.uhn.fhir.rest.gclient.TokenClientParamTYPEFluent Client search parameter constant for type-
Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource
id, implicitRules, language, meta
-
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText
-
Methods inherited from class org.hl7.fhir.dstu2016may.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.dstu2016may.model.BaseResource
getStructureFhirVersionEnum, setId
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, 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
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Id for specimen.
-
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.
-
status
protected Enumeration<Specimen.SpecimenStatus> status
The availability of the specimen.
-
type
protected CodeableConcept type
The kind of material that forms the 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.)
-
receivedTime
protected DateTimeType receivedTime
Time when specimen was received for processing or testing.
-
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.)
-
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_COLLECTOR
public static final String SP_COLLECTOR
Search parameter: collectorDescription: Who collected the specimen
Type: reference
Path: Specimen.collection.collector
- See Also:
- Constant Field Values
-
COLLECTOR
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam COLLECTOR
Fluent Client search parameter constant for collectorDescription: Who collected the specimen
Type: reference
Path: Specimen.collection.collector
-
INCLUDE_COLLECTOR
public static final ca.uhn.fhir.model.api.Include INCLUDE_COLLECTOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:collector".
-
SP_CONTAINER_ID
public static final String SP_CONTAINER_ID
Search parameter: container-idDescription: The unique identifier associated with the specimen container
Type: token
Path: Specimen.container.identifier
- See Also:
- Constant Field Values
-
CONTAINER_ID
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: The patient the specimen comes from
Type: reference
Path: Specimen.subject
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: The patient the specimen comes from
Type: reference
Path: Specimen.subject
-
INCLUDE_PATIENT
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:patient".
-
SP_BODYSITE
public static final String SP_BODYSITE
Search parameter: bodysiteDescription: The code for the body site from where the specimen originated
Type: token
Path: Specimen.collection.bodySite
- See Also:
- Constant Field Values
-
BODYSITE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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
public static final String SP_CONTAINER
Search parameter: containerDescription: The kind of specimen container
Type: token
Path: Specimen.container.type
- See Also:
- Constant Field Values
-
CONTAINER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTAINER
Fluent Client search parameter constant for containerDescription: The kind of specimen container
Type: token
Path: Specimen.container.type
-
SP_COLLECTED
public static final String SP_COLLECTED
Search parameter: collectedDescription: The date the specimen was collected
Type: date
Path: Specimen.collection.collected[x]
- See Also:
- Constant Field Values
-
COLLECTED
public static final ca.uhn.fhir.rest.gclient.DateClientParam COLLECTED
Fluent Client search parameter constant for collectedDescription: The date the specimen was collected
Type: date
Path: Specimen.collection.collected[x]
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: The subject of the specimen
Type: reference
Path: Specimen.subject
- See Also:
- Constant Field Values
-
SUBJECT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
Fluent Client search parameter constant for subjectDescription: The subject of the specimen
Type: reference
Path: Specimen.subject
-
INCLUDE_SUBJECT
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:subject".
-
SP_ACCESSION
public static final String SP_ACCESSION
Search parameter: accessionDescription: The accession number associated with the specimen
Type: token
Path: Specimen.accessionIdentifier
- See Also:
- Constant Field Values
-
ACCESSION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACCESSION
Fluent Client search parameter constant for accessionDescription: The accession number associated with the specimen
Type: token
Path: Specimen.accessionIdentifier
-
SP_PARENT
public static final String SP_PARENT
Search parameter: parentDescription: The parent of the specimen
Type: reference
Path: Specimen.parent
- See Also:
- Constant Field Values
-
PARENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARENT
Fluent Client search parameter constant for parentDescription: The parent of the specimen
Type: reference
Path: Specimen.parent
-
INCLUDE_PARENT
public static final ca.uhn.fhir.model.api.Include INCLUDE_PARENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:parent".
-
SP_TYPE
public static final String SP_TYPE
Search parameter: typeDescription: The specimen type
Type: token
Path: Specimen.type
- See Also:
- Constant Field Values
-
TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
Fluent Client search parameter constant for typeDescription: The specimen type
Type: token
Path: Specimen.type
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: The unique identifier associated with the specimen
Type: token
Path: Specimen.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: The unique identifier associated with the specimen
Type: token
Path: Specimen.identifier
-
-
Method Detail
-
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)
-
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.)
-
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.)
-
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:
subjectThe 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-subjectThe 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.)
-
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.
-
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.)
-
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.)
-
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:
listChildrenin classDomainResource
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
Description copied from class:Basemake an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property- Overrides:
makePropertyin classDomainResource- Returns:
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public Specimen copy()
- Specified by:
copyin classDomainResource
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-