Payment Batch
Description
The PaymentBatch message is utilized to send a payment notification, typically from a payer to a healthcare provider, though it can also be used in other scenarios where funds are transferred between parties. This message is functionally similar to the Payment Event, but enables multiple transactions to be transmitted in a batch.
API Endpoints for Payment Batch
Sync REST API Endpoint to call the API: https://{base_url}/api/v1/claim/payment-batch.
Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.
Data Model JSON for Payment Batch
Payment Batch - Sample Payload
{
"Meta": {
"DataModel": "Claim",
"EventType": "PaymentBatch",
"EventDateTime": "2022-08-16T14:21:20.733Z",
"Test": true,
"Source": {
"ID": "fabc4270-120d-4e6c-850f-85db403823f2 ",
"Name": "EHR Bridge Dev Tools"
},
"Destinations": [
{
"ID": "ec152e05-2efc-485b-b2b0-3b9959a8898f",
"Name": "Destinations EMR"
}
],
"Logs": [
{
"ID": "bfa13de1-5367-40e2-9d84-40976c1854dc ",
"AttemptID": "d1bcf867-fe79-4c5a-baa4-6b12e8d56df3 "
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Transactions": [
{
"ID": "000000001",
"IDType": null,
"Type": "Profressional",
"TotalPaymentAmount": "580.00",
"CreditOrDebit": "Credit",
"PaymentMethod": "Check",
"PaymentDateTime": "2016-11-11T02:11:03.111Z",
"TrackingNumber": "8675309",
"Submitter": {
"Identifiers": [
{
"ID": "123456",
"IDType": "TIN"
}
],
"Name": "United Insurance Company",
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddress": null,
"PhoneNumber": {
"Office": null,
"Fax": null
}
},
"Receiver": {
"Identifiers": [
{
"ID": "8675309",
"IDType": "TIN"
}
],
"Name": "Digital Health System",
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddress": null,
"PhoneNumber": {
"Office": null,
"Fax": null
}
},
"Payments": [
{
"DateTime": "2016-11-08T02:11:03.111Z",
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "b680373a-c675-46e2-8a13-5b968f796c74 ",
"IDType": "EHRID"
},
{
"ID": "4b6a53d0-37be-4dd1-9601-64d418a1cfcc ",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Ronnie",
"MiddleName": "Patricks ",
"LastName": "Oliver",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [
],
"Language": "en",
"Citizenship": [
],
"Address": {
"StreetAddress": "4762 Wallgate Avenue",
"City": "San Jose",
"State": "CA",
"ZIP": "53566",
"County": "Santa Clara",
"Country": "USA"
}
},
"Notes": [
]
},
"Claims": [
{
"ControlNumber": "94151100100",
"SubmissionNumber": "66729659983",
"ReceivedDate": "2016-10-31",
"StartDateTime": null,
"EndDateTime": null,
"Status": "Processed as Primary",
"ChargedAmount": "100.00",
"PaymentAmount": "65.00",
"PatientResponsibilityAmount": "20.00",
"ReferenceNumbers": [
{
"ID": "AUTH000000",
"IDType": "Prior Authorization"
}
],
"Adjustments": [
],
"Services": [
{
"ChargedAmount": "100.00",
"PaymentAmount": "65.00",
"ChargedUnits": null,
"PaymentUnits": null,
"AllowedAmount": "85.00",
"SubmittedService": {
"Code": null,
"Codeset": null,
"Description": null,
"Modifiers": [
]
},
"AdjudicatedService": {
"Code": null,
"Codeset": null,
"Description": null,
"Modifiers": [
]
},
"Adjustments": [
{
"Amount": "20.00",
"Quantity": null,
"Type": "Patient responsibility",
"Reason": "Deductible amount"
},
{
"Amount": "15.00",
"Quantity": null,
"Type": "Contractobligations",
"Reason": "Claim discount"
}
],
"StartDateTime": null,
"EndDateTime": null,
"ReferenceNumbers": [
{
"ID": "1",
"IDType": "Control Number"
}
]
}
]
}
]
},
{
"DateTime": "2016-11-08T02:11:03.111Z",
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "b680373a-c675-46e2-8a13-5b968f796c74",
"IDType": "EHRID"
},
{
"ID": "4b6a53d0-37be-4dd1-9601-64d418a1cfcc",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Ronnie ",
"MiddleName": "Patricks",
"LastName": "Oliver",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [
],
"Language": "en",
"Citizenship": [
],
"Address": {
"StreetAddress": "4762 Wallgate Avenue",
"City": "San Jose",
"State": "CA",
"ZIP": "53566",
"County": "Santa Clara",
"Country": "USA"
}
},
"Notes": [
]
},
"Claims": [
{
"ControlNumber": "94151100200",
"SubmissionNumber": "774466586",
"ReceivedDate": "2016-10-31",
"StartDateTime": null,
"EndDateTime": null,
"Status": "Processed as Primary",
"ChargedAmount": "100.00",
"PaymentAmount": "75.00",
"PatientResponsibilityAmount": "20.00",
"ReferenceNumbers": [
{
"ID": "REDT00000",
"IDType": "Prior Authorization"
}
],
"Adjustments": [
],
"Services": [
{
"ChargedAmount": "100.00",
"PaymentAmount": "75.00",
"ChargedUnits": null,
"PaymentUnits": null,
"AllowedAmount": "95.00",
"SubmittedService": {
"Code": null,
"Codeset": null,
"Description": null,
"Modifiers": [
]
},
"AdjudicatedService": {
"Code": null,
"Codeset": null,
"Description": null,
"Modifiers": [
]
},
"Adjustments": [
{
"Amount": "20.00",
"Quantity": null,
"Type": "Patient responsibility",
"Reason": "Deductible amount"
},
{
"Amount": "5.00",
"Quantity": null,
"Type": "Contract obligations",
"Reason": "Claim discount"
}
],
"StartDateTime": null,
"EndDateTime": null,
"ReferenceNumbers": [
{
"ID": "1",
"IDType": "Control Number"
}
]
}
]
}
]
}
]
}
]
}