Delete

Description

The Delete Notes message is used to request the deletion of a document that was previously added to a patient's chart. This message is typically triggered when a document is determined to be inaccurate, irrelevant, or no longer needed, and needs to be removed from the patient's record.

API endpoints for Notes Delete

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

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

Data Model JSON for Delete

Delete - Sample Payload

{
   "Meta": {
      "DataModel": "Notes",
      "EventType": "Delete",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "0d43d533-f836-4bb0-8fcf-37f546b68283 ",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "c86ab761-f544-461f-9629-d6bf502b40fd",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "4cdaf9ca-9f62-4f96-b8a2-6ffab105ce68",
            "AttemptID": "1cca7c9b-5590-4773-9986-87b557894ee9"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "b3fb27a8-5da6-486f-9fbe-fbc674996683 ",
            "IDType": "EHRID"
         },
         {
            "ID": "f0ce5838-c849-404e-956e-cbc6067bf7a6",
            "IDType": "NIST"
         }
      ],
      "Demographics": {
         "FirstName": "Ronnie",
         "MiddleName": "Patricks",
         "LastName": "Oliver",
         "DOB": "2008-01-06",
         "SSN": "101-01-0001",
         "Sex": "Male",
         "Race": "White",
         "IsHispanic": null,
         "Religion": null,
         "MaritalStatus": "Single",
         "IsDeceased": null,
         "DeathDateTime": null,
         "PhoneNumber": {
            "Home": "+19088675301",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Language": "en",
         "Citizenship": [],
         "Address": {
            "StreetAddress": "4762 Wallgate Street",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "53566",
            "County": "Santa Clara",
            "Country": "USA"
         }
      },
      "Notes": []
   },
   "Visit": {
      "VisitNumber": "1234",
      "AccountNumber": null,
      "PatientClass": null,
      "VisitDateTime": "2015-05-06T06:00:58.872Z",
      "Location": {
         "Type": null,
         "Facility": null,
         "Department": null,
         "Room": null,
         "Bed": null
      },
      "AdditionalStaff": []
   },
   "Note": {
      "ContentType": "Base64 Encoded",
      "FileName": "Sample-Order Note",
      "FileType": null,
      "DocumentType": "Test File",
      "DocumentID": "2a31d3f2-153a-4af5-aab4-6a3ef6ff8846",
      "DocumentDescription": null,
      "ServiceDateTime": "2015-05-06T06:00:58.872Z",
      "DocumentationDateTime": "2015-05-06T06:00:58.872Z",
      "Status": null,
      "Availability": "Unavailable",
      "Provider": {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Alex",
         "LastName": "Moon",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "234 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
         }
      },
      "Authenticator": {
         "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
         }
      },
      "Notifications": [
         {
            "ID": "2434534567",
            "IDType": "NPI",
            "FirstName": "Sahrib",
            "LastName": "Christo",
            "Credentials": [
               "MD",
               "PhD"
            ],
            "Address": {
               "StreetAddress": "312 Maple Dr. Suite 400",
               "City": "San Jose"",
               "State": "CA",
               "ZIP": "53593",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "EmailAddresses": [],
            "PhoneNumber": {
               "Office": "+16085559999"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            }
         },
         {
            "ID": "8263749385",
            "IDType": "NPI",
            "FirstName": "Jim",
            "LastName": "Mica",
            "Credentials": [
               "RN"
            ],
            "Address": {
               "StreetAddress": "5235 Kennedy Ave.",
               "City": "San Jose"",
               "State": "CA",
               "ZIP": "63141",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "EmailAddresses": [],
            "PhoneNumber": {
               "Office": "+13145097777"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            }
         }
      ],
      "Components": []
   },
   "Orders": [
      {
         "ID": 120956,
         "Name": "Stress Test"
      }
   ]
}