Data Model Libraries
    Preparing search index...

    Class SubstanceDefinitionStructureRepresentationComponent

    SubstanceDefinitionStructureRepresentationComponent Class

    FHIR Specification

    • Short: A depiction of the structure or characterization of the substance
    • Definition: A depiction of the structure or characterization of the substance.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    SubstanceDefinition.structure.representation.type Element

    FHIR Specification

    • Short: The kind of structural representation (e.g. full, partial)
    • Definition: The kind of structural representation (e.g. full, partial).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    representation?: StringType

    SubstanceDefinition.structure.representation.representation Element

    FHIR Specification

    • Short: The structural representation or characterization as a text string in a standard format
    • Definition: The structural representation or characterization as a text string in a standard format.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    SubstanceDefinition.structure.representation.format Element

    FHIR Specification

    • Short: The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format)
    • Definition: The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF. The logical content type rather than the physical file format of a document.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    document?: Reference

    SubstanceDefinition.structure.representation.document Element

    FHIR Specification

    • Short: An attachment with the structural representation e.g. a structure graphic or AnIML file
    • Definition: An attached file with the structural representation or characterization e.g. a molecular structure graphic of the substance, a JCAMP or AnIML file.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubstanceDefinitionStructureRepresentationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SubstanceDefinitionStructureRepresentationComponent

      SubstanceDefinitionStructureRepresentationComponent data model or undefined for SubstanceDefinitionStructureRepresentationComponent

      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