Skip to main content

HS.FHIR.vDSTU2.Model.Resource.Specimen.Collection

deprecated class HS.FHIR.vDSTU2.Model.Resource.Specimen.Collection extends HS.FHIR.vDSTU2.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.

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 JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = Specimen.Collection;
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 = 0;
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.
parameter XMLTYPE = Specimen.Collection;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property bodySite as HS.FHIR.vDSTU2.Model.Base.CodeableConcept (XMLNAME = "bodySite");
Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.
Property methods: bodySiteGet(), bodySiteGetSwizzled(), bodySiteIsValid(), bodySiteNewObject(), bodySiteSet()
property collectedDateTime as HS.FHIR.vDSTU2.Model.Datatype.DateTime (XMLNAME = "collectedDateTime");
Property methods: collectedDateTimeGet(), collectedDateTimeGetSwizzled(), collectedDateTimeIsValid(), collectedDateTimeNewObject(), collectedDateTimeSet()
property collectedPeriod as HS.FHIR.vDSTU2.Model.Base.Period (XMLNAME = "collectedPeriod");
Property methods: collectedPeriodGet(), collectedPeriodGetSwizzled(), collectedPeriodIsValid(), collectedPeriodNewObject(), collectedPeriodSet()
property collector as HS.FHIR.vDSTU2.Model.Base.Reference (XMLNAME = "collector");
Person who collected the specimen.
Property methods: collectorGet(), collectorGetSwizzled(), collectorIsValid(), collectorNewObject(), collectorSet()
property comment as list of HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "comment", XMLPROJECTION = "ELEMENT");
To communicate any details or issues encountered during the specimen collection procedure.
Property methods: commentBuildValueArray(), commentCollectionToDisplay(), commentCollectionToOdbc(), commentDisplayToCollection(), commentGet(), commentGetObject(), commentGetObjectId(), commentGetSwizzled(), commentIsValid(), commentOdbcToCollection(), commentSet(), commentSetObject(), commentSetObjectId()
property method as HS.FHIR.vDSTU2.Model.Base.CodeableConcept (XMLNAME = "method");
A coded value specifying the technique that is used to perform the procedure.
Property methods: methodGet(), methodGetSwizzled(), methodIsValid(), methodNewObject(), methodSet()
property quantity as HS.FHIR.vDSTU2.Model.Base.SimpleQuantity (XMLNAME = "quantity");
The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.
Property methods: quantityGet(), quantityGetSwizzled(), quantityIsValid(), quantityNewObject(), quantitySet()

Methods

deprecated method SetBodySite(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 "bodySite" property.
deprecated method SetCollectedDateTime(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 "collectedDateTime" property.
deprecated method SetCollectedPeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "collectedPeriod" property.
deprecated method SetCollector(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 "collector" property.
deprecated method SetComment(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "comment" property.
deprecated method SetMethod(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 "method" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab