Cancel

Description

The Cancel message is an event type that indicates that a previously scheduled appointment has been canceled or deleted.It contains information such as the details of the canceled appointment (e.g., appointment time, location, provider), the reason for cancellation, and any relevant comments or notes related to the cancellation.

API endpoints for Cancel

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

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

Data Model JSON for Cancel

Cancel - Sample Payload

{
   "Visit": {
      "CancelReason": "Conflicting appointment",
      "VisitNumber": "1234",
      "AccountNumber": null,
      "VisitDateTime": null,
      "Status": null,
      "Duration": null,
      "PatientClass": null,
      "Notes": [],
      "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
         }
      },
      "Location": {
         "Type": "Inpatient",
         "Facility": "KEM Hospital",
         "Department": "3N",
         "Room": "136",
         "Bed": "B"
      },
      "Diagnoses": [
         {
            "Code": "R07.0",
            "Codeset": "ICD-10",
            "Name": "Throat infection",
            "Type": null,
            "DocumentedDateTime": null
         }
      ],
      "Equipment": []
   },
   "Meta": {
      "DataModel": "SurgicalScheduling",
      "EventType": "Cancel",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "92eb5b3f-7a46-4d7a-8ec5-47062e6a177d",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "733ea519-486f-4924-a39a-57eb32128fe7",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "dba2f777-9dd7-4dc3-98b1-412c2d194392",
            "AttemptID": "22a4b823-66dd-47f9-b136-38a5f8d4504e"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "1e7ed22f-7a52-49b9-baad-def2741e5de2",
            "IDType": "EHRID"
         },
         {
            "ID": "b8c324b5-ff80-4247-82db-e097770e0803",
            "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": "4762 Hill Street",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "53566",
            "County": "Santa Clara",
            "Country": "USA"
         }
      },
      "Notes": []
   },
   "Procedures": [
      {
         "Code": "6391",
         "Codeset": null,
         "Description": "Appendectomy",
         "DateTime": "2015-12-13T21:08:57.581Z",
         "Duration": 120,
         "ProcedureInfo": [
            {
               "Description": "Laterality",
               "Value": "unilateral left"
            }
         ]
      }
   ],
   "SurgeryStaff": [
      {
         "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
         },
         "Role": {
            "Code": "1.1",
            "Codeset": null,
            "Description": "Primary Surgeon"
         },
         "StartDateTime": "2015-12-13T21:08:57.581Z",
         "Duration": 120
      }
   ],
   "SurgicalInfo": [
      {
         "Code": "23457",
         "Codeset": "EHR Codes",
         "Description": "Priority",
         "Value": "Normal"
      },
      {
         "Code": "1535135",
         "Codeset": "EHR Codes",
         "Description": "Use Preference Cards",
         "Value": "Y"
      }
   ],
   "SurgicalCase": {
      "Number": null,
      "Status": null
   }
}