Data Model Libraries
    Preparing search index...

    SubstanceInstanceComponent Class

    FHIR Specification

    • Short: If this describes a specific package/container of the substance
    • Definition: Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    identifier?: Identifier

    Substance.instance.identifier Element

    FHIR Specification

    • Short: Identifier of the package/container
    • Definition: Identifier associated with the package/container (usually a label affixed directly).
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    expiry?: DateTimeType

    Substance.instance.expiry Element

    FHIR Specification

    • Short: When no longer valid to use
    • Definition: When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    quantity?: Quantity

    Substance.instance.quantity Element

    FHIR Specification

    • Short: Amount of substance in the package
    • Definition: The amount of the substance.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubstanceInstanceComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SubstanceInstanceComponent

      SubstanceInstanceComponent data model or undefined for SubstanceInstanceComponent

      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