Data Model Libraries
    Preparing search index...

    InvoiceLineItemComponent Class

    FHIR Specification

    • Short: Line items of this Invoice
    • Definition: Each line item represents one charge for goods and services rendered. Details such.ofType(date), code and amount are found in the referenced ChargeItem resource.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    sequence?: PositiveIntType

    Invoice.lineItem.sequence Element

    FHIR Specification

    • Short: Sequence number of line item
    • Definition: Sequence in which the items appear on the invoice.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    serviced?: IDataType

    Invoice.lineItem.serviced[x] Element

    @ChoiceDataTypesMeta('Invoice.lineItem.serviced[x]', ['date','Period',]

    FHIR Specification

    • Short: Service data or period
    • Definition: Date/time(s) range when this service was delivered or completed.
    • FHIR Types: 'date', 'Period',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    chargeItem: null | IDataType

    Invoice.lineItem.chargeItem[x] Element

    @ChoiceDataTypesMeta('Invoice.lineItem.chargeItem[x]', ['Reference','CodeableConcept',]

    FHIR Specification

    • Short: Reference to ChargeItem containing details of this line item or an inline billing code
    • Definition: The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference.
    • FHIR Types: 'Reference', 'CodeableConcept',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    priceComponent?: MonetaryComponent[]

    Invoice.lineItem.priceComponent Element

    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.
    • FHIR Type: MonetaryComponent
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR InvoiceLineItemComponent

      • OptionaloptSourceField: string

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

      Returns undefined | InvoiceLineItemComponent

      InvoiceLineItemComponent data model or undefined for InvoiceLineItemComponent

      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 the instance is a FHIR complex or primitive datatype; false otherwise