Data Model Libraries
    Preparing search index...

    Class SubstanceSpecificationRelationshipComponent

    SubstanceSpecificationRelationshipComponent Class

    FHIR Specification

    • Short: A link between this substance and another, with details of the relationship
    • Definition: A link between this substance and another, with details of the relationship.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    substance?: IDataType

    SubstanceSpecification.relationship.substance[x] Element

    @ChoiceDataTypesMeta('SubstanceSpecification.relationship.substance[x]', ['Reference','CodeableConcept',]

    FHIR Specification

    • Short: A pointer to another substance, as a resource or just a representational code
    • Definition: A pointer to another substance, as a resource or just a representational code.
    • FHIR Types: 'Reference', 'CodeableConcept',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    relationship?: CodeableConcept

    SubstanceSpecification.relationship.relationship Element

    FHIR Specification

    • Short: For example "salt to parent", "active moiety", "starting material"
    • Definition: For example "salt to parent", "active moiety", "starting material".
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    isDefining?: BooleanType

    SubstanceSpecification.relationship.isDefining Element

    FHIR Specification

    • Short: 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
    • Definition: 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.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    amount?: IDataType

    SubstanceSpecification.relationship.amount[x] Element

    @ChoiceDataTypesMeta('SubstanceSpecification.relationship.amount[x]', ['Quantity','Range','Ratio','string',]

    FHIR Specification

    • Short: 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
    • Definition: 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.
    • FHIR Types: 'Quantity', 'Range', 'Ratio', 'string',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    amountRatioLowLimit?: Ratio

    SubstanceSpecification.relationship.amountRatioLowLimit Element

    FHIR Specification

    • Short: For use when the numeric
    • Definition: For use when the numeric.
    • FHIR Type: Ratio
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    amountType?: CodeableConcept

    SubstanceSpecification.relationship.amountType Element

    FHIR Specification

    • Short: An operator for the amount, for example "average", "approximately", "less than"
    • Definition: An operator for the amount, for example "average", "approximately", "less than".
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    source?: Reference[]

    SubstanceSpecification.relationship.source Element

    FHIR Specification

    Methods

    • Parse the provided SubstanceSpecificationRelationshipComponent JSON to instantiate the SubstanceSpecificationRelationshipComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubstanceSpecificationRelationshipComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to SubstanceSpecificationRelationshipComponent

      Returns undefined | SubstanceSpecificationRelationshipComponent

      SubstanceSpecificationRelationshipComponent data model or undefined for SubstanceSpecificationRelationshipComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise