Query

Description

The Query event type is used to search for notes in a patient's chart based on specified filter criteria such as patient, visit, or document information.The Query event type allows for efficient retrieval of notes and facilitates effective information retrieval and management in the healthcare setting.

API endpoints for Notes Query

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

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

Data Model JSON for Query

Query - Sample Payload

{
   "Meta": {
      "DataModel": "Notes",
      "EventType": "Query",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Destinations": [
         {
            "ID": "5457c1bb-fec9-41c8-abbc-a93cc47f13c1",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "ce8549a4-e941-4d4a-aa88-421c02ef26fe ",
            "AttemptID": "cc01ea84-95bf-412b-a8be-64dde522584c"
         }
      ],
      "FacilityCode": null
   },
   "Patients": [
      {
         "Identifiers": [
            {
               "ID": "0000000001",
               "IDType": "MR"
            },
            {
               "ID": "84cf8054-ad95-4d7d-a00d-02c9fb67fd6a",
               "IDType": "EHRID"
            },
            {
               "ID": "2dad8e31-b338-4822-b652-25cc807d5a0d",
               "IDType": "NIST"
            }
         ]
      }
   ],
   "VisitNumbers": [
      "1234",
      "5678"
   ],
   "DocumentTypes": [
      "Test Clinical Note in PDF",
      "Clinical Note"
   ],
   "DocumentIDs": [
      "a3837a66-ed49-441e-8b46-095c88f440da"
   ]
}