Data Model Libraries
    Preparing search index...

    Class SubstanceDefinitionSourceMaterialComponent

    SubstanceDefinitionSourceMaterialComponent Class

    FHIR Specification

    • Short: Material or taxonomic/anatomical source
    • Definition: Material or taxonomic/anatomical source for the substance.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    SubstanceDefinition.sourceMaterial.type Element

    FHIR Specification

    • Short: Classification of the origin of the raw material. e.g. cat hair is an Animal source type
    • Definition: A classification that provides the origin of the raw material. Example: cat hair would be an Animal source type.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    SubstanceDefinition.sourceMaterial.genus Element

    FHIR Specification

    • Short: The genus of an organism e.g. the Latin epithet of the plant/animal scientific name
    • Definition: The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    species?: CodeableConcept

    SubstanceDefinition.sourceMaterial.species Element

    FHIR Specification

    • Short: The species of an organism e.g. the Latin epithet of the species of the plant/animal
    • Definition: The species of an organism, typically referring to the Latin epithet of the species of the plant/animal.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    SubstanceDefinition.sourceMaterial.part Element

    FHIR Specification

    • Short: An anatomical origin of the source material within an organism
    • Definition: An anatomical origin of the source material within an organism.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    countryOfOrigin?: CodeableConcept[]

    SubstanceDefinition.sourceMaterial.countryOfOrigin Element

    FHIR Specification

    • Short: The country or countries where the material is harvested
    • Definition: The country or countries where the material is harvested.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubstanceDefinitionSourceMaterialComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SubstanceDefinitionSourceMaterialComponent

      SubstanceDefinitionSourceMaterialComponent data model or undefined for SubstanceDefinitionSourceMaterialComponent

      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