Data Model Libraries
    Preparing search index...

    Class SubstanceSpecificationStructureComponent

    SubstanceSpecificationStructureComponent Class

    FHIR Specification

    • Short: Structural information
    • Definition: Structural information.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    stereochemistry?: CodeableConcept

    SubstanceSpecification.structure.stereochemistry Element

    FHIR Specification

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

    SubstanceSpecification.structure.opticalActivity Element

    FHIR Specification

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

    SubstanceSpecification.structure.molecularFormula Element

    FHIR Specification

    • Short: Molecular formula
    • Definition: Molecular formula.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    molecularFormulaByMoiety?: StringType

    SubstanceSpecification.structure.molecularFormulaByMoiety Element

    FHIR Specification

    • Short: Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot
    • Definition: Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    SubstanceSpecification.structure.isotope Element

    FHIR Specification

    • Short: Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio
    • Definition: Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    SubstanceSpecification.structure.molecularWeight Element

    FHIR Specification

    • Short: The molecular weight or weight range (for proteins, polymers or nucleic acids)
    • Definition: The molecular weight or weight range (for proteins, polymers or nucleic acids).
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    source?: Reference[]

    SubstanceSpecification.structure.source Element

    FHIR Specification

    SubstanceSpecification.structure.representation Element

    FHIR Specification

    • Short: Molecular structural representation
    • Definition: Molecular structural representation.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubstanceSpecificationStructureComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SubstanceSpecificationStructureComponent

      SubstanceSpecificationStructureComponent data model or undefined for SubstanceSpecificationStructureComponent

      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