Skip to main content

HS.FHIRModel.R4.Specimen

class HS.FHIRModel.R4.Specimen extends HS.FHIRModel.FHIRClassSuper

*****************************************
** Specimen generated class schema
*****************************************
A sample to be used for analysis.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_SPECIMEN;
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 _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _receivedTime as HS.FHIRModel.R4.Element;
Extensions for receivedTime
Property methods: _receivedTimeGet(), _receivedTimeGetSwizzled(), _receivedTimeIsValid(), _receivedTimeNewObject(), _receivedTimeSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property accessionIdentifier as HS.FHIRModel.R4.Identifier;
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.FHIRModel.R4.SpecimenX.Collection;
Details concerning the specimen collection.
Property methods: collectionGet(), collectionGetSwizzled(), collectionIsValid(), collectionNewObject(), collectionSet()
property condition as HS.FHIRModel.R4.SeqOfCodeableConcept;
A mode or state of being that describes the nature of the specimen.
Property methods: conditionGet(), conditionGetSwizzled(), conditionIsValid(), conditionNewObject(), conditionSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
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: containerGet(), containerGetSwizzled(), containerIsValid(), containerNewObject(), containerSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Id for specimen.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property parent as HS.FHIRModel.R4.SeqOfReference;
Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
Property methods: parentGet(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentSet()
Details concerning processing and processing steps for the specimen.
Property methods: processingGet(), processingGetSwizzled(), processingIsValid(), processingNewObject(), processingSet()
property receivedTime as %String;
Time when specimen was received for processing or testing.
Property methods: receivedTimeDisplayToLogical(), receivedTimeGet(), receivedTimeIsValid(), receivedTimeLogicalToDisplay(), receivedTimeLogicalToOdbc(), receivedTimeNormalize(), receivedTimeSet()
property request as HS.FHIRModel.R4.SeqOfReference;
Details concerning a service request that required a specimen to be collected.
Property methods: requestGet(), requestGetSwizzled(), requestIsValid(), requestNewObject(), requestSet()
property resourceType as %String [ InitialExpression = "Specimen" , Required ];
This is a Specimen resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property status as %String (VALUELIST = ",available,unavailable,unsatisfactory,entered-in-error");
The availability of the specimen.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIRModel.R4.Reference;
Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
The kind of material that forms the specimen.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Methods

method IncludeAccessionIdentifier()
method IncludeCollection()
method IncludeCondition()
method IncludeContained()
method IncludeContainer()
method IncludeExtension()
method IncludeIdentifier()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludeParent()
method IncludeProcessing()
method IncludeRequest()
method IncludeSubject()
method IncludeText()
method IncludeType()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab