Skip to main content

Replace

Description

The Replace Note message is utilized to update or replace a document that was previously added to a patient's chart. This message allows for modifications or corrections to existing notes, such as correcting errors, updating information, or replacing outdated documents. The Replace Note message typically includes the necessary identifying information, such as patient and document identifiers, along with the updated or replacement note content.

API endpoints for Notes Replace

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

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

Data Model JSON for Replace​

Replace - Sample Payload
{
   "Meta": {
      "DataModel": "Notes",
      "EventType": "Replace",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "f24ada51-5d50-4301-927b-42cce47fca89",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "6c778964-1d21-4b39-9cc2-e5cda1ecdb2c ",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "7b4d4bf6-e588-43e7-8a23-1a8f58110355 ",
            "AttemptID": "d09176b2-a8d9-4549-9611-9ffb439a27ab "
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "de1e9b9b-1ab0-4ecc-868f-5837267164b3",
            "IDType": "EHRID"
         },
         {
            "ID": "77fda0ac-85fc-4953-a07c-6a7777c23240 ",
            "IDType": "NIST"
         }
      ],
      "Demographics": {
         "FirstName": "Jordan",
         "MiddleName": "Daniel",
         "LastName": "Halls",
         "DOB": "2008-01-06",
         "SSN": "101-01-0001",
         "Sex": "Male",
         "Race": "White",
         "IsHispanic": null,
         "Religion": null,
         "MaritalStatus": "Single",
         "IsDeceased": null,
         "DeathDateTime": null,
         "PhoneNumber": {
            "Home": "+18088905301",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Language": "en",
         "Citizenship": [],
         "Address": {
            "StreetAddress": "4762 Walkway Harbour",
            "City": "San Jose",
            "State": "CA",
            "ZIP": "53566",
            "County": "Santa Clara",
            "Country": "USA"
         }
      },
      "Notes": []
   },
   "Visit": {
      "VisitNumber": "5432",
      "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",
      "FileContents": "<...base 64 file contents...>",
      "FileName": "SamplePDF-Order Note",
      "FileType": null,
      "DocumentType": "Test File",
      "OriginalDocumentID": "e82ab8c6-2768-4c6c-b500-5b03a5049961 ",
      "DocumentID": "a2e66993-bc06-4d3b-8c70-3cd3b743c0c3",
      "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": "James",
         "LastName": "Smith",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Hower St.",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "09876",
            "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": "Shanon",
            "LastName": "Patricks",
            "Credentials": [
               "MD",
               "PhD"
            ],
            "Address": {
               "StreetAddress": "456 Doentown 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": "Alwin",
            "LastName": "Presley",
            "Credentials": [
               "RN"
            ],
            "Address": {
               "StreetAddress": "7865 Mapple Ave.",
               "City": "San Jose"",
               "State": "CA",
               "ZIP": "63141",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "EmailAddresses": [],
            "PhoneNumber": {
               "Office": "+13145557777"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            }
         }
      ],
      "Components": []
   },
   "Orders": [
      {
         "ID": 123456,
         "Name": "Daily Stress Test"
      }
   ]
}