Skip to main content

HS.FHIRModel.R4.SubstanceSpecificationX.Relationship

class HS.FHIRModel.R4.SubstanceSpecificationX.Relationship extends HS.FHIRModel.FHIRClassSuper

*****************************************
** SubstanceSpecificationX.Relationship 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_SUBSTANCESPECIFICATIONX_RELATIONSHIP;
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 _amountString as HS.FHIRModel.R4.Element;
Extensions for amountString
Property methods: _amountStringGet(), _amountStringGetSwizzled(), _amountStringIsValid(), _amountStringNewObject(), _amountStringSet()
property _isDefining as HS.FHIRModel.R4.Element;
Extensions for isDefining
Property methods: _isDefiningGet(), _isDefiningGetSwizzled(), _isDefiningIsValid(), _isDefiningNewObject(), _isDefiningSet()
property amountQuantity as HS.FHIRModel.R4.Quantity;
A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.
Property methods: amountQuantityGet(), amountQuantityGetSwizzled(), amountQuantityIsValid(), amountQuantityNewObject(), amountQuantitySet()
property amountRange as HS.FHIRModel.R4.Range;
A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.
Property methods: amountRangeGet(), amountRangeGetSwizzled(), amountRangeIsValid(), amountRangeNewObject(), amountRangeSet()
property amountRatio as HS.FHIRModel.R4.Ratio;
A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.
Property methods: amountRatioGet(), amountRatioGetSwizzled(), amountRatioIsValid(), amountRatioNewObject(), amountRatioSet()
property amountRatioLowLimit as HS.FHIRModel.R4.Ratio;
For use when the numeric.
Property methods: amountRatioLowLimitGet(), amountRatioLowLimitGetSwizzled(), amountRatioLowLimitIsValid(), amountRatioLowLimitNewObject(), amountRatioLowLimitSet()
property amountString as %String;
A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.
Property methods: amountStringDisplayToLogical(), amountStringGet(), amountStringIsValid(), amountStringLogicalToDisplay(), amountStringLogicalToOdbc(), amountStringNormalize(), amountStringSet()
property amountType as HS.FHIRModel.R4.CodeableConcept;
An operator for the amount, for example "average", "approximately", "less than".
Property methods: amountTypeGet(), amountTypeGetSwizzled(), amountTypeIsValid(), amountTypeNewObject(), amountTypeSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element. 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;
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property isDefining as %Boolean;
For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.
Property methods: isDefiningDisplayToLogical(), isDefiningGet(), isDefiningIsValid(), isDefiningLogicalToDisplay(), isDefiningLogicalToXSD(), isDefiningNormalize(), isDefiningSet(), isDefiningXSDToLogical()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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()
property relationship as HS.FHIRModel.R4.CodeableConcept;
For example "salt to parent", "active moiety", "starting material".
Property methods: relationshipGet(), relationshipGetSwizzled(), relationshipIsValid(), relationshipNewObject(), relationshipSet()
property source as HS.FHIRModel.R4.SeqOfReference;
Supporting literature.
Property methods: sourceGet(), sourceGetSwizzled(), sourceIsValid(), sourceNewObject(), sourceSet()
property substanceCodeableConcept as HS.FHIRModel.R4.CodeableConcept;
A pointer to another substance, as a resource or just a representational code.
Property methods: substanceCodeableConceptGet(), substanceCodeableConceptGetSwizzled(), substanceCodeableConceptIsValid(), substanceCodeableConceptNewObject(), substanceCodeableConceptSet()
property substanceReference as HS.FHIRModel.R4.Reference;
A pointer to another substance, as a resource or just a representational code.
Property methods: substanceReferenceGet(), substanceReferenceGetSwizzled(), substanceReferenceIsValid(), substanceReferenceNewObject(), substanceReferenceSet()

Methods

method IncludeAmountQuantity()
method IncludeAmountRange()
method IncludeAmountRatio()
method IncludeAmountRatioLowLimit()
method IncludeAmountType()
method IncludeExtension()
method IncludeModifierExtension()
method IncludeRelationship()
method IncludeSource()
method IncludeSubstanceCodeableConcept()
method IncludeSubstanceReference()
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