# Clinical Summary DocumentQueryResponse

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.

Receive a list documents in an array based on the query parameters defined in `DocumentQuery`. 

Use the `Documents[].ID` to request a specific document from the list with the `DocumentGet` event type. 

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Meta` | object | Yes |  |
| `Meta.DataModel` | string | Yes | Clinical Summary |
| `Meta.EventType` | string | Yes | DocumentQueryResponse |
| `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.* |
| `Documents` | Array of object | Yes |  |
| `Documents[].ID` | string | Yes | Identifier for the document, this should be used to retrieve the documents. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Documents[].Location` | object | No |  |
| `Documents[].Location.Department` | string or null | No | ID corresponding to the department that created the document. *Scheduled to be deprecated in favor of Documents[].Author.Location.Department* |
| `Documents[].Author` | object | No |  |
| `Documents[].Author.ID` | string or null | No | ID of the Provider responsible for the document. *This ID is often required for Inpatient Visits.* |
| `Documents[].Author.IDType` | string or null | No | ID type of the ID for the Provider responsible for the document |
| `Documents[].Author.FirstName` | string or null | No | First name of the Provider responsible for the document |
| `Documents[].Author.LastName` | string or null | No | Last name of the Provider responsible for the document |
| `Documents[].Author.Credentials` | Array of string | No | List of credentials for the Provider responsible for the document. *e.g. MD, PhD* |
| `Documents[].Author.Address` | object | No | Provider's address |
| `Documents[].Author.Address.StreetAddress` | string or null | No | Street address |
| `Documents[].Author.Address.City` | string or null | No | City |
| `Documents[].Author.Address.State` | string or null | No | State |
| `Documents[].Author.Address.ZIP` | string or null | No | ZIP |
| `Documents[].Author.Address.County` | string or null | No | County |
| `Documents[].Author.Address.Country` | string or null | No | Country. Value set 39791e31-0cee-4c58-a6c1-3d9e2c71d13b: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, IO, CM, CL, CO, CI, DK, EC, ER, FK, TF, GM, GI, GW, VA, IS, IM, JP, KI, LS, LT, MK, MV, MX, MS, NA, NC, MP, PK, PG, PL, RU, PM, SA, SG, SB, SS, SE, TZ, TO, TV, US, VN, EH, ZW, BQ, BR, BF, CA, TD, KM, CK, CU, DO, EE, FI, GE, GL, GN, GY, IN, IE, JE, KW, LB, LY, MO, ML, MR, MN, MM, NZ, NU, OM, PY, PT, RO, KN, SN, RS, ZA, LK, SJ, SY, TK, TM, UG, UM, UZ, WF, BA, BG, CV, CX, CD, CW, DJ, GQ, FO, PF, DE, GD, GG, HT, HK, IR, IL, KE, KG, LU, MY, MT, MU, ME, MZ, NP, NF, PW, PH, QA, BL, MF, ST, SX, SI, GS, SR, TJ, TG, TN, UA, VU, VG, BW, BN, KH, KY, CC, CR, CY, EG, FJ, FR, GH, GP, GU, HN, IQ, JM, KZ, KP, LA, LR, MW, MH, YT, MD, MA, NI, NG, NO, PA, PN, RE, RW, LC, SM, SC, SK, ES, CH, TH, TT, TR, GB, VE, VI, ZM, BV, BI, CF, CN, CG, HR, CZ, DM, SV, ET, GF, GA, GR, GT, HM, HU, ID, IT, JO, KR, LV, LI, MG, MQ, FM, MC, NR, NL, NE, PS, PE, PR, SH, VC, WS, SL, SO, SD, SZ, TW, TL, TC, AE, UY, YE, DR |
| `Documents[].Author.EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Documents[].Author.PhoneNumber` | object | No |  |
| `Documents[].Author.PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Documents[].Author.Type` | string or null | No | The type of Provider responsible for the document. Value set 34b5bdb4-1fed-4bdb-a26b-b21d58b0629e: Referred To Provider, Referring Provider, Patient PCP, Other |
| `Documents[].Author.Location` | object | No | Provider's location |
| `Documents[].Author.Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Documents[].Author.Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Documents[].Author.Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Documents[].Author.Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Documents[].Author.Location.FacilityIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Documents[].Author.Location.Department` | string or null | No | Department |
| `Documents[].Author.Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Documents[].Author.Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Documents[].Author.Location.DepartmentIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Documents[].Author.Location.Room` | string or null | No | Room. *Example: 136* |
| `Documents[].Visit` | object | No |  |
| `Documents[].Visit.ID` | string or null | No | Which specific encounter the document was created for. |
| `Documents[].Visit.StartDateTime` | string or null | No | If the document was for a specific encounter, the date that visit occurred. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Documents[].Visit.EndDateTime` | string or null | No | If the document was for a specific encounter, this is the end date/time of the visit. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Documents[].DateTime` | string or null | No | Date the document was created. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Documents[].Locale` | string or null | No | Indicates the language of the document. |
| `Documents[].Title` | string or null | No | Lists the title of the document. |
| `Documents[].Type` | object | No | Designates the type of document returned (e.g., CCD, progress note). |
| `Documents[].Type.Code` | string or null | No | Code for the type |
| `Documents[].Type.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)* |
| `Documents[].Type.Name` | string or null | No | Name of the type |
| `Documents[].FileType` | string or null | No | Designates the file type of the document. |
| `Documents[].EntryType` | string or null | No | Distinguishes Stable DocumentEntries from On-Demand DocumentEntries. Value set 087a5cc3-3c4f-4468-b5fb-dc654d1184f9: Stable, On-Demand |
| `Documents[].EntryStatus` | string or null | No | Designates the status of a document entry within the document registry. Value set 8c1dd535-7c7d-4056-9b44-b0e9ae74ae51: Approved, Deprecated |
| `Patient` | object | No |  |
| `Patient.Identifiers` | Array of object | No | List of IDs and IDTypes for the patient |
| `Patient.Identifiers[].ID` | string or null | No | ID of the Patient |
| `Patient.Identifiers[].IDType` | string or null | No | ID Type for the corresponding ID of this patient (ie. MRN, EHRID) |

## Example

```json
{
  "Meta": {
    "DataModel": "Clinical Summary",
    "EventType": "DocumentQueryResponse",
    "EventDateTime": "2026-11-13T22:05:58.042Z",
    "Test": true,
    "Source": {
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
      "Name": "Redox Dev Tools"
    },
    "Destinations": [
      {
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
        "Name": "Redox EMR"
      }
    ],
    "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"
      }
    ]
  },
  "Documents": [
    {
      "Location": {
        "Department": null
      },
      "Author": {
        "ID": "4356789876",
        "IDType": "NPI",
        "FirstName": "Pat",
        "LastName": "Granite",
        "Credentials": [
          "MD"
        ],
        "Address": {
          "StreetAddress": "123 Main St.",
          "City": "Madison",
          "State": "WI",
          "ZIP": "53703",
          "County": "Dane",
          "Country": "USA"
        },
        "EmailAddresses": [],
        "PhoneNumber": {
          "Office": "+16085551234"
        },
        "Type": null,
        "Location": {
          "Type": null,
          "Facility": null,
          "FacilityIdentifiers": [],
          "Department": null,
          "DepartmentIdentifiers": [],
          "Room": null
        }
      },
      "Visit": {
        "ID": "12345678",
        "StartDateTime": null,
        "EndDateTime": null
      },
      "DateTime": "2026-11-13T22:05:58.129Z",
      "ID": "123",
      "Locale": "US",
      "Title": "Discharge Summary",
      "Type": {
        "Code": "18842-5",
        "Codeset": "http://hl7.org/fhir/ValueSet/c80-doc-typecodes",
        "Name": "Discharge summary"
      },
      "FileType": null,
      "EntryType": null,
      "EntryStatus": null
    }
  ]
}
```