Class InvoiceLineItemPriceComponentComponent

InvoiceLineItemPriceComponentComponent Class

Remarks

FHIR Specification

Short: Components of total line item price
Definition: The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice as to how the prices have been calculated.

See

FHIR Invoice

Hierarchy (View Summary)

BackboneElement
- InvoiceLineItemPriceComponentComponent

Implements

IBackboneElement

Constructors

constructor

new InvoiceLineItemPriceComponentComponent(
type_?: null | string | CodeType | EnumCodeType,
): InvoiceLineItemPriceComponentComponent
Parameters
- type_: null | string | CodeType | EnumCodeType = null
Returns InvoiceLineItemPriceComponentComponent
Overrides BackboneElement.constructor
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2297

Properties

`Private` `Readonly`invoicePriceComponentTypeEnum

invoicePriceComponentTypeEnum: InvoicePriceComponentTypeEnum

FHIR CodeSystem: InvoicePriceComponentType

See

InvoicePriceComponentTypeEnum

`Private`type_

type_: null | EnumCodeType

Invoice.lineItem.priceComponent.type Element

Remarks

FHIR Specification

Short: base | surcharge | deduction | discount | tax | informational
Definition: This code identifies the type of the component.
FHIR Type: code
Cardinality: 1..1
isModifier: false
isSummary: false

See

CodeSystem Enumeration: InvoicePriceComponentTypeEnum

`Private` `Optional`code

code?: CodeableConcept

Invoice.lineItem.priceComponent.code Element

Remarks

FHIR Specification

Short: Code identifying the specific component
Definition: A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
FHIR Type: CodeableConcept
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`factor

factor?: DecimalType

Invoice.lineItem.priceComponent.factor Element

Remarks

FHIR Specification

Short: Factor used for calculating this component
Definition: The factor that has been applied on the base price for calculating this component.
Comment: There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden.
FHIR Type: decimal
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`amount

amount?: Money

Invoice.lineItem.priceComponent.amount Element

Remarks

FHIR Specification

Short: Monetary amount associated with this component
Definition: The amount calculated for this component.
Comment: There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden.
FHIR Type: Money
Cardinality: 0..1
isModifier: false
isSummary: false

Methods

`Static`parse

parse(
sourceJson: Value,
optSourceField?: string,
): undefined | InvoiceLineItemPriceComponentComponent
Parse the provided InvoiceLineItemPriceComponentComponent JSON to instantiate the InvoiceLineItemPriceComponentComponent data model.
Parameters
- sourceJson: Value
  JSON representing FHIR InvoiceLineItemPriceComponentComponent
- OptionaloptSourceField: string
  Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to InvoiceLineItemPriceComponentComponent
Returns undefined | InvoiceLineItemPriceComponentComponent
InvoiceLineItemPriceComponentComponent data model or undefined for InvoiceLineItemPriceComponentComponent

Throws
JsonError if the provided JSON is not a valid JSON object
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2318

getTypeEnumType

getTypeEnumType(): null | EnumCodeType
Returns null | EnumCodeType
the type_ property value as a EnumCodeType if defined; else null

See
CodeSystem Enumeration: InvoicePriceComponentTypeEnum
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2451

setTypeEnumType

setTypeEnumType(enumType: undefined | null | EnumCodeType): this
Assigns the provided EnumCodeType value to the type_ property.
Parameters
- enumType: undefined | null | EnumCodeType
  the type_ value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: InvoicePriceComponentTypeEnum
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2465

hasTypeEnumType

hasTypeEnumType(): boolean
Returns boolean
true if the type_ property exists and has a value; false otherwise
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2479

getTypeElement

getTypeElement(): null | CodeType
Returns null | CodeType
the type_ property value as a CodeType if defined; else null

See
CodeSystem Enumeration: InvoicePriceComponentTypeEnum
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2488

setTypeElement

setTypeElement(element: undefined | null | CodeType): this
Assigns the provided PrimitiveType value to the type_ property.
Parameters
- element: undefined | null | CodeType
  the type_ value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: InvoicePriceComponentTypeEnum
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2505

hasTypeElement

hasTypeElement(): boolean
Returns boolean
true if the type_ property exists and has a value; false otherwise
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2519

getType

getType(): null | string
Returns null | string
the type_ property value as a fhirCode if defined; else null

See
CodeSystem Enumeration: InvoicePriceComponentTypeEnum
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2528

setType

setType(value: undefined | null | string): this
Assigns the provided primitive value to the type_ property.
Parameters
- value: undefined | null | string
  the type_ value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
PrimitiveTypeError for invalid primitive types

See
CodeSystem Enumeration: InvoicePriceComponentTypeEnum
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2545

hasType

hasType(): boolean
Returns boolean
true if the type_ property exists and has a value; false otherwise
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2558

getCode

getCode(): CodeableConcept
Returns CodeableConcept
the code property value as a CodeableConcept object if defined; else an empty CodeableConcept object
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2565

