Skip to main content

HS.FHIR.DTL.vR4.Model.Element.SubstanceSpecification.relationship

class HS.FHIR.DTL.vR4.Model.Element.SubstanceSpecification.relationship extends HS.FHIR.DTL.vR4.Model.Base.BackboneElement

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

Property 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 = SubstanceSpecification.relationship;
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 XMLPROJECTION = ELEMENT;
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.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 amountQuantity as HS.FHIR.DTL.vR4.Model.Datatype.Quantity (XMLNAME = "amountQuantity", XMLPROJECTION = "ELEMENT");
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.FHIR.DTL.vR4.Model.Datatype.Range (XMLNAME = "amountRange", XMLPROJECTION = "ELEMENT");
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.FHIR.DTL.vR4.Model.Datatype.Ratio (XMLNAME = "amountRatio", XMLPROJECTION = "ELEMENT");
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(), amountRatioLowLimitGet(), amountRatioLowLimitGetSwizzled(), amountRatioLowLimitIsValid(), amountRatioLowLimitNewObject(), amountRatioLowLimitSet(), amountRatioNewObject(), amountRatioSet()
property amountRatioLowLimit as HS.FHIR.DTL.vR4.Model.Datatype.Ratio (XMLNAME = "amountRatioLowLimit", XMLPROJECTION = "ELEMENT");
Ratio

For use when the numeric.

Property methods: amountRatioLowLimitGet(), amountRatioLowLimitGetSwizzled(), amountRatioLowLimitIsValid(), amountRatioLowLimitNewObject(), amountRatioLowLimitSet()
property amountString as %String (MAXLEN = 1000000, XMLNAME = "amountString", XMLPROJECTION = "ATTRIBUTE");
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.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "amountType", XMLPROJECTION = "ELEMENT");
CodeableConcept

An operator for the amount, for example \"average\", \"approximately\", \"less than\"

any FHIR4 code from any ValueSet may be used.

Property methods: amountTypeGet(), amountTypeGetSwizzled(), amountTypeIsValid(), amountTypeNewObject(), amountTypeSet()
property isDefining as %Boolean (XMLNAME = "isDefining", XMLPROJECTION = "ATTRIBUTE");
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 relationship as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "relationship", XMLPROJECTION = "ELEMENT");
CodeableConcept

For example \"salt to parent\", \"active moiety\", \"starting material\"

any FHIR4 code from any ValueSet may be used.

Property methods: relationshipGet(), relationshipGetSwizzled(), relationshipIsValid(), relationshipNewObject(), relationshipSet()
property source as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "source", XMLPROJECTION = "ELEMENT");
Reference

Supporting literature.

DocumentReference

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

A pointer to another substance, as a resource or just a representational code.

any FHIR4 code from any ValueSet may be used.

Property methods: substanceCodeableConceptGet(), substanceCodeableConceptGetSwizzled(), substanceCodeableConceptIsValid(), substanceCodeableConceptNewObject(), substanceCodeableConceptSet()
property substanceReference as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "substanceReference", XMLPROJECTION = "ELEMENT");
Reference

A pointer to another substance, as a resource or just a representational code.

SubstanceSpecification.

Property methods: substanceReferenceGet(), substanceReferenceGetSwizzled(), substanceReferenceIsValid(), substanceReferenceNewObject(), substanceReferenceSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab