Data Model Libraries
    Preparing search index...

    MonetaryComponent Class

    MonetaryComponent Type: Availability data for an {item}.

    FHIR Specification

    • Short: Availability data for an {item}
    • Definition: Availability data for an {item}.
    • FHIR Version: 5.0.0

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    priceComponentTypeEnum: PriceComponentTypeEnum

    FHIR CodeSystem: PriceComponentType

    type_: null | EnumCodeType

    MonetaryComponent.type Element

    FHIR Specification

    • Short: base | surcharge | deduction | discount | tax | informational
    • Definition: base | surcharge | deduction | discount | tax | informational.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: PriceComponentTypeEnum

    MonetaryComponent.code Element

    FHIR Specification

    • Short: Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
    • Definition: Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    factor?: DecimalType

    MonetaryComponent.factor Element

    FHIR Specification

    • Short: Factor used for calculating this component
    • Definition: Factor used for calculating this component.
    • FHIR Type: decimal
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    amount?: Money

    MonetaryComponent.amount Element

    FHIR Specification

    • Short: Explicit value amount to be used
    • Definition: Explicit value amount to be used.
    • FHIR Type: Money
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MonetaryComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MonetaryComponent

      MonetaryComponent data model or undefined for MonetaryComponent

      JsonError if the provided JSON is not a valid JSON object

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    • 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

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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 the instance is a FHIR resource; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive boolean datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive string-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive number-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive bigint-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datetime-based datatype; false otherwise