Home
API reference
Redox Data Models
Notes
QueryResponse

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.

QueryResponse

Receive note file metadata and content, along with the related patient and visitor info, based on the query parameters defined in Notes.Query.

Remember that you won't receive provider info. To receive provider info with note details, we recommend listening for new notes with the Notes.New event type instead.

Beta
Data on Demand Enabled

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Notes

    • EventType
      required, string
      Reliable

      QueryResponse

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

  • Notes
    Array of object
    • Patient
      object
      • Identifiers
        Array of object

        List of IDs and ID types that identify the patient

        • ID
          string, null
          Reliable

          ID for the patient

        • IDType
          string, null
          Reliable

          Type of ID.
          E.g. MRN, EPI

    • Visit
      object
      • VisitNumber
        string, null
        Reliable

        Visit Number.
        A VisitNumber is highly recommended so that the document can be associated with a specific visit

    • ContentType
      string, null
      Reliable
      Value Set

      Describes the type of text provided in Note.FileContents.

    • FileContents
      string, null
      Probable

      Contains the content of the file. This should be a Blob URL if the file is referenced. Otherwise, this contains plain or rich text.
      Either plain text, RTF, or a Base64 encoded string

    • FileName
      string, null
      Probable

      Displays the name of the document.

    • DocumentType
      string, null
      Reliable

      Classifies the type of document (e.g., consent form, treatment plan).

    • DocumentID
      string, null
      Reliable

      Contains the unique identifier for this document. You must have the document ID to update the document later.
      This ID is required in order to update the document with Modify messages

    • ServiceDateTime
      string, null
      Reliable

      Displays the time of the clinical service that the document is related to. For example, for a surgical note, this would be the date/time of the surgery.

    • DocumentationDateTime
      string, null
      Reliable

      Displays the timestamp for when the document was finalized or created. For example, a surgeon may enter the surgical note contents after the surgery. This timestamp represents the time the note was saved.
      For example, a surgeon may enter the surgical note contents following the surgery. This is the field representing the time the note was saved.

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Notes",
4
    "EventType": "QueryResponse",
5
    "EventDateTime": "2024-11-20T14:08:29.777Z",
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
  "Notes": [
26
    {
27
      "Patient": {
28
        "Identifiers": [
29
          {
30
            "ID": "0000000001",
31
            "IDType": "MR"
32
          },
33
          {
34
            "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
35
            "IDType": "EHRID"
36
          },
37
          {
38
            "ID": "a1d4ee8aba494ca",
39
            "IDType": "NIST"
40
          }
41
        ]
42
      },
43
      "Visit": {
44
        "VisitNumber": "1234"
45
      },
46
      "ContentType": "Base64 Encoded",
47
      "FileContents": "JVBERi0xLjQKCjEgMCBvYmoKPDwKIC9UeXBlIC9DYXRhbG9nCiAvUGFnZXMgMiAwIFIKPj4KZW5kb2JqCgoyIDAgb2JqCjw8CiAvVHlwZSAvUGFnZXMKIC9LaWRzIFszIDAgUl0KIC9Db3VudCAxCj4+CmVuZG9iagoKMyAwIG9iago8PAogL1R5cGUgL1BhZ2UKIC9QYXJlbnQgMiAwIFIKIC9NZWRpYUJveCBbMCAwIDM1MCAyMDBdCiAvQ29udGVudHMgNCAwIFIKIC9SZXNvdXJjZXMgPDwKICAvUHJvY1NldCA1IDAgUgogIC9Gb250IDw8CiAgIC9GMSA2IDAgUgogID4+CiA+Pgo+PgplbmRvYmoKCjQgMCBvYmoKPDwgL0xlbmd0aCA3MyA+PgpzdHJlYW0KIEJUCiAgL0YxIDI0IFRmCiAgMTAwIDEwMCBUZAogIChIZWxsbyBmcm9tIFJlZG94KSBUagogRVQKZW5kc3RyZWFtCmVuZG9iagoKNSAwIG9iagogWy9QREYgL1RleHRdCmVuZG9iagoKNiAwIG9iago8PAogL1R5cGUgL0ZvbnQKIC9TdWJ0eXBlIC9UeXBlMQogL05hbWUgL0YxCiAvQmFzZUZvbnQgL0hlbHZldGljYQogL0VuY29kaW5nIC9NYWNSb21hbkVuY29kaW5nCj4+CmVuZG9iagoKeHJlZgowIDkKMDAwMDAwMDAwMCA2NTUzNSBmCjAwMDAwMDAwMDkgMDAwMDAgbgowMDAwMDAwMDc0IDAwMDAwIG4KMDAwMDAwMDEyMCAwMDAwMCBuCjAwMDAwMDAxNzkgMDAwMDAgbgowMDAwMDAwMzY0IDAwMDAwIG4KMDAwMDAwMDQ2NiAwMDAwMCBuCjAwMDAwMDA0OTYgMDAwMDAgbgoKdHJhaWxlcgo8PAovU2l6ZSA4Ci9Sb290IDEgMCBSCj4+CnN0YXJ0eHJlZgo2MjUKJSVFT0Y=",
48
      "FileName": "SamplePDF",
49
      "DocumentType": "Sample Clinical Note in PDF",
50
      "DocumentID": "e52180fb-75a2-41ea-9fcd-661a996de53f",
51
      "ServiceDateTime": "2015-05-06T06:00:58.872Z",
52
      "DocumentationDateTime": "2015-05-06T06:00:58.872Z"
53
    }
54
  ]
55
}