Data Model Libraries
    Preparing search index...

    Class SubstanceDefinitionMoietyComponent

    SubstanceDefinitionMoietyComponent Class

    FHIR Specification

    • Short: Moiety, for structural modifications
    • Definition: Moiety, for structural modifications.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    SubstanceDefinition.moiety.role Element

    FHIR Specification

    • Short: Role that the moiety is playing
    • Definition: Role that the moiety is playing.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    identifier?: Identifier

    SubstanceDefinition.moiety.identifier Element

    FHIR Specification

    • Short: Identifier by which this moiety substance is known
    • Definition: Identifier by which this moiety substance is known.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name?: StringType

    FHIR Specification

    • Short: Textual name for this moiety substance
    • Definition: Textual name for this moiety substance.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    stereochemistry?: CodeableConcept

    SubstanceDefinition.moiety.stereochemistry Element

    FHIR Specification

    • Short: Stereochemistry type
    • Definition: Stereochemistry type.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    opticalActivity?: CodeableConcept

    SubstanceDefinition.moiety.opticalActivity Element

    FHIR Specification

    • Short: Optical activity type
    • Definition: Optical activity type.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    molecularFormula?: StringType

    SubstanceDefinition.moiety.molecularFormula Element

    FHIR Specification

    • Short: Molecular formula for this moiety (e.g. with the Hill system)
    • Definition: Molecular formula for this moiety of this substance, typically using the Hill system.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    amount?: IDataType

    SubstanceDefinition.moiety.amount[x] Element

    @ChoiceDataTypesMeta('SubstanceDefinition.moiety.amount[x]', ['Quantity','string',]

    FHIR Specification

    • Short: Quantitative value for this moiety
    • Definition: Quantitative value for this moiety.
    • FHIR Types: 'Quantity', 'string',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    measurementType?: CodeableConcept

    SubstanceDefinition.moiety.measurementType Element

    FHIR Specification

    • Short: The measurement type of the quantitative value
    • Definition: The measurement type of the quantitative value. In capturing the actual relative amounts of substances or molecular fragments it may be necessary to indicate whether the amount refers to, for example, a mole ratio or weight ratio.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubstanceDefinitionMoietyComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SubstanceDefinitionMoietyComponent

      SubstanceDefinitionMoietyComponent data model or undefined for SubstanceDefinitionMoietyComponent

      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