Data Model Libraries
    Preparing search index...

    Class SubstanceSourceMaterialOrganismComponent

    SubstanceSourceMaterialOrganismComponent Class

    FHIR Specification

    • Short: This subclause describes the organism which the substance is derived from. For vaccines, the parent organism shall be specified based on these subclause elements. As an example, full taxonomy will be described for the Substance Name: ., Leaf
    • Definition: This subclause describes the organism which the substance is derived from. For vaccines, the parent organism shall be specified based on these subclause elements. As an example, full taxonomy will be described for the Substance Name: ., Leaf.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    SubstanceSourceMaterial.organism.family Element

    FHIR Specification

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

    SubstanceSourceMaterial.organism.genus Element

    FHIR Specification

    • Short: The genus of an organism shall be specified; refers to the Latin epithet of the genus element of the plant/animal scientific name; it is present in names for genera, species and infraspecies
    • Definition: The genus of an organism shall be specified; refers to the Latin epithet of the genus element of the plant/animal scientific name; it is present in names for genera, species and infraspecies.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    species?: CodeableConcept

    SubstanceSourceMaterial.organism.species Element

    FHIR Specification

    • Short: The species of an organism shall be specified; refers to the Latin epithet of the species of the plant/animal; it is present in names for species and infraspecies
    • Definition: The species of an organism shall be specified; refers to the Latin epithet of the species of the plant/animal; it is present in names for species and infraspecies.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    intraspecificType?: CodeableConcept

    SubstanceSourceMaterial.organism.intraspecificType Element

    FHIR Specification

    • Short: The Intraspecific type of an organism shall be specified
    • Definition: The Intraspecific type of an organism shall be specified.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    intraspecificDescription?: StringType

    SubstanceSourceMaterial.organism.intraspecificDescription Element

    FHIR Specification

    • Short: The intraspecific description of an organism shall be specified based on a controlled vocabulary. For Influenza Vaccine, the intraspecific description shall contain the syntax of the antigen in line with the WHO convention
    • Definition: The intraspecific description of an organism shall be specified based on a controlled vocabulary. For Influenza Vaccine, the intraspecific description shall contain the syntax of the antigen in line with the WHO convention.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    SubstanceSourceMaterial.organism.author Element

    FHIR Specification

    • Short: 4.9.13.6.1 Author type (Conditional)
    • Definition: 4.9.13.6.1 Author type (Conditional).
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    SubstanceSourceMaterial.organism.hybrid Element

    FHIR Specification

    • Short: 4.9.13.8.1 Hybrid species maternal organism ID (Optional)
    • Definition: 4.9.13.8.1 Hybrid species maternal organism ID (Optional).
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    SubstanceSourceMaterial.organism.organismGeneral Element

    FHIR Specification

    • Short: 4.9.13.7.1 Kingdom (Conditional)
    • Definition: 4.9.13.7.1 Kingdom (Conditional).
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubstanceSourceMaterialOrganismComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SubstanceSourceMaterialOrganismComponent

      SubstanceSourceMaterialOrganismComponent data model or undefined for SubstanceSourceMaterialOrganismComponent

      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