Query Response

Description

This is the response format for a Notes Query.

API endpoints for Notes Query Response

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

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

Data Model JSON for Query Response

Query Response - Sample Payload

{
   "Meta": {
      "DataModel": "Notes",
      "EventType": "QueryResponse",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "3d2f053e-7e7f-4a68-8ff2-7ce80731d0d9",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "5457c1bb-fec9-41c8-abbc-a93cc47f13c1",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "ce8549a4-e941-4d4a-aa88-421c02ef26fe ",
            "AttemptID": "cc01ea84-95bf-412b-a8be-64dde522584c"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Notes": [
      {
         "Patient": {
            "Identifiers": [
               {
                  "ID": "0000000001",
                  "IDType": "MR"
               },
               {
                  "ID": "84cf8054-ad95-4d7d-a00d-02c9fb67fd6a",
               "IDType": "EHRID"
            },
            {
               "ID": "2dad8e31-b338-4822-b652-25cc807d5a0d",
               "IDType": "NIST"
               }
            ]
         },
         "Visit": {
            "VisitNumber": "1234"
         },
         "ContentType": "Base64 Encoded",
         "FileContents": "JVBERi0xLjQKCjEgMCBvYmoKPDwKIC9UeXBlIC9DYXRhbG9nCiAvUGFnZXMgMiAwIFIKPj4KZW5kb2JqCgoyIDAgb2JqCjw8CiAvVHlwZSAvUGFnZXMKIC9LaWRzIFszIDAgUl0KIC9Db3VudCAxCj4+CmVuZG9iagoKMyAwIG9iago8PAogL1R5cGUgL1BhZ2UKIC9QYXJlbnQgMiAwIFIKIC9NZWRpYUJveCBbMCAwIDM1MCAyMDBdCiAvQ29udGVudHMgNCAwIFIKIC9SZXNvdXJjZXMgPDwKICAvUHJvY1NldCA1IDAgUgogIC9Gb250IDw8CiAgIC9GMSA2IDAgUgogID4+CiA+Pgo+PgplbmRvYmoKCjQgMCBvYmoKPDwgL0xlbmd0aCA3MyA+PgpzdHJlYW0KIEJUCiAgL0YxIDI0IFRmCiAgMTAwIDEwMCBUZAogIChIZWxsbyBmcm9tIFJlZG94KSBUagogRVQKZW5kc3RyZWFtCmVuZG9iagoKNSAwIG9iagogWy9QREYgL1RleHRdCmVuZG9iagoKNiAwIG9iago8PAogL1R5cGUgL0ZvbnQKIC9TdWJ0eXBlIC9UeXBlMQogL05hbWUgL0YxCiAvQmFzZUZvbnQgL0hlbHZldGljYQogL0VuY29kaW5nIC9NYWNSb21hbkVuY29kaW5nCj4+CmVuZG9iagoKeHJlZgowIDkKMDAwMDAwMDAwMCA2NTUzNSBmCjAwMDAwMDAwMDkgMDAwMDAgbgowMDAwMDAwMDc0IDAwMDAwIG4KMDAwMDAwMDEyMCAwMDAwMCBuCjAwMDAwMDAxNzkgMDAwMDAgbgowMDAwMDAwMzY0IDAwMDAwIG4KMDAwMDAwMDQ2NiAwMDAwMCBuCjAwMDAwMDA0OTYgMDAwMDAgbgoKdHJhaWxlcgo8PAovU2l6ZSA4Ci9Sb290IDEgMCBSCj4+CnN0YXJ0eHJlZgo2MjUKJSVFT0Y=",
         "FileName": "SamplePDF",
         "DocumentType": "Clinical Notes PDF",
         "DocumentID": "e52180fb-75a2-41ea-9fcd-661a996de53f",
         "ServiceDateTime": "2015-05-06T06:00:58.872Z",
         "DocumentationDateTime": "2015-05-06T06:00:58.872Z"
      }
   ]
}