FinancialTransaction

This topic describes information for the FinancialTransaction resource.

To interact with the REST endpoints in the FinancialTransaction resource, see FinancialTransaction.

Overview

The FinancialTransaction resource provides the ability to record and exchange financial payment and adjustment information related to patient healthcare services. This custom resource is implemented through extensions on the Basic resource.

Terminology Bindings

• Basic.extension[x].valueCodeableConcept

  Description: The category of payment type codes. Whether this is a payment or adjustment. This binding is used in financial-transaction-type extensions

  Details: Payment Type Codes

  System: http://terminology.hl7.org/CodeSystem/payment-type

• Basic.extension[x].valueCodeableConcept

  Description: The payment method of the transaction. This binding is used in financial-transaction-method extensions.

  Details: v2 Payment Method Code

  System: http://terminology.hl7.org/CodeSystem/v2-0570

• Basic.extension[x].valueMoney.currency

  Description: Currency codes from ISO 4217 (see https://www.iso.org/iso-4217-currency-codes.html). This binding is used for financial-transaction-tendered-amount extensions.

  Details: Currencies

  System: urn:iso:std:iso:4217

• Basic.extension[x].valueMoney.currency

  Description: Currency codes from ISO 4217 (see https://www.iso.org/iso-4217-currency-codes.html). This binding is used for financial-transaction-amount extensions.

  Details: Currencies

  System: urn:iso:std:iso:4217

• Basic.extension[x].extension[x].valueMoney.currency (for more information, see the Extensions section of this topic)

  Description: Currency codes from ISO 4217 (see https://www.iso.org/iso-4217-currency-codes.html). This binding is used for amount extensions nested under financial-transaction-allocation extensions.

  Details: Currencies

  System: urn:iso:std:iso:4217

Extensions

Table - Extensions

ID	Value[x} Type	Description
apply-first-in-first-out	boolean	Whether to apply FIFO logic for recurring encounters.
financial-transaction-account-number	string	A value associated with the specific payment method usually represented as the last four digits of a credit card, the check number, the EFT number, or Lockbox number.
financial-transaction-alias	string	A client-defined value to represent the combination of the type, subtype, and reason describing the financial transaction.
financial-transaction-allocation	None (contains nested extensions)	Defines how the payment or adjustment is to be allocated across other resources.
financial-transaction-amount	Money	The total amount of the financial transaction.
financial-transaction-card-brand	string	Identifies the brand of credit card when credit card is used as a payment method.
financial-transaction-date	date	Represents the expiration date if the method is card or check date if the method is check.
financial-transaction-location	string	A client-configured value representing the location or workflow that the payment was received in.
financial-transaction-method	string	Describes the method of payment for the financial transaction.
financial-transaction-tendered-amount	Money	The amount of cash originally tendered for payment. This value should be greater than or equal to the amount of the cash payment.
financial-transaction-type	CodeableConcept	The classification of the transaction.