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.

VisitQuery

Query for the most recent visit summary for a given patient at the specified health system within the specified timeframe. Provide the patient's medical record number (MRN) and the health system's location ID.

Patient ID type

The ID type that corresponds to the MRN varies per health system. Work with your connection to determine which ID type to send.

If you don't already have a patient's MRN on file, query for it with the PatientSearch data model. For testing purposes, the Redox Health System is connected to the NIST Document Sharing Test Facility, which uses the NIST ID type for the MRN. The PatientSearch data model will return a NIST ID that you should use with PatientQuery.

Data on demand enabled

This event type is available with data on demand. Learn more about data on demand.

Beta

Data on Demand Enabled

Request Body Schema

Show Required Fields Only

Show Translation Fields

Meta
required, object
- DataModel
  required, string
  Reliable
  Clinical Summary
- EventType
  required, string
  Reliable
  VisitQuery
- 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)
Visit
object
- VisitNumber
  string, null
  Reliable
  ID for the patient visit/encounter. Either this or a timeframe is required to accurately locate a visit.
- StartDateTime
  string, null
  Reliable
  Beginning of the timeframe for which to request visit summaries. Either this or a visit number is required to accurately locate a visit.
  ISO 8601 Format
- EndDateTime
  string, null
  Probable
  End of the timeframe for which to request visit summaries.
  ISO 8601 Format

Example

json

1
{
2
  "Meta": {
3
    "DataModel": "Clinical Summary",
4
    "EventType": "VisitQuery",
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": "Visit 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": "a1d4ee8aba494ca",
29
        "IDType": "NIST"
30
      }
31
    ]
32
  },
33
  "Visit": {
34
    "VisitNumber": "4325235",
35
    "StartDateTime": "2005-02-21T00:00:00.000Z",
36
    "EndDateTime": null
37
  }
38
}

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.