Data Model Libraries
    Preparing search index...

    Class SubstanceSourceMaterialOrganismOrganismGeneralComponent

    SubstanceSourceMaterialOrganismOrganismGeneralComponent Class

    FHIR Specification

    • Short: 4.9.13.7.1 Kingdom (Conditional)
    • Definition: 4.9.13.7.1 Kingdom (Conditional).

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    kingdom?: CodeableConcept

    SubstanceSourceMaterial.organism.organismGeneral.kingdom Element

    FHIR Specification

    • Short: The kingdom of an organism shall be specified
    • Definition: The kingdom of an organism shall be specified.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    SubstanceSourceMaterial.organism.organismGeneral.phylum Element

    FHIR Specification

    • Short: The phylum of an organism shall be specified
    • Definition: The phylum of an organism shall be specified.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    SubstanceSourceMaterial.organism.organismGeneral.class Element

    FHIR Specification

    • Short: The class of an organism shall be specified
    • Definition: The class of an organism shall be specified.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    SubstanceSourceMaterial.organism.organismGeneral.order Element

    FHIR Specification

    • Short: The order of an organism shall be specified,
    • Definition: The order of an organism shall be specified,.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubstanceSourceMaterialOrganismOrganismGeneralComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SubstanceSourceMaterialOrganismOrganismGeneralComponent

      SubstanceSourceMaterialOrganismOrganismGeneralComponent data model or undefined for SubstanceSourceMaterialOrganismOrganismGeneralComponent

      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