Skip to main content

HS.FHIR.vSTU3.Model.Resource.Substance

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A homogeneous material with a definite composition.
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 = Substance;
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 category as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
A code that classifies the general type of substance. This is used for searching, sorting and display purposes.
Property methods: categoryBuildValueArray(), categoryCollectionToDisplay(), categoryCollectionToOdbc(), categoryDisplayToCollection(), categoryGet(), categoryGetObject(), categoryGetObjectId(), categoryGetSwizzled(), categoryIsValid(), categoryOdbcToCollection(), categorySet(), categorySetObject(), categorySetObjectId()
property code as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT") [ Required ];
A code (or set of codes) that identify this substance.
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property description as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "description", XMLPROJECTION = "ELEMENT");
A description of the substance - its appearance, handling requirements, and other usage notes.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Unique identifier for the substance.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property ingredient as list of HS.FHIR.vSTU3.Model.Resource.Substance.Ingredient (XMLNAME = "ingredient", XMLPROJECTION = "ELEMENT");
A substance can be composed of other substances.
Property methods: ingredientBuildValueArray(), ingredientCollectionToDisplay(), ingredientCollectionToOdbc(), ingredientDisplayToCollection(), ingredientGet(), ingredientGetObject(), ingredientGetObjectId(), ingredientGetSwizzled(), ingredientIsValid(), ingredientOdbcToCollection(), ingredientSet(), ingredientSetObject(), ingredientSetObjectId()
property instance as list of HS.FHIR.vSTU3.Model.Resource.Substance.Instance (XMLNAME = "instance", XMLPROJECTION = "ELEMENT");
Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.
Property methods: instanceBuildValueArray(), instanceCollectionToDisplay(), instanceCollectionToOdbc(), instanceDisplayToCollection(), instanceGet(), instanceGetObject(), instanceGetObjectId(), instanceGetSwizzled(), instanceIsValid(), instanceOdbcToCollection(), instanceSet(), instanceSetObject(), instanceSetObjectId()
property status as HS.FHIR.vSTU3.Model.Base.FHIRSubstanceStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT");
A code to indicate if the substance is actively used.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()

Methods

deprecated method SetCategory(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.
Insert method for the "category" property.
deprecated method SetCode(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 "code" property.
deprecated method SetDescription(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 "description" 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 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.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab