Skip to main content

Document Query Response

Description

The response to a DocumentQuery comprises an array of Documents that match the specified search criteria.

API endpoints for Document Query Response

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

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

Data Model JSON for Document Query Response​

Document Query Response - Sample Payload
{
   "Meta": {
      "DataModel": "Clinical Summary",
      "EventType": "DocumentQueryResponse",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "00d7ee0a-8277-4af5-8a6a-fac1a7a6ea56 ",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "8aaf6ebf-25d5-4da8-bb95-adf2ba9bec98",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "717c4d69-4923-4e0b-81b2-c73bec9f5b7f ",
            "AttemptID": "6de656a1-777b-4e1b-8199-bc6e1e69684e"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "397a6b27-2dcf-470a-ad74-f142429cd4ca",
            "IDType": "EHRID"
         },
         {
            "ID": "1cdabbd8-5334-451b-97c9-18448c32025f",
            "IDType": "NIST"
         }
      ]
   },
   "Documents": [
      {
         "Location": {
            "Department": null
         },
         "Author": {
            "ID": "4356789876",
            "IDType": "NPI",
            "FirstName": "Alex",
            "LastName": "Moon",
            "Credentials": [
               "MD"
            ],
            "Address": {
               "StreetAddress": "964 Main St.",
               "City": "San Jose",
               "State": "CA",
               "ZIP": "53703",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "EmailAddresses": [],
            "PhoneNumber": {
               "Office": "+16085551234"
            },
            "Type": null,
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            }
         },
         "Visit": {
            "ID": "12345678",
            "StartDateTime": null,
            "EndDateTime": null
         },
         "DateTime": "2022-08-16T14:21:21.291Z",
         "ID": "123",
         "Locale": "US",
         "Title": "Discharge Details Summary",
         "Type": {
            "Code": "18842-5",
            "Codeset": "http://hl7.org/fhir/ValueSet/c80-doc-typecodes",
            "Name": "Discharge Details summary"
         }
      }
   ]
}