Payment
Description
A Payment message is employed to transmit a payment notification, usually from a payer to a healthcare provider, although it may also be used in other scenarios where funds are transferred between parties.
API Endpoints for NotesQuery
Sync REST API Endpoint to call the API: https://{base_url}/api/v1/claim/payment.
Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.
Data Model JSON for Payments
Payment - Sample Payload
{
{
"Meta": {
"DataModel": "Claim",
"EventType": "Payment",
"EventDateTime": "2022-09-16T14:21:20.233Z",
"Test": true,
"Source": {
"ID": "a424d5f5-7f5b-4d36-aa18-86b2c2027f93 ",
"Name": "EHR Bridge Dev Tools"
},
"Destinations": [
{
"ID": "7ea61f3e-6aa7-4f5e-a0f6-5796fee1dcab",
"Name": "Destinations EMR"
}
],
"Logs": [
{
"ID": "9474d6ca-6e93-4917-8e0d-42a905a4f932",
"AttemptID": "cdc77b4d-5050-46db-82b6-2539a939e0ad "
}
],
"Message": {
"ID": 5520
},
"Transmission": {
"ID": 12445
},
"FacilityCode": null
},
"Transaction": {
"ID": "000000001",
"IDType": null,
"Type": null,
"Submitter": {
"ID": null,
"IDType": null,
"Name": "United Insurance Agency",
"EmailAddress": null,
"PhoneNumber": {
"Office": null,
"Fax": null
}
},
"Receiver": {
"ID": null,
"IDType": null,
"Name": "Digital Health System"
},
"TotalPaymentAmount": "580.00",
"CreditOrDebit": "Credit",
"PaymentMethod": "Check",
"PaymentDateTime": "2016-11-11T02:11:03.111Z",
"TrackingNumber": "875309"
},
"Payer": {
"ID": "9876538",
"IDType": "HPID",
"Name": "AIAA Insurance Organisationp",
"Address": {
"StreetAddress": "123 Oliver street",
"City": "San Jose"",
"State": "CA",
"ZIP": "90410",
"County": null,
"Country": null
},
"EmailAddress": null,
"PhoneNumber": {
"Office": null,
"Fax": null
}
},
"Payee": {
"ID": "51538912",
"IDType": null,
"Name": "Digital Health System",
"Address": {
"StreetAddress": "2045 Sealink Way",
"City": "San Jose",
"State": "CA",
"ZIP": "45304",
"County": null,
"Country": null
},
"EmailAddress": null,
"PhoneNumber": {
"Office": null,
"Fax": null
}
},
"Payments": [
{
"DateTime": "2016-11-08T02:11:03.111Z",
"Patient": {
"Identifiers": [
{
"ID": "2348725",
"IDType": "MR"
},
{
"ID": "863b3f2b-ee8c-4f72-8c87-798dc11e4295 ",
"IDType": "EHRID"
},
{
"ID": "4ad125fd-aa1b-426f-af38-9f7a16d607ed",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Gammy",
"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": "+19089875301",
"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": []
},
"Claim": {
"Number": "4567889",
"SubmissionNumber": null,
"ReceivedDate": "2016-10-31",
"ServiceDateTime": "2016-10-08T08:58:03.125Z",
"ServiceEndDateTime": "2016-10-11T14:58:03.532Z",
"Status": "Processed as Primary",
"ChargedAmount": "100.00",
"PaymentAmount": "65.00",
"PatientResponsibilityAmount": "20.00",
"Adjustments": [],
"ReferenceNumbers": [
{
"ID": "AUTH000000",
"IDType": "Prior Authorization"
}
],
"Services": [
{
"ChargedAmount": "100.00",
"PaymentAmount": "65.00",
"ChargedUnits": null,
"PaymentUnits": null,
"AllowedAmount": "85.00",
"DeductibleAmount": null,
"SubmittedProcedure": {
"Code": "55454-3",
"CodeSet": "LOINC",
"Name": null,
"Modifiers": []
},
"AdjudicatedProcedure": {
"Code": "55454-3",
"CodeSet": "LOINC",
"Name": null,
"Modifiers": []
},
"ServiceDateTime": "2016-10-08T08:58:03.624Z",
"ServiceEndDateTime": "2016-10-08T14:58:03.263Z",
"ReferenceNumbers": []
}
]
}
},
{
"DateTime": "2016-11-08T02:11:03.111Z",
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "c221942d-a233-4303-bd56-1e0651e250c0 ",
"IDType": "EHRID"
},
{
"ID": "55fa85f7-5a3e-4406-bc0a-ba7da4058d40",
"IDType": "NIST
}
],
"Demographics": {
"FirstName": "Gammy",
"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": "+19089875301",
"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": []
},
"Claim": {
"Number": "93351100100",
"SubmissionNumber": null,
"ReceivedDate": "2016-10-31",
"ServiceDateTime": "2016-10-08T08:58:03.125Z",
"ServiceEndDateTime": "2016-10-11T14:58:03.532Z",
"Status": "Processed as Primary",
"ChargedAmount": "100.00",
"PaymentAmount": "75.00",
"PatientResponsibilityAmount": "20.00",
"Adjustments": [],
"ReferenceNumbers": [
{
"ID": "AUTH000000",
"IDType": "Prior Authorization"
}
],
"Services": [
{
"ChargedAmount": "100.00",
"PaymentAmount": "75.00",
"ChargedUnits": null,
"PaymentUnits": null,
"AllowedAmount": "95.00",
"DeductibleAmount": null,
"SubmittedProcedure": {
"Code": "99211",
"CodeSet": "LOINC",
"Name": null,
"Modifiers": []
},
"AdjudicatedProcedure": {
"Code": "99211",
"CodeSet": "LOINC",
"Name": null,
"Modifiers": []
},
"ServiceDateTime": "2016-10-08T08:58:03.624Z",
"ServiceEndDateTime": "2016-10-08T14:58:03.263Z",
"ReferenceNumbers": [
{
"ID": "1",
"IDType": "Control Number"
}
]
}
]
}
}
]
}