Skip to main content

HS.FHIRModel.R4.SubstanceSpecification

class HS.FHIRModel.R4.SubstanceSpecification extends HS.FHIRModel.FHIRClassSuper

*****************************************
** SubstanceSpecification generated class schema
*****************************************
The detailed description of a substance, typically at a level beyond what is used for prescribing.

Property Inventory

Method Inventory

Parameters

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

Properties

property _comment as HS.FHIRModel.R4.Element;
Extensions for comment
Property methods: _commentGet(), _commentGetSwizzled(), _commentIsValid(), _commentNewObject(), _commentSet()
property _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
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()
Codes associated with the substance.
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property comment as %String;
Textual comment about this record of a substance.
Property methods: commentDisplayToLogical(), commentGet(), commentIsValid(), commentLogicalToDisplay(), commentLogicalToOdbc(), commentNormalize(), commentSet()
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()
property description as %String;
Textual description of the substance.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property domain as HS.FHIRModel.R4.CodeableConcept;
If the substance applies to only human or veterinary use.
Property methods: domainGet(), domainGetSwizzled(), domainIsValid(), domainNewObject(), domainSet()
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.Identifier;
Identifier by which this substance is known.
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()
Moiety, for structural modifications.
Property methods: moietyGet(), moietyGetSwizzled(), moietyIsValid(), moietyNewObject(), moietySet()
The molecular weight or weight range (for proteins, polymers or nucleic acids).
Property methods: molecularWeightGet(), molecularWeightGetSwizzled(), molecularWeightIsValid(), molecularWeightNewObject(), molecularWeightSet()
Names applicable to this substance.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property nucleicAcid as HS.FHIRModel.R4.Reference;
Data items specific to nucleic acids.
Property methods: nucleicAcidGet(), nucleicAcidGetSwizzled(), nucleicAcidIsValid(), nucleicAcidNewObject(), nucleicAcidSet()
property polymer as HS.FHIRModel.R4.Reference;
Data items specific to polymers.
Property methods: polymerGet(), polymerGetSwizzled(), polymerIsValid(), polymerNewObject(), polymerSet()
General specifications for this substance, including how it is related to other substances.
Property methods: propertyGet(), propertyGetSwizzled(), propertyIsValid(), propertyNewObject(), propertySet()
property protein as HS.FHIRModel.R4.Reference;
Data items specific to proteins.
Property methods: proteinGet(), proteinGetSwizzled(), proteinIsValid(), proteinNewObject(), proteinSet()
property referenceInformation as HS.FHIRModel.R4.Reference;
General information detailing this substance.
Property methods: referenceInformationGet(), referenceInformationGetSwizzled(), referenceInformationIsValid(), referenceInformationNewObject(), referenceInformationSet()
A link between this substance and another, with details of the relationship.
Property methods: relationshipGet(), relationshipGetSwizzled(), relationshipIsValid(), relationshipNewObject(), relationshipSet()
property resourceType as %String [ InitialExpression = "SubstanceSpecification" , Required ];
This is a SubstanceSpecification resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property source as HS.FHIRModel.R4.SeqOfReference;
Supporting literature.
Property methods: sourceGet(), sourceGetSwizzled(), sourceIsValid(), sourceNewObject(), sourceSet()
property sourceMaterial as HS.FHIRModel.R4.Reference;
Material or taxonomic/anatomical source for the substance.
Property methods: sourceMaterialGet(), sourceMaterialGetSwizzled(), sourceMaterialIsValid(), sourceMaterialNewObject(), sourceMaterialSet()
property status as HS.FHIRModel.R4.CodeableConcept;
Status of substance within the catalogue e.g. approved.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
Structural information.
Property methods: structureGet(), structureGetSwizzled(), structureIsValid(), structureNewObject(), structureSet()
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()
High level categorization, e.g. polymer or nucleic acid.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Methods

method IncludeCode()
method IncludeContained()
method IncludeDomain()
method IncludeExtension()
method IncludeIdentifier()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeMoiety()
method IncludeMolecularWeight()
method IncludeName()
method IncludeNucleicAcid()
method IncludePolymer()
method IncludeProperty()
method IncludeProtein()
method IncludeReferenceInformation()
method IncludeRelationship()
method IncludeSource()
method IncludeSourceMaterial()
method IncludeStatus()
method IncludeStructure()
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