# Notes QueryResponse

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](https://docs.redoxengine.com/permalink/P64iPMZngDZE2ggTAL1kC) 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. 

> **EHR support for Notes**
>
> EHR systems with robust interfacing capabilities typically support `Notes` via an MDM HL7v2 interface or proprietary API.

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.

> **Data on demand enabled**
>
> This event type is available with data on demand. [Learn more about data on demand.](https://docs.redoxengine.com/permalink/4TD76U5kQESdKsZvzDHfx5)

Status: Beta, Data on demand

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Meta` | object | Yes |  |
| `Meta.DataModel` | string | Yes | Notes |
| `Meta.EventType` | string | Yes | QueryResponse |
| `Meta.EventDateTime` | string or null | No | Displays the UTC date and time that an outgoing request is delivered or an incoming request is received. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Meta.Test` | boolean or null | No | Indicates whether the request is a test or not. |
| `Meta.Source` | object | No | Contains the information for the system initiating the message, including the source ID and name. *Included in messages from Redox* |
| `Meta.Source.ID` | string or null | No | 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* |
| `Meta.Source.Name` | string or null | No | Displays the name of the system initiating the message. |
| `Meta.Destinations` | Array of object | No | 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.* |
| `Meta.Destinations[].ID` | string or null | No | Identifies the endpoint that the request is directed to. *UUID* |
| `Meta.Destinations[].Name` | string or null | No | Displays the name of the endpoint that the request is directed to. |
| `Meta.Logs` | Array of object | No | Contains the log identifier(s) for the request. |
| `Meta.Logs[].ID` | string or null | No | 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* |
| `Meta.Logs[].AttemptID` | string or null | No | Identifies the request log attempt value, which is useful when retries are possible. *UUID* |
| `Meta.FacilityCode` | string or null | No | 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 | No |  |
| `Notes[].Patient` | object | No |  |
| `Notes[].Patient.Identifiers` | Array of object | No | List of IDs and ID types that identify the patient |
| `Notes[].Patient.Identifiers[].ID` | string or null | No | ID for the patient |
| `Notes[].Patient.Identifiers[].IDType` | string or null | No | Type of ID. *E.g. MRN, EPI* |
| `Notes[].Visit` | object | No |  |
| `Notes[].Visit.VisitNumber` | string or null | No | Visit Number. *A VisitNumber is highly recommended so that the document can be associated with a specific visit* |
| `Notes[].ContentType` | string or null | No | Describes the type of text provided in `Note.FileContents`. Use `Base64 Encoded` for all file types except plain or rich text format. Value set 4710558b-0f2e-4305-8d7a-e585a2aa084e: Base64 Encoded, Plain Text, Rich Text |
| `Notes[].FileContents` | string or null | No | 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* |
| `Notes[].FileName` | string or null | No | Displays the name of the document. |
| `Notes[].DocumentType` | string or null | No | Classifies the type of document (e.g., consent form, treatment plan). |
| `Notes[].DocumentID` | string or null | No | 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* |
| `Notes[].ServiceDateTime` | string or null | No | 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. |
| `Notes[].DocumentationDateTime` | string or null | No | 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
{
  "Meta": {
    "DataModel": "Notes",
    "EventType": "QueryResponse",
    "EventDateTime": "2026-11-16T23:16:06.930Z",
    "Test": true,
    "Source": {
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
      "Name": "Redox Dev Tools"
    },
    "Destinations": [
      {
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
        "Name": "Redox EMR"
      }
    ],
    "Logs": [
      {
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
      }
    ],
    "FacilityCode": null
  },
  "Notes": [
    {
      "Patient": {
        "Identifiers": [
          {
            "ID": "0000000001",
            "IDType": "MR"
          },
          {
            "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
            "IDType": "EHRID"
          },
          {
            "ID": "a1d4ee8aba494ca",
            "IDType": "NIST"
          }
        ]
      },
      "Visit": {
        "VisitNumber": "1234"
      },
      "ContentType": "Base64 Encoded",
      "FileContents": "JVBERi0xLjQKCjEgMCBvYmoKPDwKIC9UeXBlIC9DYXRhbG9nCiAvUGFnZXMgMiAwIFIKPj4KZW5kb2JqCgoyIDAgb2JqCjw8CiAvVHlwZSAvUGFnZXMKIC9LaWRzIFszIDAgUl0KIC9Db3VudCAxCj4+CmVuZG9iagoKMyAwIG9iago8PAogL1R5cGUgL1BhZ2UKIC9QYXJlbnQgMiAwIFIKIC9NZWRpYUJveCBbMCAwIDM1MCAyMDBdCiAvQ29udGVudHMgNCAwIFIKIC9SZXNvdXJjZXMgPDwKICAvUHJvY1NldCA1IDAgUgogIC9Gb250IDw8CiAgIC9GMSA2IDAgUgogID4+CiA+Pgo+PgplbmRvYmoKCjQgMCBvYmoKPDwgL0xlbmd0aCA3MyA+PgpzdHJlYW0KIEJUCiAgL0YxIDI0IFRmCiAgMTAwIDEwMCBUZAogIChIZWxsbyBmcm9tIFJlZG94KSBUagogRVQKZW5kc3RyZWFtCmVuZG9iagoKNSAwIG9iagogWy9QREYgL1RleHRdCmVuZG9iagoKNiAwIG9iago8PAogL1R5cGUgL0ZvbnQKIC9TdWJ0eXBlIC9UeXBlMQogL05hbWUgL0YxCiAvQmFzZUZvbnQgL0hlbHZldGljYQogL0VuY29kaW5nIC9NYWNSb21hbkVuY29kaW5nCj4+CmVuZG9iagoKeHJlZgowIDkKMDAwMDAwMDAwMCA2NTUzNSBmCjAwMDAwMDAwMDkgMDAwMDAgbgowMDAwMDAwMDc0IDAwMDAwIG4KMDAwMDAwMDEyMCAwMDAwMCBuCjAwMDAwMDAxNzkgMDAwMDAgbgowMDAwMDAwMzY0IDAwMDAwIG4KMDAwMDAwMDQ2NiAwMDAwMCBuCjAwMDAwMDA0OTYgMDAwMDAgbgoKdHJhaWxlcgo8PAovU2l6ZSA4Ci9Sb290IDEgMCBSCj4+CnN0YXJ0eHJlZgo2MjUKJSVFT0Y=",
      "FileName": "SamplePDF",
      "DocumentType": "Sample Clinical Note in PDF",
      "DocumentID": "e52180fb-75a2-41ea-9fcd-661a996de53f",
      "ServiceDateTime": "2015-05-06T06:00:58.872Z",
      "DocumentationDateTime": "2015-05-06T06:00:58.872Z"
    }
  ]
}
```
