Home
API reference
Redox Data Models
Notes
Replace

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.

Replace

Replace an existing document in a patient's chart. This event type overwrites an existing document.

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Notes

    • EventType
      required, string
      Reliable

      Replace

    • 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 ID types that identify the patient

      • ID
        required, string
        Reliable

        ID for the patient

      • IDType
        required, string
        Reliable

        Type of ID.
        E.g. MRN, EPI

    • Demographics
      object
      • FirstName
        string, null
        Reliable

        Patient's first name

      • MiddleName
        string, null
        Possible

        Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.

      • LastName
        string, null
        Reliable

        Patient's last name

      • DOB
        string, null
        Reliable

        Patient's date of birth.
        In ISO 8601 format

      • SSN
        string, null
        Probable

        Patient's social security number

      • Sex
        string, null
        Reliable
        Value Set

        Patient's sex

      • Race
        string, null
        Possible
        Value Set

        Patient's race

      • IsHispanic
        boolean, null
        Possible
        Value Set

        Indicates if the patient is of hispanic origin.

      • Religion
        string, null
        Possible
        Value Set

        Patient's religious affiliation

      • MaritalStatus
        string, null
        Possible
        Value Set

        Patient's marital status

      • IsDeceased
        boolean, null
        Possible

        Indicates if the patient is deceased

      • DeathDateTime
        string, null
        Possible

        Date and Time the patient was proclaimed deceased.
        ISO 8601 Format

      • PhoneNumber
        object
        • Home
          string, null
          Probable

          Patient's home phone number.
          In E. 164 Format. (e.g. +16085551234)

        • Office
          string, null
          Probable

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

        • Mobile
          string, null
          Probable

          Patient's mobile phone number.
          In E. 164 Format. (e.g. +16085551234)

      • EmailAddresses
        Array of string

        Patient's email address(es)

      • Language
        string, null
        Possible
        Value Set

        Patient's primary spoken language.
        In ISO 639-1 alpha values (e.g. 'en'). Supported Values

      • Citizenship
        Array of string

        Patient's nation(s) of citizenship.
        In ISO 3166 alpha 2 format (e.g. 'US').

      • Address
        object

        Patient's home address

        • StreetAddress
          string, null
          Probable

          Street address

        • City
          string, null
          Probable

          City

        • State
          string, null
          Probable

          State

        • ZIP
          string, null
          Probable

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

    • Notes
      Array of string

      Patient-level notes

  • Note
    required, object
    • ContentType
      required, string
      Reliable
      Value Set

      Describes the type of text provided in Note.FileContents.

    • DocumentType
      required, string
      Reliable

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

    • OriginalDocumentID
      required, string

      ID of the note being replaced

    • DocumentID
      required, string
      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

    • Provider
      required, object
      • ID
        required, string
        Probable

        ID of the Provider responsible for the document

      • IDType
        string, null
        Probable

        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)

      • 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

    • 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.
      If using data on demand, the plain or rich text is stored as base64 encoded data. It gets decoded when responding to a Notes.Query.

    • FileName
      string, null
      Probable

      Displays the name of the document.

    • FileType
      string, null
      Probable

      Identifies the format of the file (e.g., PDF, JPG). Use this if referencing a file with a Redox Blob URL.
      Not supported with data on demand.

    • DocumentDescription
      string, null
      Possible

      Contains a descriptive label for the document.
      Not supported with data on demand.

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

    • Status
      string, null
      Probable
      Value Set

      TDisplays the authenticated status of the document, which can be either Authenticated or In progress. If Authenticated, the related Note.Authenticator field must be populated.
      Not supported with data on demand.

    • Availability
      string, null
      Probable
      Value Set

      Indicates whether the document is available for use.
      Not supported with data on demand.

    • Authenticator
      object
      • ID
        string, null
        Probable

        ID of the provider who authenticated the document.
        This ID is often required for Inpatient Visits.

      • IDType
        string, null
        Probable

        ID type of the ID for the provider who authenticated the document

      • FirstName
        string, null
        Possible

        First name of the provider who authenticated the document

      • LastName
        string, null
        Possible

        Last name of the provider who authenticated the document

      • Credentials
        Array of string

        List of credentials for the provider who authenticated 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)

      • 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

    • Notifications
      Array of object
      • ID
        string, null
        Reliable

        ID of the provider who should be notified.
        This ID is often required for Inpatient Visits.

      • IDType
        string, null
        Reliable

        ID type of the ID for the provider who should be notified

      • FirstName
        string, null
        Possible

        First name of the provider who should be notified

      • LastName
        string, null
        Possible

        Last name of the provider who should be notified

      • Credentials
        Array of string

        List of credentials for the provider who should be notified.
        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)

      • 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

    • Components
      Array of object
      • ID
        string, null
        Possible

        Contains the identifier of the discrete note component. This could be either a report ID or document field ID.
        Not supported with data on demand.

      • Name
        string, null
        Possible

        Displays the name of the discrete note component (e.g., severity).
        Not supported with data on demand.

      • Value
        string, null
        Possible

        Contains the text of the note component, either in plain text or rich text.
        Not supported with data on demand.

      • Comments
        string, null
        Possible

        Contains any additional comments for the discrete note field.
        Not supported with data on demand.

  • Visit
    object
    • VisitNumber
      string, null
      Reliable

      Displays a unique identifier for the patient visit. We highly recommend including a visit number so the document can be associated with a specific visit.

    • AccountNumber
      string, null
      Possible

      Contains an identifier that can span several visits often related to the same patient condition (e.g., surgeries, research study, pregnancy). In other words, the account number can be used to link related visits.

    • PatientClass
      string, null
      Reliable

      Classifies the department or type of patient care. Patient class is used in many EHR systems to determine where to put the patient (e.g., inpatient, outpatient, emergency).

    • VisitDateTime
      string, null
      Reliable

      Displays the timestamp for the patient visit or the time that the patient arrived for admission.
      ISO 8601 Format

    • Location
      object

      Displays the location of the patient visit. This may be used to validate or to identify your application/device.

      • Type
        string, null
        Probable

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

      • Facility
        string, null
        Probable

        Facility.
        Example: Community Hospital

      • FacilityIdentifiers
        Array of object

        List of IDs specific to this facility

        • ID
          string, null
          Probable

          An ID specific to this facility

        • IDType
          string, null
          Probable

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

      • Department
        string, null
        Probable

        Department

      • DepartmentIdentifiers
        Array of object

        List of IDs specific to this department

        • ID
          string, null
          Probable

          An ID specific to this department

        • IDType
          string, null
          Probable

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

      • Room
        string, null
        Probable

        Room.
        Example: 136

      • Bed
        string, null
        Probable

        Bed.
        Example: B

    • AdditionalStaff
      Array of object

      Contains information about all other staff assigned to the assist with the patient visit. Each may be scheduled individually.

      • ID
        string, null
        Probable

        ID of the Additional staff member.
        This ID is often required for Inpatient Visits.

      • IDType
        string, null
        Probable

        ID type of the ID for the Additional staff member

      • FirstName
        string, null
        Possible

        First name of the Additional staff member

      • LastName
        string, null
        Possible

        Last name of the Additional staff member

      • Credentials
        Array of string

        List of credentials for the Additional staff member.
        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)

      • 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

      • Role
        object

        Identifies an additional staff member.

        • Code
          string, null
          Probable

          Code for the service

        • Codeset
          string, null
          Probable

          Code set used to identify the service.
          Codeset will be blank for system-defined codes.

        • Description
          string, null
          Probable

          Description of the service.
          Example: Primary Physician, Technologist, etc.

  • Orders
    Array of object
    • ID
      string, null
      Possible

      Contains the unique identifier of the order request, which is assigned by the system that placed the order.
      Not supported with data on demand.

    • Name
      string, null
      Possible

      Displays the name of the order, which is assigned by the system that placed the order.
      Not supported with data on demand.

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Notes",
4
    "EventType": "Replace",
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
    "Demographics": {
41
      "FirstName": "Timothy",
42
      "MiddleName": "Paul",
43
      "LastName": "Bixby",
44
      "DOB": "2008-01-06",
45
      "SSN": "101-01-0001",
46
      "Sex": "Male",
47
      "Race": "White",
48
      "IsHispanic": null,
49
      "Religion": null,
50
      "MaritalStatus": "Single",
51
      "IsDeceased": null,
52
      "DeathDateTime": null,
53
      "PhoneNumber": {
54
        "Home": "+18088675301",
55
        "Office": null,
56
        "Mobile": null
57
      },
58
      "EmailAddresses": [],
59
      "Language": "en",
60
      "Citizenship": [],
61
      "Address": {
62
        "StreetAddress": "4762 Hickory Street",
63
        "City": "Monroe",
64
        "State": "WI",
65
        "ZIP": "53566",
66
        "County": "Green",
67
        "Country": "US"
68
      }
69
    },