setCode

setCode(value: undefined | CodeableConcept): this
Assigns the provided Code object value to the code property.
Parameters
- value: undefined | CodeableConcept
  the code object value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2576

hasCode

hasCode(): boolean
Returns boolean
true if the code property exists and has a value; false otherwise
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2590

getFactorElement

getFactorElement(): DecimalType
Returns DecimalType
the factor property value as a DecimalType object if defined; else an empty DecimalType object
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2597

setFactorElement

setFactorElement(element: undefined | DecimalType): this
Assigns the provided PrimitiveType value to the factor property.
Parameters
- element: undefined | DecimalType
  the factor value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2609

hasFactorElement

hasFactorElement(): boolean
Returns boolean
true if the factor property exists and has a value; false otherwise
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2623

getFactor

getFactor(): undefined | number
Returns undefined | number
the factor property value as a fhirDecimal if defined; else undefined
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2630

setFactor

setFactor(value: undefined | number): this
Assigns the provided primitive value to the factor property.
Parameters
- value: undefined | number
  the factor value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2641

hasFactor

hasFactor(): boolean
Returns boolean
true if the factor property exists and has a value; false otherwise
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2654

getAmount

getAmount(): Money
Returns Money
the amount property value as a Money object if defined; else an empty Money object
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2661

setAmount

setAmount(value: undefined | Money): this
Assigns the provided Amount object value to the amount property.
Parameters
- value: undefined | Money
  the amount object value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2672

hasAmount

hasAmount(): boolean
Returns boolean
true if the amount property exists and has a value; false otherwise
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2686

fhirType

fhirType(): string
Returns string
the FHIR type defined in the FHIR standard
Implementation of IBackboneElement.fhirType
Overrides BackboneElement.fhirType
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2695

isEmpty

isEmpty(): boolean
Returns boolean
true if the instance is empty; false otherwise
Implementation of IBackboneElement.isEmpty
Overrides BackboneElement.isEmpty
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2702

isRequiredFieldsEmpty

isRequiredFieldsEmpty(): boolean
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
Implementation of IBackboneElement.isRequiredFieldsEmpty
Overrides BackboneElement.isRequiredFieldsEmpty
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2715

copy

copy(): InvoiceLineItemPriceComponentComponent
Creates a copy of the current instance.

Returns InvoiceLineItemPriceComponentComponent
the a new instance copied from the current instance
Implementation of IBackboneElement.copy
Overrides BackboneElement.copy
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2726

toJSON

toJSON(): undefined | Value
Returns undefined | Value
the JSON value or undefined if the instance is empty
Implementation of IBackboneElement.toJSON
Overrides BackboneElement.toJSON
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2749

getModifierExtension

getModifierExtension(): IExtension[]
Returns IExtension[]
the array of modifierExtension values
Implementation of IBackboneElement.getModifierExtension
Inherited from BackboneElement.getModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:195

setModifierExtension

setModifierExtension(extension: undefined | IExtension[]): this
Assigns the provided array of Extension values to the modifierExtension property.
Parameters
- extension: undefined | IExtension[]
  array of Extensions
Returns this
this
Implementation of IBackboneElement.setModifierExtension
Inherited from BackboneElement.setModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:202

hasModifierExtension

hasModifierExtension(url?: string): boolean
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

Remarks
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.

Throws
AssertionError for invalid url
Implementation of IBackboneElement.hasModifierExtension
Inherited from BackboneElement.hasModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:214

getModifierExtensionByUrl

getModifierExtensionByUrl(url: string): undefined | IExtension
Returns the Extension having the provided url.
Parameters
- url: string
  the url that identifies a specific Extension
Returns undefined | IExtension
the Extension having the provided url

Throws
AssertionError for invalid url
Implementation of IBackboneElement.getModifierExtensionByUrl
Inherited from BackboneElement.getModifierExtensionByUrl
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:222

addModifierExtension

addModifierExtension(extension: undefined | IExtension): this
Adds the provided Extension to the modifierExtension property array.
Parameters
- extension: undefined | IExtension
  the Extension value to add to the modifierExtension property array
Returns this
this
Implementation of IBackboneElement.addModifierExtension
Inherited from BackboneElement.addModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:229

removeModifierExtension

removeModifierExtension(url: string): void
Removes the Extension having the provided url from the modifierExtension property array.
Parameters
- url: string
  the url that identifies a specific Extension to remove
Returns void
Throws
AssertionError for invalid url
Implementation of IBackboneElement.removeModifierExtension
Inherited from BackboneElement.removeModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:236

getId

getId(): undefined | string
Returns undefined | string
the id property value
Implementation of IBackboneElement.getId
Inherited from BackboneElement.getId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:59

setId

setId(value: undefined | string): this
Assigns the provided value to the id property.
Parameters
- value: undefined | string
  the id value
Returns this
this

Throws
PrimitiveTypeError for invalid value
Implementation of IBackboneElement.setId
Inherited from BackboneElement.setId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:67

