Skip to main content

Modify

description

A Referral Update message is generated to notify that a referral has been modified.

API endpoints for Modify

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/referral/modify.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Data Model JSON for Modify

Modify - Sample Payload
{
"Meta": {
"DataModel": "Referral",
"EventType": "Modify",
"EventDateTime": "2022-08-16T14:21:20.733Z",
"Test": true,
"Source": {
"ID": "110140e1-a703-4f32-98e0-1d61f226a29d ",
"Name": "EHR Bridge Dev Tools"
},
"Destinations": [
{
"ID": "346462a5-c503-4184-8bf5-afa6939ae010",
"Name": "Destinations EMR"
}
],
"Logs": [
{
"ID": "188db144-ef57-43cd-a09b-f79fdaf5f9f4",
"AttemptID": "32a06c62-78c3-45a4-9aac-3dc434f37558"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Referral": {
"ID": "4356789876",
"IDType": null,
"AlternateID": "2133311",
"Type": "Medical",
"Category": "Outpatient",
"Priority": "Routine",
"Status": "Pending",
"DateTime": "2015-05-05T00:00:00.000Z",
"ExpirationDateTime": "2015-06-05T00:00:00.000Z",
"ProcessDateTime": null,
"Reason": "Provider Ordered",
"ProviderSpecialty": null,
"DepartmentSpecialty": null,
"Notes": [],
"Authorization": {
"Plan": {
"ID": "31572",
"IDType": null,
"Name": "HMO Plan"
},
"Company": {
"ID": "60054",
"IDType": null,
"Name": "aetna (60054 0131)"
},
"DateTime": "2015-05-05T00:00:00.000Z",
"ExpirationDateTime": "2015-06-05T00:00:00.000Z",
"Number": "9140860055",
"ReimbursementLimit": null,
"RequestedTreatmentCount": null,
"RequestedTreatmentUnits": null,
"AuthorizedTreatmentCount": null,
"Notes": []
},
"Diagnoses": [],
"Procedures": [
{
"Code": "400500400",
"Codeset": "CPT4",
"Description": "Therapy Referral",
"Notes": [],
"Quantity": null,
"Units": null,
"Modifiers": []
}
],
"Providers": [
{
"ID": "4236464757",
"IDType": "NPI",
"FirstName": "John",
"LastName": "Marker",
"Credentials": [
"DO"
],
"Address": {
"StreetAddress": "500 First St.",
"City": "San Jose"",
"State": "CA",
"ZIP": "63105",
"County": "Santa Clara",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Type": "Referring Provider",
"ContactInfo": null,
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
}
],
"Visit": {
"VisitNumber": null
}
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "cb78bd34-9b8c-4976-973e-52ab0dbdf13b",
"IDType": "EHRID"
},
{
"ID": "be524dfe-2d7e-4db0-8145-fb4cd337b08f",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "John",
"MiddleName": "F",
"LastName": "Marker",
"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 Hill Street",
"City": "San Jose"",
"State": "CA",
"ZIP": "53566",
"County": "Santa Clara",
"Country": "USA"
}
},
"Notes": [],
"Contacts": [
{
"FirstName": "Gracy",
"MiddleName": null,
"LastName": "Marker",
"Address": {
"StreetAddress": "4762 Hill Street",
"City": "San Jose"",
"State": "CA",
"ZIP": "53566",
"County": "Santa Clara",
"Country": "USA"
},
"PhoneNumber": {
"Home": "+180889075303",
"Office": "+17907543758",
"Mobile": "+19189368865"
},
"RelationToPatient": "Mother",
"EmailAddresses": [
"gracy.marker@test.net"
],
"Roles": [
"Emergency Contact"
]
}
],
"Guarantor": {
"Number": "10001910",
"FirstName": "Kent",
"MiddleName": null,
"LastName": "Marker",
"SSN": null,
"DOB": null
"Sex": null,
"Spouse": {
"FirstName": "Barbara",
"LastName": "Jonas"
},
"Address": {
"StreetAddress": "4762 Markline Street",
"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": "Digitech Labs",
"Address": {
"StreetAddress": "1456 Old Hill Road",
"City": "San Jose"",
"State": "CA",
"ZIP": "53719",
"County": "Santa Clara",
"Country": "USA"
},
"PhoneNumber": "+18083451121"
}
},
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO 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": "Digitech 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
}
}
}
]
},
"Visit": {
"VisitNumber": null
}
}