# Clinical Summary DocumentQuery

This data model provides a snapshot of the patient's chart at a moment in time. 

A <u>clinical summary</u> is useful if you need a patient's clinical information, whether historical or current. Our data model is based on Clinical Document Architecture (CDA) formatted documents, which focuses on different aspects of the patient's chart (e.g., allergies, immunizations, medications). We map any CDA document type to this data model. The most common is the Continuity of Care Document (CCD).

It may take up to 15 seconds to receive a response from the EHR system when querying for a clinical summary, depending on how long it takes the EHR system to generate a CCD.

This data model has event types that allow you to:

- query for patient, visit, and document summaries;
- receive patient, visit, and document summaries;
- push patient or visit summaries; or
- query for and receive a specific document.

Search one or more destinations for documents matching a given set of search criteria. 

The available document types are typically CDA documents (e.g., CCD or Progress Note), but may also include a PDF or other binary data. 

`DocumentQuery` provides a higher level granularity for searching documents. Most of the time, it's enough to[ run `PatientQuery`](https://developer.redoxengine.com/data-models/ClinicalSummary.html#PatientQuery) to get you the latest content.

Status: Data on demand

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Meta` | object | Yes |  |
| `Meta.DataModel` | string | Yes | Clinical Summary |
| `Meta.EventType` | string | Yes | DocumentQuery |
| `Meta.EventDateTime` | string or null | No | Displays the UTC date and time that an outgoing request is delivered or an incoming request is received. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Meta.Test` | boolean or null | No | Indicates whether the request is a test or not. |
| `Meta.Source` | object | No | Contains the information for the system initiating the message, including the source ID and name. *Included in messages from Redox* |
| `Meta.Source.ID` | string or null | No | Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional. *UUID* |
| `Meta.Source.Name` | string or null | No | Displays the name of the system initiating the message. |
| `Meta.Destinations` | Array of object | No | Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination. *Required when sending data to Redox.* |
| `Meta.Destinations[].ID` | string or null | No | Identifies the endpoint that the request is directed to. *UUID* |
| `Meta.Destinations[].Name` | string or null | No | Displays the name of the endpoint that the request is directed to. |
| `Meta.Logs` | Array of object | No | Contains the log identifier(s) for the request. |
| `Meta.Logs[].ID` | string or null | No | Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference. *UUID* |
| `Meta.Logs[].AttemptID` | string or null | No | Identifies the request log attempt value, which is useful when retries are possible. *UUID* |
| `Meta.FacilityCode` | string or null | No | Code for the facility related to the message. *Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.* |
| `Patient` | object | Yes |  |
| `Patient.Identifiers` | Array of object | Yes | List of IDs and IDTypes for the patient |
| `Patient.Identifiers[].ID` | string | Yes | ID of the Patient |
| `Patient.Identifiers[].IDType` | string | Yes | ID Type for the corresponding ID of this patient (ie. MRN, EHRID) |
| `Location` | object | No |  |
| `Location.Department` | string or null | No | ID corresponding to the department from which to retrieved the patient chart. *This field is required for some EHRs.* |
| `Visit` | object | No |  |
| `Visit.ID` | string or null | No | Include this to only return documents from a specific encounter. |
| `Visit.StartDateTime` | string or null | No | Include this to only return documents from encounters that occurred within a specific time range. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Visit.EndDateTime` | string or null | No | Include this to only return documents from encounters that occurred within a specific time range. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Document` | object | No |  |
| `Document.StartDate` | string or null | No | Starting point for where documents should be searched. *This usually corresponds to the date the document was created. [ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Document.EndDate` | string or null | No | Ending point for where documents should be searched. *This usually corresponds to the date the document was created. [ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Document.Types` | Array of object | No | Designates the type of document to search for (e.g., CCD, progress note). |
| `Document.Types[].Code` | string or null | No | Code for the type |
| `Document.Types[].Codeset` | string or null | No | Code set used to identify the type. *[LOINC Document Type](http://hl7.org/fhir/R4/valueset-c80-doc-typecodes.html)* |
| `Document.Types[].Name` | string or null | No | Name of the type |

## Example

```json
{
  "Meta": {
    "DataModel": "Clinical Summary",
    "EventType": "DocumentQuery",
    "EventDateTime": "2026-11-13T22:05:58.042Z",
    "Test": true,
    "Source": {
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
      "Name": "Redox Dev Tools"
    },
    "Destinations": [
      {
        "ID": "ef9e7448-7f65-4432-aa96-059647e9b357",
        "Name": "Patient Query Endpoint"
      }
    ],
    "Logs": [
      {
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
      }
    ],
    "FacilityCode": null
  },
  "Patient": {
    "Identifiers": [
      {
        "ID": "0000000001",
        "IDType": "MR"
      },
      {
        "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
        "IDType": "EHRID"
      },
      {
        "ID": "a1d4ee8aba494ca",
        "IDType": "NIST"
      }
    ]
  },
  "Location": {
    "Department": null
  },
  "Visit": {
    "ID": "1222335",
    "StartDateTime": null,
    "EndDateTime": null
  },
  "Document": {
    "StartDate": null,
    "EndDate": null,
    "Types": [
      {
        "Code": "34133-9",
        "Codeset": "LOINC",
        "Name": "Continuity of Care Document"
      }
    ]
  }
}
```