Record Payment
Source Object: Record Payment
Overview and Usage: The "Record Payment" source object is essential for recording and managing payment details related to healthcare services. This source object contains information about payments received for appointments or services. Here's a breakdown of the key components:
- Appointment ID: The unique identifier for the appointment to which the payment is related.
- Card Number Last 4: The last 4 digits of the credit card number used for the payment.
- Check Number: The number associated with the payment check.
- Claim Payment: The amount of the payment applied to the insurance claim.
- Copay Amount: The amount paid as a copayment by the patient.
- Department ID: The unique identifier for the department associated with the payment.
- Other Amount: Any other miscellaneous payment amount.
- Payment Method: The method of payment used, such as credit card, check, cash, etc.
- Post Date: The date on which the payment was posted or recorded.
- Today's Service: Indicates whether the payment is related to the services provided on the same day.
- Patient ID: The unique identifier for the patient making the payment.
The "Record Payment" source object helps healthcare organizations efficiently manage financial transactions related to patient appointments and services, ensuring accurate payment records and reconciliation.
Mapping Table
| Data Field | Example Value | Source Data Field Description | Source Field Data Type | Source Data Field Cardinality | Mapped FHIR++ Resource | Mapped FHIR Data Field | Augmented Mapping | Associated Coding System | Associated FHIR Data Field Extension | Mapping Context |
|---|---|---|---|---|---|---|---|---|---|---|
| appointmentid | - | The ID of the appointment where the copay should be applied. | integer | 0..1 | PaymentNotice | extension.valueString | appointment-id | Top Level | ||
| cardnumberlast4 | - | The last 4 digits of the credit card number. This is required if the payment method is a credit card. | string | 0..1 | PaymentNotice | extension.valueString | card-number-last4 | Top Level | ||
| checknumber | - | The check number. This is required if the payment is made by check. | string | 0..1 | PaymentNotice | extension.valueString | check-number | Top Level | ||
| claimpayment | - | A JSON representation of claim ID and payment combinations. For example, '[ { "1":"1.00"}, { "2":"5.00"} ].' This indicates a payment of $1 for claim ID #1 and a payment of $5 for claim ID #2. | array | 0..1 | PaymentNotice | extension.valueString | claim-payment | Top Level | ||
| copayamount | - | The amount associated with a particular appointment for a copay. | string | 0..1 | PaymentNotice | amount.value | Top Level | |||
| departmentid | - | The ID of the department where the payment or contract is being collected. | integer | 0..1 | PaymentNotice | context | Top Level | |||
| otheramount | - | The amount being collected that is not associated with individual appointment. This money goes into the "unapplied" bucket. In the future, these payments will be able to be broken down by individual claim level. Co-pay amounts should be in "copayamount". | string | 0..1 | PaymentNotice | extension.valueString | other-amount | Top Level | ||
| paymentmethod | - | Valid values include CASH or CHECK or anything as a result of /configuration/validnonccpcreditcardmethods. Note that practices using Credit Card Plus (CCP) should typically NOT be using this call and should instead use the collectpayment endpoints to charge the card. In addition, all payments recorded via this method are subject to the same policies as any other money collected by athenahealth. | string | 0..1 | PaymentNotice | extension.valueString | payment-method | Top Level | ||
| postdate | - | The date the payment was made. Defaulted to today. | string | 0..1 | PaymentNotice | extension.valueDate | post-date | Top Level | ||
| todayservice | - | Apply the other amount value to today's service. | string | 0..1 | PaymentNotice | extension.valueString | today-service | Top Level | ||
| patientId | - | - | string | 0..1 | PaymentNotice | context | Top Level |