Skip to main content

Replace

Description

The Replace Media message is utilized to update or replace a document that has been previously added to the patient's chart.

API endpoints for Replave media

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/media/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": "Media",
      "EventType": "Replace",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "19b5d852-8e3f-4eba-9cd7-ce39e7488e5f",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "0bac9f56-4454-4c49-a5a0-5dd7070c2957",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "ba292efe-08c0-46db-b66b-b185c762b442",
            "AttemptID": "491e60d5-68a6-4fec-9dea-ae4615f84a6e"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "320524b8-bde3-4fd4-818d-2998c9c12f4e",
            "IDType": "EHRID"
         },
         {
            "ID": "e73a88c5-f854-4e76-a927-918a4a3ffc26",
            "IDType": "NIST"
         }
      ],
      "Demographics": {
         "FirstName": "Timothy",
         "MiddleName": "Paul",
         "LastName": "Bixby",
         "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 Hickory Street",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "53566",
            "County": "Santa Clara",
            "Country": "USA"
         }
      },
      "Notes": []
   },
   "Visit": {
      "VisitNumber": "1234",
      "AccountNumber": null,
      "Location": {
         "Type": null,
         "Facility": null,
         "Department": null,
         "Room": null,
         "Bed": null
      }
   },
   "Media": {
      "FileType": "PDF",
      "FileName": "SamplePDF",
      "FileContents": "<...base 64 file contents...>",
      "DocumentType": "Empty File",
      "OriginalDocumentID": "b4e3b635-7ad6-42e0-b48d-a74ed41ba122",
      "DocumentID": "b169267c-10c9-4fe3-91ae-9ckf5703e90l",
      "DocumentDescription": null,
      "CreationDateTime": "2017-06-22T19:30:04.387Z",
      "ServiceDateTime": "2017-06-22T17:00:00.387Z",
      "DirectAddressFrom": "pat.willis@ehrbridge.com",
      "DirectAddressTo": "john.aker@ehrbridge.com",
      "Provider": {
         "ID": "4357689876",
         "IDType": "NPI",
         "FirstName": "James",
         "LastName": "Smith",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "San Jose",
            "State": "CA",
            "ZIP": "53703",
            "County": "Santa Clara",
            "Country": "USA"
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": "+16084451234"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      },
      "Authenticated": "False",
      "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
         }
      },
      "Availability": "Unavailable",
      "Notifications": [
         {
            "ID": "2477534567",
            "IDType": "NPI",
            "FirstName": "Sharonie",
            "LastName": "Chalker",
            "Credentials": [
               "MD",
               "PhD"
            ],
            "Address": {
               "StreetAddress": "312 Maplewood 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": "8263949385",
            "IDType": "NPI",
            "FirstName": "Jim",
            "LastName": "Mica",
            "Credentials": [
               "RN"
            ],
            "Address": {
               "StreetAddress": "5235 Kennedy ArcView .",
               "City": "San Jose"",
               "State": "CA",
               "ZIP": "98765",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "EmailAddresses": [],
            "PhoneNumber": {
               "Office": "+13145557777"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            }
         }
      ]
   },
   "Orders": []
}