Home
API reference
Redox Data Models
Clinical Summary
DocumentQueryResponse

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.

DocumentQueryResponse

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 Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Clinical Summary

    • EventType
      required, string
      Reliable

      DocumentQueryResponse

    • 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.

  • Documents
    required, Array of object
    • ID
      required, string
      Reliable

      Identifier for the document, this should be used to retrieve the documents.
      ISO 8601 Format

    • Location
      object
      • Department
        string, null
        Possible

        ID corresponding to the department that created the document.
        Scheduled to be deprecated in favor of Documents[].Author.Location.Department

    • Author
      object
      • ID
        string, null
        Possible

        ID of the Provider responsible for the document.
        This ID is often required for Inpatient Visits.

      • IDType
        string, null
        Possible

        ID type of the ID for the Provider responsible for the document

      • FirstName
        string, null
        Possible

        First name of the Provider responsible for the document

      • LastName
        string, null
        Possible

        Last name of the Provider responsible for the document

      • Credentials
        Array of string

        List of credentials for the Provider responsible for the document.
        e.g. MD, PhD

      • Address
        object

        Provider's address

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • EmailAddresses
        Array of string

        Provider's email address(es)

      • PhoneNumber
        object
        • Office
          string, null
          Possible

          Provider's office phone number.
          In E. 164 Format. (e.g. +16085551234)

      • Type
        string, null
        Possible
        Value Set

        The type of Provider responsible for the document

      • Location
        object

        Provider's location

        • Type
          string, null
          Possible

          Type of location.
          Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

        • Facility
          string, null
          Possible

          Facility.
          Example: Community Hospital

        • FacilityIdentifiers
          Array of object

          List of IDs specific to this facility

          • ID
            string, null
            Possible

            An ID specific to this facility

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Department
          string, null
          Possible

          Department

        • DepartmentIdentifiers
          Array of object

          List of IDs specific to this department

          • ID
            string, null
            Possible

            An ID specific to this department

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Room
          string, null
          Possible

          Room.
          Example: 136

    • Visit
      object
      • ID
        string, null
        Possible

        Which specific encounter the document was created for.

      • StartDateTime
        string, null
        Possible

        If the document was for a specific encounter, the date that visit occurred.
        ISO 8601 Format

      • EndDateTime
        string, null
        Possible

        If the document was for a specific encounter, this is the end date/time of the visit.
        ISO 8601 Format

    • DateTime
      string, null
      Possible

      Date the document was created.
      ISO 8601 Format

    • Locale
      string, null
      Reliable

      Indicates the language of the document.

    • Title
      string, null
      Reliable

      Lists the title of the document.

    • Type
      object

      Designates the type of document returned (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

    • FileType
      string, null
      Reliable

      Designates the file type of the document.

    • EntryType
      string, null
      Possible
      Value Set

      Distinguishes Stable DocumentEntries from On-Demand DocumentEntries

    • EntryStatus
      string, null
      Possible
      Value Set

      Designates the status of a document entry within the document registry.

  • Patient
    object
    • Identifiers
      Array of object

      List of IDs and IDTypes for the patient

      • ID
        string, null
        Reliable

        ID of the Patient

      • IDType
        string, null
        Reliable

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

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Clinical Summary",
4
    "EventType": "DocumentQueryResponse",
5
    "EventDateTime": "2024-11-18T21:23:08.746Z",
6
    "Test": true,
7
    "Source": {
8
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
9
      "Name": "Redox Dev Tools"
10
    },
11
    "Destinations": [
12
      {
13
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
14
        "Name": "Redox EMR"
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
  "Documents": [
42
    {
43
      "Location": {
44
        "Department": null
45
      },
46
      "Author": {
47
        "ID": "4356789876",
48
        "IDType": "NPI",
49
        "FirstName": "Pat",
50
        "LastName": "Granite",
51
        "Credentials": [
52
          "MD"
53
        ],
54
        "Address": {
55
          "StreetAddress": "123 Main St.",
56
          "City": "Madison",
57
          "State": "WI",
58
          "ZIP": "53703",
59
          "County": "Dane",
60
          "Country": "USA"
61
        },
62
        "EmailAddresses": [],
63
        "PhoneNumber": {
64
          "Office": "+16085551234"
65
        },
66
        "Type": null,
67
        "Location": {
68
          "Type": null,
69
          "Facility": null,
70
          "FacilityIdentifiers": [],
71
          "Department": null,
72
          "DepartmentIdentifiers": [],
73
          "Room": null
74
        }
75
      },
76
      "Visit": {
77
        "ID": "12345678",
78
        "StartDateTime": null,
79
        "EndDateTime": null
80
      },
81
      "DateTime": "2024-11-18T21:23:08.923Z",
82
      "ID": "123",
83
      "Locale": "US",
84
      "Title": "Discharge Summary",
85
      "Type": {
86
        "Code": "18842-5",
87
        "Codeset": "http://hl7.org/fhir/ValueSet/c80-doc-typecodes",
88
        "Name": "Discharge summary"
89
      },
90
      "FileType": null,
91
      "EntryType": null,
92
      "EntryStatus": null
93
    }
94
  ]
95
}