Skip to main content

HS.FHIR.vSTU3.Model.Resource.Specimen

deprecated class HS.FHIR.vSTU3.Model.Resource.Specimen extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A sample to be used for analysis.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = Specimen;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.

Properties

property accessionIdentifier as HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "accessionIdentifier", XMLPROJECTION = "ELEMENT");
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.
Property methods: accessionIdentifierGet(), accessionIdentifierGetSwizzled(), accessionIdentifierIsValid(), accessionIdentifierNewObject(), accessionIdentifierSet()
property collection as HS.FHIR.vSTU3.Model.Resource.Specimen.Collection (XMLNAME = "collection", XMLPROJECTION = "ELEMENT");
Details concerning the specimen collection.
Property methods: collectionGet(), collectionGetSwizzled(), collectionIsValid(), collectionNewObject(), collectionSet()
property container as list of HS.FHIR.vSTU3.Model.Resource.Specimen.Container (XMLNAME = "container", XMLPROJECTION = "ELEMENT");
The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
Property methods: containerBuildValueArray(), containerCollectionToDisplay(), containerCollectionToOdbc(), containerDisplayToCollection(), containerGet(), containerGetObject(), containerGetObjectId(), containerGetSwizzled(), containerIsValid(), containerOdbcToCollection(), containerSet(), containerSetObject(), containerSetObjectId()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Id for specimen.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property note as list of HS.FHIR.vSTU3.Model.Base.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).
Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property parent as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "parent", XMLPROJECTION = "ELEMENT");
Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
Property methods: parentBuildValueArray(), parentCollectionToDisplay(), parentCollectionToOdbc(), parentDisplayToCollection(), parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentOdbcToCollection(), parentSet(), parentSetObject(), parentSetObjectId()
property processing as list of HS.FHIR.vSTU3.Model.Resource.Specimen.Processing (XMLNAME = "processing", XMLPROJECTION = "ELEMENT");
Details concerning processing and processing steps for the specimen.
Property methods: processingBuildValueArray(), processingCollectionToDisplay(), processingCollectionToOdbc(), processingDisplayToCollection(), processingGet(), processingGetObject(), processingGetObjectId(), processingGetSwizzled(), processingIsValid(), processingOdbcToCollection(), processingSet(), processingSetObject(), processingSetObjectId()
property receivedTime as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "receivedTime", XMLPROJECTION = "ELEMENT");
Time when specimen was received for processing or testing.
Property methods: receivedTimeGet(), receivedTimeGetSwizzled(), receivedTimeIsValid(), receivedTimeNewObject(), receivedTimeSet()
property request as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "request", XMLPROJECTION = "ELEMENT");
Details concerning a test or procedure request that required a specimen to be collected.
Property methods: requestBuildValueArray(), requestCollectionToDisplay(), requestCollectionToOdbc(), requestDisplayToCollection(), requestGet(), requestGetObject(), requestGetObjectId(), requestGetSwizzled(), requestIsValid(), requestOdbcToCollection(), requestSet(), requestSetObject(), requestSetObjectId()
property status as HS.FHIR.vSTU3.Model.Base.SpecimenStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT");
The availability of the specimen.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property subject as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT") [ Required ];
Where the specimen came from. This may be from the patient(s) or from the environment or a device.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property type as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
The kind of material that forms the specimen.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Methods

deprecated method SetAccessionIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "accessionIdentifier" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetParent(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "parent" property.
deprecated method SetReceivedTime(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "receivedTime" property.
deprecated method SetRequest(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "request" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
deprecated method SetSubject(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "subject" property.
deprecated method SetType(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "type" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab