Cancel

Description

A Cancel message is typically generated when an appointment is canceled in an EHRb system. The VisitNumber, which identifies the appointment, is used as a reference in the message to indicate which appointment is being canceled.

API endpoints for Cancel

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/scheduling/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": "Scheduling",
      "EventType": "Cancel",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "bd679ac7-0597-4dc2-90cc-0306b74c38f9",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "442b8602-bd3a-4835-af5b-8a844cf454a2",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "62f97fef-8aa6-48e4-8b79-f17714b7dada",
            "AttemptID": "df01f61f-17b7-4b2d-aae8-3ecb2e62838c"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "5675ee31-d266-4dc4-96c8-dbd526b09935",
            "IDType": "EHRID"
         },
         {
            "ID": "76d94616-a6bf-43d5-9725-86f944558f64 ",
            "IDType": "NIST"
         }
      ],
      "Demographics": {
         "FirstName": "James",
         "MiddleName": "Alex",
         "LastName": "Smith",
         "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": "0987 High Street",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "53566",
            "County": "Santa Clara",
            "Country": "USA"
         }
      },
      "Notes": []
   },
   "AppointmentInfo": [
      {
         "Code": "23457",
         "Codeset": "EHR Codes",
         "Description": "Priority",
         "Value": "Normal"
      },
      {
         "Code": "23457",
         "Codeset": "EHR Codes",
         "Description": "Form",
         "Value": "Lumbar"
      }
   ],
   "Visit": {
      "VisitNumber": "1234",
      "AccountNumber": null,
      "VisitDateTime": "2022-08-16T14:21:21.680Z",
      "PatientClass": null,
      "Status": null,
      "Duration": 15,
      "Reason": "Check up",
      "CancelReason": "Conflicting appointment",
      "Type": null,
      "Instructions": [],
      "AttendingProvider": {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Bobby",
         "LastName": "Grant",
         "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
         }
      },
      "ConsultingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      },
      "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      },
      "VisitProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      },
      "Location": {
         "Type": "Inpatient",
         "Facility": "MGM Hospital",
         "Department": "3N",
         "Room": "136"
      },
      "AdditionalStaff": [],
      "Diagnoses": [
         {
            "Code": "R07.0",
            "Codeset": "ICD-10",
            "Name": "Throat Infection",
            "Type": null,
            "DocumentedDateTime": null
         }
      ],
      "Equipment": []
   }
}