Skip to main content

HS.FHIR.DTL.vR4.Model.Element.Specimen.collection

class HS.FHIR.DTL.vR4.Model.Element.Specimen.collection extends HS.FHIR.DTL.vR4.Model.Base.BackboneElement

Collection details.

Property 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.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 XMLPROJECTION = ELEMENT;
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.
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.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "bodySite", XMLPROJECTION = "ELEMENT");
CodeableConcept

Anatomical collection site.

any FHIR4 code may be used; body-site shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: bodySiteGet(), bodySiteGetSwizzled(), bodySiteIsValid(), bodySiteNewObject(), bodySiteSet()
property collectedDateTime as %String (MAXLEN = 1000000, XMLNAME = "collectedDateTime", XMLPROJECTION = "ATTRIBUTE");
dateTime

Collection time.

Property methods: collectedDateTimeDisplayToLogical(), collectedDateTimeGet(), collectedDateTimeIsValid(), collectedDateTimeLogicalToDisplay(), collectedDateTimeLogicalToOdbc(), collectedDateTimeNormalize(), collectedDateTimeSet()
property collectedPeriod as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "collectedPeriod", XMLPROJECTION = "ELEMENT");
Period

Collection time.

Property methods: collectedPeriodGet(), collectedPeriodGetSwizzled(), collectedPeriodIsValid(), collectedPeriodNewObject(), collectedPeriodSet()
property collector as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "collector", XMLPROJECTION = "ELEMENT");
Reference

Who collected the specimen.

Practitioner | PractitionerRole

Property methods: collectorGet(), collectorGetSwizzled(), collectorIsValid(), collectorNewObject(), collectorSet()
property duration as HS.FHIR.DTL.vR4.Model.Datatype.Duration (XMLNAME = "duration", XMLPROJECTION = "ELEMENT");
Duration

How long it took to collect specimen.

Property methods: durationGet(), durationGetSwizzled(), durationIsValid(), durationNewObject(), durationSet()
property fastingStatusCodeableConcept as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "fastingStatusCodeableConcept", XMLPROJECTION = "ELEMENT");
CodeableConcept

Whether or how long patient abstained from food and/or drink.

v2-0916 is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in v2-0916, you may formally EXTEND v2-0916 to add codes to it.

Property methods: fastingStatusCodeableConceptGet(), fastingStatusCodeableConceptGetSwizzled(), fastingStatusCodeableConceptIsValid(), fastingStatusCodeableConceptNewObject(), fastingStatusCodeableConceptSet()
property fastingStatusDuration as HS.FHIR.DTL.vR4.Model.Datatype.Duration (XMLNAME = "fastingStatusDuration", XMLPROJECTION = "ELEMENT");
Duration

Whether or how long patient abstained from food and/or drink.

Property methods: fastingStatusDurationGet(), fastingStatusDurationGetSwizzled(), fastingStatusDurationIsValid(), fastingStatusDurationNewObject(), fastingStatusDurationSet()
property method as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "method", XMLPROJECTION = "ELEMENT");
CodeableConcept

Technique used to perform collection.

any FHIR4 code may be used; specimen-collection-method shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: methodGet(), methodGetSwizzled(), methodIsValid(), methodNewObject(), methodSet()
property quantity as HS.FHIR.DTL.vR4.Model.Datatype.Quantity (XMLNAME = "quantity", XMLPROJECTION = "ELEMENT");
Quantity

The quantity of specimen collected.

Property methods: quantityGet(), quantityGetSwizzled(), quantityIsValid(), quantityNewObject(), quantitySet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab