Data Model Libraries
    Preparing search index...

    Class SubstanceSpecificationStructureIsotopeComponent

    SubstanceSpecificationStructureIsotopeComponent Class

    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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    identifier?: Identifier

    SubstanceSpecification.structure.isotope.identifier Element

    FHIR Specification

    • Short: Substance identifier for each non-natural or radioisotope
    • Definition: Substance identifier for each non-natural or radioisotope.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    FHIR Specification

    • Short: Substance name for each non-natural or radioisotope
    • Definition: Substance name for each non-natural or radioisotope.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    substitution?: CodeableConcept

    SubstanceSpecification.structure.isotope.substitution Element

    FHIR Specification

    • Short: The type of isotopic substitution present in a single substance
    • Definition: The type of isotopic substitution present in a single substance.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    halfLife?: Quantity

    SubstanceSpecification.structure.isotope.halfLife Element

    FHIR Specification

    • Short: Half life - for a non-natural nuclide
    • Definition: Half life - for a non-natural nuclide.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    SubstanceSpecification.structure.isotope.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

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubstanceSpecificationStructureIsotopeComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SubstanceSpecificationStructureIsotopeComponent

      SubstanceSpecificationStructureIsotopeComponent data model or undefined for SubstanceSpecificationStructureIsotopeComponent

      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