Skip to main content


class HS.FHIR.DTL.vR4.Model.Resource.SubstanceSpecification extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

The detailed description of a substance, typically at a level beyond what is used for prescribing.

Property Inventory


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 = SubstanceSpecification;
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.
parameter XMLTYPE = SubstanceSpecification;
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.


property code as list of HS.FHIR.DTL.vR4.Model.Element.SubstanceSpecification.code (XMLNAME = "code", XMLPROJECTION = "ELEMENT");

Codes associated with the substance.

Property methods: codeBuildValueArray(), codeCollectionToDisplay(), codeCollectionToOdbc(), codeDisplayToCollection(), codeGet(), codeGetObject(), codeGetObjectId(), codeGetSwizzled(), codeIsValid(), codeOdbcToCollection(), codeSet(), codeSetObject(), codeSetObjectId()
property comment as %String (MAXLEN = 1000000, XMLNAME = "comment", XMLPROJECTION = "ATTRIBUTE");

Textual comment about this record of a substance.

Property methods: commentDisplayToLogical(), commentGet(), commentIsValid(), commentLogicalToDisplay(), commentLogicalToOdbc(), commentNormalize(), commentSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");

Textual description of the substance.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property domain as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "domain", XMLPROJECTION = "ELEMENT");

If the substance applies to only human or veterinary use.

any FHIR4 code from any ValueSet may be used.

Property methods: domainGet(), domainGetSwizzled(), domainIsValid(), domainNewObject(), domainSet()
property identifier as HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Identifier by which this substance is known.

Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property moiety as list of HS.FHIR.DTL.vR4.Model.Element.SubstanceSpecification.moiety (XMLNAME = "moiety", XMLPROJECTION = "ELEMENT");

Moiety, for structural modifications.

Property methods: moietyBuildValueArray(), moietyCollectionToDisplay(), moietyCollectionToOdbc(), moietyDisplayToCollection(), moietyGet(), moietyGetObject(), moietyGetObjectId(), moietyGetSwizzled(), moietyIsValid(), moietyOdbcToCollection(), moietySet(), moietySetObject(), moietySetObjectId()
property molecularWeight as list of HS.FHIR.DTL.vR4.Model.Element.SubstanceSpecification.structure.isotope.molecularWeight (XMLNAME = "molecularWeight", XMLPROJECTION = "ELEMENT");

The molecular weight or weight range (for proteins, polymers or nucleic acids)

Property methods: molecularWeightBuildValueArray(), molecularWeightCollectionToDisplay(), molecularWeightCollectionToOdbc(), molecularWeightDisplayToCollection(), molecularWeightGet(), molecularWeightGetObject(), molecularWeightGetObjectId(), molecularWeightGetSwizzled(), molecularWeightIsValid(), molecularWeightOdbcToCollection(), molecularWeightSet(), molecularWeightSetObject(), molecularWeightSetObjectId()
property name as list of (XMLNAME = "name", XMLPROJECTION = "ELEMENT");

Names applicable to this substance.

Property methods: nameBuildValueArray(), nameCollectionToDisplay(), nameCollectionToOdbc(), nameDisplayToCollection(), nameGet(), nameGetObject(), nameGetObjectId(), nameGetSwizzled(), nameIsValid(), nameOdbcToCollection(), nameSet(), nameSetObject(), nameSetObjectId()
property nucleicAcid as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "nucleicAcid", XMLPROJECTION = "ELEMENT");

Data items specific to nucleic acids.


Property methods: nucleicAcidGet(), nucleicAcidGetSwizzled(), nucleicAcidIsValid(), nucleicAcidNewObject(), nucleicAcidSet()
property polymer as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "polymer", XMLPROJECTION = "ELEMENT");

Data items specific to polymers.


Property methods: polymerGet(), polymerGetSwizzled(), polymerIsValid(), polymerNewObject(), polymerSet()
property property as list of (XMLNAME = "property", XMLPROJECTION = "ELEMENT");

General specifications for this substance, including how it is related to other substances.

Property methods: propertyBuildValueArray(), propertyCollectionToDisplay(), propertyCollectionToOdbc(), propertyDisplayToCollection(), propertyGet(), propertyGetObject(), propertyGetObjectId(), propertyGetSwizzled(), propertyIsValid(), propertyOdbcToCollection(), propertySet(), propertySetObject(), propertySetObjectId()
property protein as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "protein", XMLPROJECTION = "ELEMENT");

Data items specific to proteins.


Property methods: proteinGet(), proteinGetSwizzled(), proteinIsValid(), proteinNewObject(), proteinSet()
property referenceInformation as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "referenceInformation", XMLPROJECTION = "ELEMENT");

General information detailing this substance.


Property methods: referenceInformationGet(), referenceInformationGetSwizzled(), referenceInformationIsValid(), referenceInformationNewObject(), referenceInformationSet()
property relationship as list of HS.FHIR.DTL.vR4.Model.Element.SubstanceSpecification.relationship (XMLNAME = "relationship", XMLPROJECTION = "ELEMENT");

A link between this substance and another, with details of the relationship.

Property methods: relationshipBuildValueArray(), relationshipCollectionToDisplay(), relationshipCollectionToOdbc(), relationshipDisplayToCollection(), relationshipGet(), relationshipGetObject(), relationshipGetObjectId(), relationshipGetSwizzled(), relationshipIsValid(), relationshipOdbcToCollection(), relationshipSet(), relationshipSetObject(), relationshipSetObjectId()
property source as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "source", XMLPROJECTION = "ELEMENT");

Supporting literature.


Property methods: sourceBuildValueArray(), sourceCollectionToDisplay(), sourceCollectionToOdbc(), sourceDisplayToCollection(), sourceGet(), sourceGetObject(), sourceGetObjectId(), sourceGetSwizzled(), sourceIsValid(), sourceOdbcToCollection(), sourceSet(), sourceSetObject(), sourceSetObjectId()
property sourceMaterial as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "sourceMaterial", XMLPROJECTION = "ELEMENT");

Material or taxonomic/anatomical source for the substance.


Property methods: sourceMaterialGet(), sourceMaterialGetSwizzled(), sourceMaterialIsValid(), sourceMaterialNewObject(), sourceMaterialSet()
property status as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "status", XMLPROJECTION = "ELEMENT");

Status of substance within the catalogue e.g. approved.

any FHIR4 code from any ValueSet may be used.

Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property structure as HS.FHIR.DTL.vR4.Model.Element.SubstanceSpecification.structure (XMLNAME = "structure", XMLPROJECTION = "ELEMENT");

Structural information.

Property methods: structureGet(), structureGetSwizzled(), structureIsValid(), structureNewObject(), structureSet()
property type as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");

High level categorization, e.g. polymer or nucleic acid.

any FHIR4 code from any ValueSet may be used.

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab