Cancel

Description

A Referral Cancel message is generated to notify that a referral has been cancelled.

API endpoints for Cancel

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

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

Data Model JSON for Cancel

Cancel - Sample Payload

{
   "Meta": {
      "DataModel": "Referral",
      "EventType": "Cancel",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "ca4ad64a-0d77-4440-8cfc-c85d0e1a3ec2",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "89d84e59-846c-4c24-9f00-16679ee24dc3",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "6ffb9bc0-5344-46d7-9562-91e3a1c1b30d ",
            "AttemptID": "044f74e3-57e8-494d-91ef-4e10d63452cb"
         }
      ],
      "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": "091669ea-798a-4fca-a9a1-95fd0804ad40 ",
            "IDType": "EHRID"
         },
         {
            "ID": "c41c5796-f450-441e-947c-253aad64bc8c",
            "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": "+18089675301",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Language": "en",
         "Citizenship": [],
         "Address": {
            "StreetAddress": "2345 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": "+18088675303",
               "Office": "+17067543758",
               "Mobile": "+19186768865"
            },
            "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": "Gracy",
            "LastName": "marker"
         },
         "Address": {
            "StreetAddress": "4762 HIll 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": "+18067451121"
         }
      },
      "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
   }
}