Transaction
Description
A Transaction event is generated when a new charge is posted to a patient's account. This event typically captures details such as the type of charge, the amount, the date, and any relevant billing or coding information associated with the charge.This event can be used to communicate and update the patient's account information within a healthcare system or between different entities involved in the billing and reimbursement process, such as a hospital, clinic, or insurance provider.
API endpoints for Transaction
Sync REST API Endpoint to call the API:https://{base_url}/api/v1/financial/transaction.
Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.
Data Model JSON for Transaction
Transaction - Sample Payload
{
"Meta": {
"DataModel": "Financial",
"EventType": "Transaction",
"EventDateTime": "2022-08-16T14:21:20.733Z",
"Test": true,
"Source": {
"ID": "ed11269b-adba-41f8-bee9-4deffc7b5645",
"Name": "EHR Bridge Dev Tools"
},
"Destinations": [
{
"ID": "efd0d715-d58f-49c6-af47-5d7368d9d554",
"Name": "Destinations EMR"
}
],
"Logs": [
{
"ID": "d7e370e8-e9df-4a67-af97-4c004d6c56f9",
"AttemptID": "ee48ced9-f108-42f3-8c92-f903b73e53ee"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "930d129c-c04c-44f6-afaf-623a83b4fb1a",
"IDType": "EHRID"
},
{
"ID": "2b8ff675-1714-4a07-9e17-2684b8152214",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Ronnie",
"MiddleName": "Patricks",
"LastName": "Olives",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+19088675301",
"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": []
},
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"VisitDateTime": "2015-05-23T00:00:00.000Z",
"Location": {
"Type": "Inpatient",
"Facility": "KEM Hospital",
"Department": "3N",
"Room": "136",
"Bed": "B",
"Address": {
"StreetAddress": "1767 Collin St.",
"City": "San Jose",
"State": "CA",
"ZIP": "53719",
"County": "Santa Clara",
"Country": "USA"
}
},
"Guarantor": {
"Number": "10001910",
"FirstName": "Alena",
"MiddleName": null,
"LastName": "Byhall",
"SSN": null,
"DOB": null,
"Sex": null,
"Spouse": {
"FirstName": "Nicky",
"LastName": "Byhall"
},
"Address": {
"StreetAddress": "3456 Wallgate Avenue",
"City": "San Jose"",
"State": "CA",
"ZIP": "53566",
"County": "Santa Clara",
"Country": "USA"
},
"PhoneNumber": {
"Home": null,
"Business": null,
"Mobile": null
},
"EmailAddresses": [],
"Type": null,
"RelationToPatient": "Father",
"Employer": {
"Name": "Public DigiLabs",
"Address": {
"StreetAddress": "1456 Old Sand Road",
"City": "San Jose",
"State": "CA",
"ZIP": "53719",
"County": "Santa Clara",
"Country": "USA"
},
"PhoneNumber": "+19083451121"
}
},
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Deductible Plan",
"Type": null
},
"MemberNumber": null,
"Company": {
"ID": "60054",
"IDType": null,
"Name": "aetna (60054 0131)",
"Address": {
"StreetAddress": "PO Box 14080",
"City": "San Jose"",
"State": "CA",
"ZIP": "40512-4079",
"County": "Santa Clara",
"Country": "USA"
},
"PhoneNumber": "+18089541123"
},
"GroupNumber": "847025-024-0009",
"GroupName": "Fine Labs",
"EffectiveDate": "2015-01-01",
"ExpirationDate": "2020-12-31",
"PolicyNumber": "9140860055",
"Priority": null,
"AgreementType": null,
"CoverageType": null,
"Insured": {
"Identifiers": [],
"LastName": null,
"MiddleName": null,
"FirstName": null,
"SSN": null,
"Relationship": null,
"DOB": null,
"Sex": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
}
}
}
]
},
"Transactions": [
{
"ID": "13213259164838",
"Type": "Charge",
"DateTimeOfService": "2015-05-23T00:00:00.000Z",
"EndDateTime": null,
"Chargeable": {
"Code": "12442124",
"Codeset": "DS HealthSystemChargeables",
"Description": "BIOPSY-SKIN",
"Quantity": null,
"Amount": null
},
"Department": {
"Code": "RES3N",
"Codeset": "DeptID",
"Name": "KEM Hospital - 3N"
},
"Diagnoses": [
{
"Code": "C43.4",
"Codeset": "ICD-10",
"Name": "Malignant melanoma of scalp and neck",
"Type": null,
"DocumentedDateTime": null
}
],
"Performers": [
{
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Larry",
"LastName": "Paul",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "San Jose",
"State": "CA",
"ZIP": "53703",
"County": "Santa Clara",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
}
],
"OrderingProviders": [
{
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "James",
"LastName": "Smith",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "San Jose",
"State": "CA",
"ZIP": "53703",
"County": "Santa Clara",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
}
],
"OrderID": null,
"Procedure": {
"Code": "11100",
"Codeset": "CPT",
"Description": "Biopsy of skin",
"Modifiers": []
},
"NDC": {
"Code": null,
"Description": null
}
}
]
}