Home
API reference
Redox Data Models
Clinical Summary
DocumentQuery

Clinical Summary

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

A clinical summary 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.

DocumentQuery

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 to get you the latest content.

Data on Demand Enabled

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Clinical Summary

    • EventType
      required, string
      Reliable

      DocumentQuery

    • EventDateTime
      string, null
      Reliable

      Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
      ISO 8601 Format

    • Test
      boolean, null
      Reliable

      Indicates whether the request is a test or not.

    • Source
      object

      Contains the information for the system initiating the message, including the source ID and name.
      Included in messages from Redox

      • ID
        string, null
        Reliable

        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

      • Name
        string, null
        Reliable

        Displays the name of the system initiating the message.

    • Destinations
      Array of object

      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.

      • ID
        string, null
        Reliable

        Identifies the endpoint that the request is directed to.
        UUID

      • Name
        string, null
        Reliable

        Displays the name of the endpoint that the request is directed to.

    • Logs
      Array of object

      Contains the log identifier(s) for the request.

      • ID
        string, null
        Reliable

        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

      • AttemptID
        string, null
        Reliable

        Identifies the request log attempt value, which is useful when retries are possible.
        UUID

    • FacilityCode
      string, null
      Possible

      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
    required, object
    • Identifiers
      required, Array of object

      List of IDs and IDTypes for the patient

      • ID
        required, string
        Reliable

        ID of the Patient

      • IDType
        required, string
        Reliable

        ID Type for the corresponding ID of this patient (ie. MRN, EHRID)

  • Location
    object
    • Department
      string, null
      Possible

      ID corresponding to the department from which to retrieved the patient chart.
      This field is required for some EHRs.

  • Visit
    object
    • ID
      string, null
      Possible

      Include this to only return documents from a specific encounter.

    • StartDateTime
      string, null
      Possible

      Include this to only return documents from encounters that occurred within a specific time range.
      ISO 8601 Format

    • EndDateTime
      string, null
      Possible

      Include this to only return documents from encounters that occurred within a specific time range.
      ISO 8601 Format

  • Document
    object
    • StartDate
      string, null
      Possible

      Starting point for where documents should be searched.
      This usually corresponds to the date the document was created. ISO 8601 Format

    • EndDate
      string, null
      Possible

      Ending point for where documents should be searched.
      This usually corresponds to the date the document was created. ISO 8601 Format

    • Types
      Array of object

      Designates the type of document to search for (e.g., CCD, progress note).

      • Code
        string, null
        Possible

        Code for the type

      • Codeset
        string, null
        Possible

        Code set used to identify the type.
        LOINC Document Type

      • Name
        string, null
        Possible

        Name of the type

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Clinical Summary",
4
    "EventType": "DocumentQuery",
5
    "EventDateTime": "2024-12-20T18:11:36.537Z",
6
    "Test": true,
7
    "Source": {
8
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
9
      "Name": "Redox Dev Tools"
10
    },
11
    "Destinations": [
12
      {
13
        "ID": "ef9e7448-7f65-4432-aa96-059647e9b357",
14
        "Name": "Patient Query Endpoint"
15
      }
16
    ],
17
    "Logs": [
18
      {
19
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
20
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
21
      }
22
    ],
23
    "FacilityCode": null
24
  },
25
  "Patient": {
26
    "Identifiers": [
27
      {
28
        "ID": "0000000001",
29
        "IDType": "MR"
30
      },
31
      {
32
        "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
33
        "IDType": "EHRID"
34
      },
35
      {
36
        "ID": "a1d4ee8aba494ca",
37
        "IDType": "NIST"
38
      }
39
    ]
40
  },
41
  "Location": {
42
    "Department": null
43
  },
44
  "Visit": {
45
    "ID": "1222335",
46
    "StartDateTime": null,
47
    "EndDateTime": null
48
  },
49
  "Document": {
50
    "StartDate": null,
51
    "EndDate": null,
52
    "Types": [
53
      {
54
        "Code": "34133-9",
55
        "Codeset": "LOINC",
56
        "Name": "Continuity of Care Document"
57
      }
58
    ]
59
  }
60
}