Skip to main content

Document Get Response

Description

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

API Endpoints for Document Get Response

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

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

Data Model JSON for Document Get Response​

Document Get Response - Sample Payload
{
   "Meta": {
      "DataModel": "Clinical Summary",
      "EventType": "DocumentGetResponse",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "ab2a2f1e-cddb-452c-a46f-c377ed1692ec ",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "527f7382-4c40-43c1-8b57-751d61b5ee28",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "5898b1c8-e76f-4f6b-b9b0-d034fc48bdbe",
            "AttemptID": "4a7aa108-d89b-492a-98c2-c94132f73892 "
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 86547
      },
      "FacilityCode": null
   },
   "Document": {
      "ID": "299"
   },
   "FileType": "text/xml",
   "Data": "<!-- CDA Content -->"
}