New

Description

A New event type is used to trigger a message when a new note or document is added to the patient's chart. This event type can contain the actual note content, along with related patient, visit, and provider information.

API endpoints for New Notes

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

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

Data Model JSON for New

New - Sample Payload

{
   "Meta": {
      "DataModel": "Notes",
      "EventType": "New",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "2a31d3f2-153a-4af5-aab4-6a3ef6ff8846 ",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "3121a0ff-24de-42c5-a6a6-f0133471c523",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "1a48ce44-8c36-4a34-bb2c-aa20c4fb0f26 ",
            "AttemptID": "5dd53647-3820-45e0-af5f-89cfd99f4c55"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "45fa0c53-dd37-4bd7-9068-5c3f0c0646fa",
            "IDType": "EHRID"
         },
         {
            "ID": "47ddc569-ef36-44fd-a425-e25b13be6564",
            "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": "+16588675301",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Language": "en",
         "Citizenship": [],
         "Address": {
            "StreetAddress": "4762 Wallgate Avenue",
            "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",
      "FileContents": "<...base 64 file contents...>",
      "FileName": "Sample-Order Note",
      "FileType": null,
      "DocumentType": "Empty File",
      "DocumentID": "778485e1-05df-4030-932a-eca4b5cdc2ab",
      "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": "287 Main Stand St.",
            "City": "San Jose",
            "State": "CA",
            "ZIP": "53703",
            "County": "Santa Clara",
            "Country": "USA"
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": "+16087651234"
         },
         "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": "Mark",
            "LastName": "Smith",
            "Credentials": [
               "MD",
               "PhD"
            ],
            "Address": {
               "StreetAddress": "312 MapleWood Neon 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": "Jazz",
            "LastName": "Pingress",
            "Credentials": [
               "RN"
            ],
            "Address": {
               "StreetAddress": "5235 Backroad 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": "Stress Test"
      }
   ]
}