Document Query

Description

The DocumentQuery is utilized to search one or more destinations for documents that match the provided search criteria. These documents can include Clinical Document Architecture (CDA), pr*ogress notes, PDFs, or any other binary data.

API endpoints for Document Query

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/clinical-summary/document-query.

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

Data Model JSON for Document Query

Document Query - Sample Payload

{
   "Meta": {
      "DataModel": "Clinical Summary",
      "EventType": "DocumentQuery",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Destinations": [
         {
            "ID": "8aaf6ebf-25d5-4da8-bb95-adf2ba9bec98",
            "Name": "Patient Query Endpoint"
         }
      ],
      "Logs": [
         {
            "ID": "717c4d69-4923-4e0b-81b2-c73bec9f5b7f ",
            "AttemptID": "6de656a1-777b-4e1b-8199-bc6e1e69684e"
         }
      ],
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "397a6b27-2dcf-470a-ad74-f142429cd4ca",
            "IDType": "EHRID"
         },
         {
            "ID": "1cdabbd8-5334-451b-97c9-18448c32025f",
            "IDType": "NIST"
         }
      ]
   },
   "Location": {
      "Department": null
   },
   "Visit": {
      "ID": "1442335",
      "StartDateTime": null,
      "EndDateTime": null
   },
   "Document": {
      "StartDate": null,
      "EndDate": null,
      "Types": [
         {
            "Code": "34133-9",
            "Codeset": "LOINC",
            "Name": "Continuity of Care Document"
         }
      ]
   }
}