70
    "Notes": []
71
  },
72
  "Visit": {
73
    "VisitNumber": "1234",
74
    "AccountNumber": null,
75
    "PatientClass": null,
76
    "VisitDateTime": "2015-05-06T06:00:58.872Z",
77
    "Location": {
78
      "Type": null,
79
      "Facility": null,
80
      "FacilityIdentifiers": [],
81
      "Department": null,
82
      "DepartmentIdentifiers": [],
83
      "Room": null,
84
      "Bed": null
85
    },
86
    "AdditionalStaff": []
87
  },
88
  "Note": {
89
    "ContentType": "Base64 Encoded",
90
    "FileContents": "<...base 64 file contents...>",
91
    "FileName": "SamplePDF-Order Specific Note",
92
    "FileType": null,
93
    "DocumentType": "Empty File",
94
    "OriginalDocumentID": "93770d83-f1f2-4a4c-a28e-065626a76ba8",
95
    "DocumentID": "b169267c-10c9-4fe3-91ae-9ckf5703e90l",
96
    "DocumentDescription": null,
97
    "ServiceDateTime": "2015-05-06T06:00:58.872Z",
98
    "DocumentationDateTime": "2015-05-06T06:00:58.872Z",
99
    "Status": null,
100
    "Availability": "Unavailable",
101
    "Provider": {
102
      "ID": "4356789876",
103
      "IDType": "NPI",
104
      "FirstName": "Pat",
105
      "LastName": "Granite",
106
      "Credentials": [
107
        "MD"
108
      ],
109
      "Address": {
110
        "StreetAddress": "123 Main St.",
111
        "City": "Madison",
112
        "State": "WI",
113
        "ZIP": "53703",
114
        "County": "Dane",
115
        "Country": "USA"
116
      },
117
      "EmailAddresses": [],
118
      "PhoneNumber": {
119
        "Office": "+16085551234"
120
      },
121
      "Location": {
122
        "Type": null,
123
        "Facility": null,
124
        "FacilityIdentifiers": [],
125
        "Department": null,
126
        "DepartmentIdentifiers": [],
127
        "Room": null
128
      }
129
    },
130
    "Authenticator": {
131
      "ID": null,
132
      "IDType": null,
133
      "FirstName": null,
134
      "LastName": null,
135
      "Credentials": [],
136
      "Address": {
137
        "StreetAddress": null,
138
        "City": null,
139
        "State": null,
140
        "ZIP": null,
141
        "County": null,
142
        "Country": null
143
      },
144
      "EmailAddresses": [],
145
      "PhoneNumber": {
146
        "Office": null
147
      },
148
      "Location": {
149
        "Type": null,
150
        "Facility": null,
151
        "FacilityIdentifiers": [],
152
        "Department": null,
153
        "DepartmentIdentifiers": [],
154
        "Room": null
155
      }
156
    },
157
    "Notifications": [
158
      {
159
        "ID": "2434534567",
160
        "IDType": "NPI",
161
        "FirstName": "Sharon",
162
        "LastName": "Chalk",
163
        "Credentials": [
164
          "MD",
165
          "PhD"
166
        ],
167
        "Address": {
168
          "StreetAddress": "312 Maple Dr. Suite 400",
169
          "City": "Verona",
170
          "State": "WI",
171
          "ZIP": "53593",
172
          "County": "Dane",
173
          "Country": "USA"
174
        },
175
        "EmailAddresses": [],
176
        "PhoneNumber": {
177
          "Office": "+16085559999"
178
        },
179
        "Location": {
180
          "Type": null,
181
          "Facility": null,
182
          "FacilityIdentifiers": [],
183
          "Department": null,
184
          "DepartmentIdentifiers": [],
185
          "Room": null
186
        }
187
      },
188
      {
189
        "ID": "8263749385",
190
        "IDType": "NPI",
191
        "FirstName": "Jim",
192
        "LastName": "Mica",
193
        "Credentials": [
194
          "RN"
195
        ],
196
        "Address": {
197
          "StreetAddress": "5235 Kennedy Ave.",
198
          "City": "Creve Cour",
199
          "State": "MO",
200
          "ZIP": "63141",
201
          "County": "Saint Louis",
202
          "Country": "USA"
203
        },
204
        "EmailAddresses": [],
205
        "PhoneNumber": {
206
          "Office": "+13145557777"
207
        },
208
        "Location": {
209
          "Type": null,
210
          "Facility": null,
211
          "FacilityIdentifiers": [],
212
          "Department": null,
213
          "DepartmentIdentifiers": [],
214
          "Room": null
215
        }
216
      }
217
    ],
218
    "Components": []
219
  },
220
  "Orders": [
221
    {
222
      "ID": 123456,
223
      "Name": "Stress Test"
224
    }
225
  ]
226
}