hasId

hasId(): boolean
Returns boolean
true if id exists and has a value; false otherwise
Implementation of IBackboneElement.hasId
Inherited from BackboneElement.hasId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:71

getExtension

getExtension(): IExtension[]
Returns IExtension[]
the array of extension values
Implementation of IBackboneElement.getExtension
Inherited from BackboneElement.getExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:75

setExtension

setExtension(extension: undefined | IExtension[]): this
Assigns the provided array of Extension values to the extension property.
Parameters
- extension: undefined | IExtension[]
  array of Extensions
Returns this
this
Implementation of IBackboneElement.setExtension
Inherited from BackboneElement.setExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:82

hasExtension

hasExtension(url?: string): boolean
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

Remarks
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.

Throws
AssertionError for invalid url
Implementation of IBackboneElement.hasExtension
Inherited from BackboneElement.hasExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:94

getExtensionByUrl

getExtensionByUrl(url: string): undefined | IExtension
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

Remarks
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.

Throws
AssertionError for invalid url
Implementation of IBackboneElement.getExtensionByUrl
Inherited from BackboneElement.getExtensionByUrl
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:106

addExtension

addExtension(extension: undefined | IExtension): this
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
Implementation of IBackboneElement.addExtension
Inherited from BackboneElement.addExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:113

removeExtension

removeExtension(url: string): void
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
Throws
AssertionError for invalid url
Implementation of IBackboneElement.removeExtension
Inherited from BackboneElement.removeExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:120

isResource

isResource(): boolean
Returns boolean
true if the instance is a FHIR resource; false otherwise
Implementation of IBackboneElement.isResource
Inherited from BackboneElement.isResource
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:67

isDataType

isDataType(): boolean
Returns boolean
true if the instance is a FHIR complex or primitive datatype; false otherwise
Implementation of IBackboneElement.isDataType
Inherited from BackboneElement.isDataType
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:71

isComplexDataType

isComplexDataType(): boolean
Returns boolean
true if the instance is a FHIR complex datatype; false otherwise
Implementation of IBackboneElement.isComplexDataType
Inherited from BackboneElement.isComplexDataType
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:75

isPrimitive

isPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive datatype; false otherwise
Implementation of IBackboneElement.isPrimitive
Inherited from BackboneElement.isPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:79

isBooleanPrimitive

isBooleanPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive boolean datatype; false otherwise
Implementation of IBackboneElement.isBooleanPrimitive
Inherited from BackboneElement.isBooleanPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:83

isStringPrimitive

isStringPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive string-based datatype; false otherwise
Implementation of IBackboneElement.isStringPrimitive
Inherited from BackboneElement.isStringPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:87

isNumberPrimitive

isNumberPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive number-based datatype; false otherwise
Implementation of IBackboneElement.isNumberPrimitive
Inherited from BackboneElement.isNumberPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:91

isBigIntPrimitive

isBigIntPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
Implementation of IBackboneElement.isBigIntPrimitive
Inherited from BackboneElement.isBigIntPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:95

isDateTimePrimitive

isDateTimePrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
Implementation of IBackboneElement.isDateTimePrimitive
Inherited from BackboneElement.isDateTimePrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:99

`Protected`copyValues

copyValues(dest: InvoiceLineItemPriceComponentComponent): void
Protected
Copies the current instance's elements into the provided object.
Parameters
- dest: InvoiceLineItemPriceComponentComponent
  the copied instance
Returns void
Overrides BackboneElement.copyValues
- Defined in packages/r4b-datamodels/src/resources/Invoice.ts:2738

Class InvoiceLineItemPriceComponentComponent

Remarks

See

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns InvoiceLineItemPriceComponentComponent

Properties

Private ReadonlyinvoicePriceComponentTypeEnum

See

Privatetype_

Remarks

See

Private Optionalcode

Remarks

Private Optionalfactor

Remarks

Private Optionalamount

Remarks

Methods

Staticparse

Parameters

Returns undefined | InvoiceLineItemPriceComponentComponent

Throws

getTypeEnumType

Returns null | EnumCodeType

See

setTypeEnumType

Parameters

Returns this

Throws

Throws

See

hasTypeEnumType

Returns boolean

getTypeElement

Returns null | CodeType

See

setTypeElement

Parameters

Returns this

Throws

Throws

See

hasTypeElement

Returns boolean

getType

Returns null | string

See

setType

Parameters

Returns this

Throws

Throws

See

hasType

Returns boolean

getCode

Returns CodeableConcept

setCode

Parameters

Returns this

Throws

hasCode

Returns boolean

getFactorElement

Returns DecimalType

setFactorElement

Parameters

Returns this

Throws

Throws

hasFactorElement

Returns boolean

`Private` `Readonly`invoicePriceComponentTypeEnum

`Private`type_

`Private` `Optional`code

`Private` `Optional`factor

`Private` `Optional`amount

`Static`parse