Home
API reference
Redox Data Models
Notes
Query

Notes

This data model allows you to exchange plain text or rich text content with an EHR system. This is helpful if you want to display content in the EHR context with advanced text parsing capabilities (e.g., NLP, searching of the chart).

This is typically non-structured documentation about a patient's clinical care. Notes can summarize actions taken in third-party apps and provide context for the patient's chart in the EHR system. Alternatively, notes created in the EHR system may be sent outbound to apps for reference or analysis.

​You can also send files or documents with the Media and Results data models. Learn how to send a file with different data models.

This data model has event types that allow you to:

  • save, replace, or delete a note document; or
  • query for and receive note documents.

Query

Query for notes by defining the search criteria. Results are returned in Notes.QueryReponse.

Beta
Data on Demand Enabled

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Notes

    • EventType
      required, string
      Reliable

      Query

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

  • Patients
    Array of object

    Array of patients to filter results on.
    If multiple patients are provided, notes associated with any of the patients will be returned.

    • Identifiers
      Array of object

      List of IDs and ID types that identify the patient.
      If multiple identifiers are provided, only patients with all identifiers will be considered.

      • ID
        string, null
        Reliable

        ID of the Patient

      • IDType
        string, null
        Reliable

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

  • VisitNumbers
    Array of string

    Array of patient visits to query on.
    If multiple visits are provided, notes associated with any of the patient visits will be returned.

  • DocumentTypes
    Array of string

    Array of document types to query on.
    The type of note to retrieve (E.g. Consent Form, Treatment Plan)

  • DocumentIDs
    Array of string

    Array of a document identifier to query.

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Notes",
4
    "EventType": "Query",
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
  "Patients": [
26
    {
27
      "Identifiers": [
28
        {
29
          "ID": "0000000001",
30
          "IDType": "MR"
31
        },
32
        {
33
          "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
34
          "IDType": "EHRID"
35
        },
36
        {
37
          "ID": "a1d4ee8aba494ca",
38
          "IDType": "NIST"
39
        }
40
      ]
41
    }
42
  ],
43
  "VisitNumbers": [
44
    "1234",
45
    "5678"
46
  ],
47
  "DocumentTypes": [
48
    "Sample Clinical Note in PDF",
49
    "Clinical Note"
50
  ],
51
  "DocumentIDs": [
52
    "b169923c-42g9-4fe3-91hg-8ckf1094e90l"
53
  ]
54
}