Page tree
ElementCardinalityTypeDescriptionPayment ReconciliationNotes
FinancialTransactionDomain ResourceResource used for exchanging financial payment and adjustment details
FinancialTransaction.id0..1idLogical id of this artifact
FinancialTransaction.identifier0..*IdentifierBusiness identifier
FinancialTransaction.status1..1Codeactive | inactive | entered-in-error | on-hold | unknown http://hl7.org/fhir/r4/valueset-fm-status.html (required)
FinancialTransaction.type1..1CodeableConceptpayment | adjustment http://hl7.org/fhir/r4/valueset-payment-type.html
FinancialTransaction.subtype0..1CodeableConceptSomething to further classify the type of financial transaction. ex: Insurance or Patient payment
FinancialTransaction.created1..1dateTimeCreation date of the resource
FinancialTransaction.reason0..1CodeableConceptHelps identify the workflow of the payment. example: Online Bill Payment
FinancialTransaction.subject0..1Reference(Any)Identifies the focus of this resource
FinancialTransaction.date0..1dateWhen transaction took placepaymentDate
FinancialTransaction.period0..1PeriodPeriod covered
FinancialTransaction.author0..1Reference(Practitioner |Patient | RelatedPerson | PractitionerRole | Organization)Who created or issued the resourcepaymentIssuerrequest and requestor may not be required
FinancialTransaction.location0..1Reference(Location)The location where the payment was collected.outcome and disposition may not be required
FinancialTransaction.method0..1CodeableConceptCredit Card | Cash | Check | Direct Deposit | Cashier's Check | Traveler's Check https://www.hl7.org/fhir/v2/0570/index.html
FinancialTransaction.cardBrand0..1stringcard brandmay need card backbone element. CVV2 could be shared. EMV specific fields
FinancialTransaction.accountNumber0..1stringlast four digits of Credit Card
FinancialTransaction.number0..1stringcheck number or Trace Number (This may belong as an Alias in the Identifier field)check number may need to be its own field
FinancialTransaction.expirationDate0..1date (YYYY-MM)expiration date of Credit Card
FinancialTransaction.processor0..1stringprocessor of electronic transaction. May use the routing number
FinancialTransaction.referenceNumber0..1stringprocessor transaction identifieris this the paymentIdentifier?
FinancialTransaction.authorization0..1stringauthorization code of Credit Card or EFT transaction
FinancialTransaction.tenderedAmount0..1moneyTendered amount for the payment.
FinancialTransaction.returnedAmount0..1moneytendered amount minus the total amount
FinancialTransaction.amount1..1moneyRepresents the total amount of the financial transactionspaymentAmount
FinancialTransaction.allocation1..*BackboneHow the payment or adjustment is applied.Missing detail.date, detail.response, detail.payee
FinancialTransaction.allocation.target1..1Reference(Claim | Account | Invoice | Item |Encounter)Specific resource that the payment or adjustment is allocated todetail.requestMay not be able to reference item if it isn't a resource on its own. Does the item have a global unique identifier
FinancialTransaction.allocation.amount1..1moneyRepresents the amount to be allocated to the specific targetdetail.amount
FinancialTransaction.allocation.encounter0..1Reference(Encounter)Related Encounter
FinancialTransaction.allocation.account0..1Reference(Account)Account where allocation was applied