Modification

Description

The Modification message is an event type that signifies a change or update to an existing appointment in the EHR system. This message may be generated when there is a modification to the appointment details such as the appointment time, duration, provider, location, or other relevant information.

API endpoints for Modifications

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

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

Data Model JSON for Modification

Modification - Sample Payload

{
   "Meta": {
      "DataModel": "SurgicalScheduling",
      "EventType": "Modification",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "86898c4f-957c-427f-a84e-cbdcc7d4a860",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "c1c2fd24-683e-40bb-945e-83ef3ae86a95",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "9d20d041-f206-4ad3-9875-fe851b47abe8",
            "AttemptID": "6efe84e1-8b43-4d21-a2de-f7a9ab68d74e "
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "e99fbdb5-8259-447c-a498-050eb1a5289f",
            "IDType": "EHRID"
         },
         {
            "ID": "83ae0b1b-374c-49ad-ba02-d5791ee525a1",
            "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"
      }
   ],
   "Visit": {
      "VisitNumber": "1234",
      "AccountNumber": null,
      "VisitDateTime": null,
      "Status": null,
      "Duration": 30,
      "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": "MGM Hospital",
         "Department": "3N",
         "Room": "136",
         "Bed": "B"
      },
      "Diagnoses": [
         {
            "Code": "R07.0",
            "Codeset": "ICD-10",
            "Name":"Throat infection",
            "Type": null,
            "DocumentedDateTime": null
         }
      ],
      "Equipment": []
   },
   "SurgicalCase": {
      "Number": null,
      "Status": null
   }
}