Query

Description

The query allows retrieval of Media documents based on specific filter criteria. The response format is defined by the Media QueryResponse event type.

API endpoints for Media Query

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/media/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": "Media",
      "EventType": "Query",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Destinations": [
         {
            "ID": "1f2d73e9-1fd6-4c70-b26b-59626d845167 ",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "ec8f180c-451e-46d1-b042-bb03797b3fa2 ",
            "AttemptID": "f2f666c1-89ae-4eea-84f9-5e2230f0a9e3"
         }
      ],
      "FacilityCode": null
   },
   "Patients": [
      {
         "Identifiers": [
            {
               "ID": "0000000001",
               "IDType": "MR"
            },
            {
               "ID": "e3eb15c6-bed8-493a-bfb9-d26d0eb377dc",
               "IDType": "EHRID"
            },
            {
               "ID": "9456490d-ab28-4570-8d92-050f872b4766",
               "IDType": "NIST"
            }
         ]
      }
   ],
   "VisitNumbers": [
      "1234",
      "5678"
   ],
   "DocumentTypes": [
      "Sample Image",
      "Sample Image"
   ],
   "DocumentIDs": [
      "51b3ca42-cb3f-4502-83a7-586d2e2f7465"
   ]
}