Date of Service Matching Payment Transactions File Field Specification (CSV)
transactions_out.csv
File format is standard CSV (http://www.ietf.org/rfc/rfc4180.txt).
| Field Index | Description | Format | Max Len |
|---|---|---|---|
| 1 | Patient ID | Alphanumeric | 50 |
| 2 | Patient Name | Alphanumeric | 50 |
| 3 | Payment Plan ID | Alphanumeric | 17 |
| 4 | Transaction ID | UUID | 36 |
| 5 | Original Transaction ID | UUID | 36 |
| 6 | Amount | 99999999.99 | 12 |
| 7 | Payment Method | Alpha | 10 |
| 8 | Action | Alpha | 20 |
| 9 | Timestamp | mm/dd/yyyy hh:mm:ss tt | 25 |
| 10 | Encounter ID | Alpha | 20 |
| 11 | Service Date | mm/dd/yyyy | 10 |
| 12 | Client ID | Alpha | 8 |
| 13 | Origin | Alpha | 50 |
| 14 | User | Alpha | 50 |
Field Definitions
- Patient ID - Unique identifier for the patient, as determined by the external account management system.
- Patient Name - Name of the patient performing the transaction.
- Payment Plan ID - Unique identifier used to identify a payment plan. Generated by ClearGage. This can be used by the PMS as a reference to a payment profile in ClearGage.
- Transaction ID - A unique identifier for the transaction.
- Original Transaction ID - Transaction ID of original transaction if this is a credit or void. Otherwise it will be the same as the Transaction ID.
- Amount - The dollar amount of the payment transaction.
- Payment Method - The method used to make the payment. (See below)
- Action - The type of transaction that was performed. (See below)
- Timestamp - The date/time the transaction took place.
- Encounter ID - The encounter the payment was applied to.
- Service Date - The date of service of the encounter the payment was applied to.
- Client ID - ID of the branch where the payment was made.
- User - User responsible for initiating the payment (potentially used for paying commissions).
Payment Types / Actions
- PAYMENT - Payments made by the patient that apply towards the plan balance.
- FEE - Fees paid by the patient that do not go against the plan balance.
- CREDIT - Credit/void (refund) or Reject of a previous PAYMENT.
- FEE CREDIT - Credit (refund) or Reject of a previous FEE.
- DISCOUNT - Discount applied to a plan balance.
- ADJUSTMENT - Adjustment to a plan balance.
- PREFUND DISCOUNT - Plan balance discount for prefunding.
- PREFUND BUYOUT - Prefund payment of plan balance.
Payment Methods
- CREDIT - Payment was made with a credit card or debit account.
- ACH - Payment was made with a checking or savings account.
- CASH - Payment was made with cash.
Example File
"AEC36F10","JOHN DOE","AEC36F10-A2A5158B","F0738B6C-D473-47DE-84C9EA4B78C21323","F0738B6C-D473-47DE-84C9EA4B78C21323",
"575.00","","DISCOUNT","05\/08\/2013 06:28:59 AM",,,,,
"AEC36F10","JOHN DOE","AEC36F10-A2A5158B","CBF6674A-5107-4E34-8F6EEDEDFEB0405D","CBF6674A-5107-4E34-8F6EEDEDFEB0405D",
"-400.00","","ADJUSTMENT","05\/08\/2013 06:31:40 AM",,,,,
"AEC36F10","JOHN DOE","AEC36F10-A2A5158B","BDD8B802-A88C-49F3-9CD456F1BF2A9372","BDD8B802-A88C-49F3-9CD456F1BF2A9372",
"700.00","","ADJUSTMENT","05\/08\/2013 06:31:54 AM",,,,,
"AEC36F10","JOHN DOE","AEC36F10-A2A5158B","373A143C-DB21-430B-87323F5EEEC0DF3D","373A143C-DB21-430B-87323F5EEEC0DF3D",
"279.45","CREDIT","PAYMENT","05\/08\/2013 10:37:43 AM",,,,,
"AEC36F10","JOHN DOE","AEC36F10-A2A5158B","373A143C-DB21-430B-87323F5EEEC0DF3D","373A143C-DB21-430B-87323F5EEEC0DF3D",
"-20.70","CREDIT","FEE","05\/08\/2013 10:37:43 AM",,,,,
"AEC36F10","JOHN DOE","AEC36F10-A2A5158B","6092801C-55E7-4682-A8EAFFEC5250B7F7","373A143C-DB21-430B-87323F5EEEC0DF3D",
"-279.45","CREDIT","CREDIT","05\/08\/2013 10:41:29 AM",,,,,
"AEC36F10","JOHN DOE","AEC36F10-A2A5158B","6092801C-55E7-4682-A8EAFFEC5250B7F7","373A143C-DB21-430B-87323F5EEEC0DF3D",
"20.70","CREDIT","FEE CREDIT","05\/08\/2013 10:41:29 AM",,,,,
Available Customizations
- Include Patient First and Last Name Separately
- Include Patient Account Number
- Include Patient Address
- Include Patient Birth Date
- Include Client Name
- Include Client Address
- Include Tracking Id
- Include Transaction Type
- Include Plan Account Number
- Include Payment Account Type
- Include Payment Account Type Label
- Include Payment Account Number
- Include Payment Profile Id
- Include Original Transaction Timestamp
Customizations are currently handled via account configuration and must be specifically enabled by contacting us. They are not configurable as part of the request parameters.