# Notes Replace

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.

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

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Meta` | object | Yes |  |
| `Meta.DataModel` | string | Yes | Notes |
| `Meta.EventType` | string | Yes | Replace |
| `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.* |
| `Patient` | object | Yes |  |
| `Patient.Identifiers` | Array of object | Yes | List of IDs and ID types that identify the patient |
| `Patient.Identifiers[].ID` | string | Yes | ID for the patient |
| `Patient.Identifiers[].IDType` | string | Yes | Type of ID. *E.g. MRN, EPI* |
| `Patient.Demographics` | object | No |  |
| `Patient.Demographics.FirstName` | string or null | No | Patient's first name |
| `Patient.Demographics.MiddleName` | string or null | No | Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field. |
| `Patient.Demographics.LastName` | string or null | No | Patient's last name |
| `Patient.Demographics.DOB` | string or null | No | Patient's date of birth. *In [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Patient.Demographics.SSN` | string or null | No | Patient's social security number |
| `Patient.Demographics.Sex` | string or null | No | Patient's sex. Value set ca03256a-4fd3-4b3d-8e37-912cd22b5cda: Female, Male, Unknown, Other, Nonbinary, Prefer not to answer |
| `Patient.Demographics.Race` | string or null | No | Patient's race. Value set 2d9b5abe-e939-4c55-b8e5-a2816ecb08eb: American Indian or Alaska Native, Asian, Black or African American, Native Hawaiian or Other Pacific Islander, Other Race, White, Unknown, Prefer not to answer |
| `Patient.Demographics.IsHispanic` | boolean or null | No | Indicates if the patient is of hispanic origin. Value set 731a7062-165a-434c-bef7-b02b824dfc7b: true, false, null |
| `Patient.Demographics.Religion` | string or null | No | Patient's religious affiliation. Value set 11a5dd99-3549-484c-ba0a-1b22723e9a45: Latter Day Saints, Lutheran, Mahayana, Meditation, Messianic Judaism, Mitraism, New Age, non-Roman Catholic, Occult, Adventist, African Religions, Afro-Caribbean Religions, Agnosticism, Anglican, Animism, Atheism, Babi & Baha'I faiths, Baptist, Bon, Cao Dai, Celticism, Christian, Confucianism, Cyberculture Religions, Divination, Fourth Way, Free Daism, Gnosis, Hinduism, Humanism, Independent, Islam, Jainism, Jehovah's Witnesses, Judaism, Orthodox, Paganism, Pentecostal, Reformed/Presbyterian, Roman Catholic Church, Satanism, Scientology, Shamanism, Shiite (Islam), Shinto, Sikism, Spiritualism, Sunni (Islam), Taoism, Theravada, Unitarian-Universalism, Universal Life Church, Vajrayana (Tibetan), Veda, Voodoo, Wicca, Yaohushua, Zen Buddhism, Zoroastrianism, Assembly of God, Brethren, Christian Scientist, Church of Christ, Church of God, Congregational, Disciples of Christ, Eastern Orthodox, Episcopalian, Evangelical Covenant, Friends, Full Gospel, Methodist, Native American, Nazarene, Presbyterian, Protestant, Reformed, Salvation Army, Unitarian Universalist, United Church of Christ, Protestant - No Denomination, The Process, None, Other, Unknown |
| `Patient.Demographics.MaritalStatus` | string or null | No | Patient's marital status. Value set f3f48779-ee0c-4477-b458-d8cba9303039: Separated, Unmarried, Common law, Divorced, Legally Separated, Living together, Interlocutory, Married, Annulled, Other, Domestic partner, Registered domestic partner, Single, Unreported, Unknown, Widowed, Polygamous, Never Married |
| `Patient.Demographics.IsDeceased` | boolean or null | No | Indicates if the patient is deceased |
| `Patient.Demographics.DeathDateTime` | string or null | No | Date and Time the patient was proclaimed deceased. *[ISO 8601 Format](https://en.wikipedia.org/wiki/ISO_8601)* |
| `Patient.Demographics.PhoneNumber` | object | No |  |
| `Patient.Demographics.PhoneNumber.Home` | string or null | No | Patient's home phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Patient.Demographics.PhoneNumber.Office` | string or null | No | Patient's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Patient.Demographics.PhoneNumber.Mobile` | string or null | No | Patient's mobile phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Patient.Demographics.EmailAddresses` | Array of string | No | Patient's email address(es) |
| `Patient.Demographics.Language` | string or null | No | Patient's primary spoken language. *In ISO 639-1 alpha values (e.g. 'en'). [Supported Values](http://www.loc.gov/standards/iso639-2/php/code_list.php)* Value set 7eeaad13-6761-41f0-ab43-5be92809afc2: af, ae, ak, bg, bh, ca, ce, ch, co, cr, cs, cu, cv, da, dz, ee, en, eo, et, eu, ff, gl, ha, hr, ii, is, lu, kk, kn, ku, kv, kw, mk, ms, nb, nd, pi, sk, om, qu, sn, sq, su, ta, ti, tk, uk, wo, yo, id, ig, jv, kj, km, ln, lo, mr, mt, na, ng, no, oj, pt, rm, rw, sg, st, sw, th, tr, tt, ur, vo, zh, aa, de, fi, ht, hy, ie, ik, ki, kl, ko, kr, ks, ky, lv, mg, mi, ml, my, ne, nl, ny, oc, os, pa, pl, ps, rn, sc, sd, si, sl, so, sr, sv, tg, tl, tn, to, tw, ty, ug, ve, vi, wa, za, es, fa, gn, hu, hz, ia, la, lt, mh, mn, nn, nr, nv, or, ro, sa, se, ss, te, ts, uz, xh, yi, zu, Other, Unknown, ab, av, ba, sgn, am, an, ay, ar, as, az, be, bi, bm, bn, bo, br, bs, cy, dv, el, fj, fo, fr, fy, ga, gd, gu, gv, he, hi, ho, io, it, iu, ja, ka, kg, lb, lg, li, ru, sm |
| `Patient.Demographics.Citizenship` | Array of string | No | Patient's nation(s) of citizenship. *In ISO 3166 alpha 2 format (e.g. 'US').* Value set 232b1e77-fd16-4f4c-838f-0d288c119806: American Samoa, Anguilla, Austria, Bahamas, Barbados, Bhutan, Bosnia and Herzegovina, Afghanistan, Åland Islands, Albania, Angola, Andorra, Argentina, Armenia, Bangladesh, Belgium, Benin, Bonaire Sint Eustatius and Saba, Botswana, Bouvet Island, British Indian Ocean Territory, Brunei Darussalam, Burkina Faso, Bulgaria, Algeria, Antarctica, Antigua and Barbuda, Aruba, Australia, Azerbaijan, Bahrain, Belarus, Belize, Bermuda, Bolivia (Plurinational State of), Brazil, Burundi, Cayman Islands, China, Colombia, Cook Islands, Curaçao, El Salvador, Cambodia, Christmas Island, Congo (the Democratic Republic of the), Croatia, Czechia, Dominica, Cabo Verde, Chad, Cocos (Keeling) Islands, Costa Rica, Denmark, Dominican Republic, Cameroon, Chile, Congo, Cyprus, Ecuador, Canada, Central African Republic, Comoros, Cuba, Djibouti, Egypt, Equatorial Guinea, Eritrea, Estonia, Ethiopia, Falkland Islands[Malvinas], Faroe Islands, Fiji, Finland, France, French Guiana, French Polynesia, French Southern Territories, Gabon, Gambia, Georgia, Germany, Ghana, Gibraltar, Greece, Greenland, Grenada, Guadeloupe, Guam, Guatemala, Guernsey, Guinea, Guinea-Bissau, Guyana, Haiti, Heard Island and McDonald Islands, Holy See, Honduras, Hong Kong, Hungary, Iceland, India, Indonesia, Iran (Islamic Republic of), Iraq, Ireland, Isle of Man, Israel, Italy, Jamaica, Japan, Jersey, Jordan, Kazakhstan, Kenya, Kiribati, Korea (the Republic of), Kuwait, Kyrgyzstan, Liechtenstein, Madagascar, Mali, Mauritius, Monaco, Mozambique, Netherlands, Niger, Lao Peoples Democratic Republic, Latvia, Lesotho, Macao, Malta, Mayotte, Moldova (the Republic of), Myanmar, Nigeria, Oman, Lebanon, Lithuania, Malawi, Maldives, Mauritania, Mongolia, Morocco, Nepal, Nicaragua, Northern Mariana Islands, Liberia, Luxembourg, Malaysia, Martinique, Micronesia (Federated States of), Montserrat, Nauru, New Zealand, Norfolk Island, Libya, Macedonia (the former Yugoslav Republic of), Marshall Islands, Mexico, Montenegro, Namibia, New Caledonia, Niue, Norway, Pakistan, Palau, Palestine State of, Panama, Papua New Guinea, Paraguay, Peru, Philippines, Pitcairn, Poland, Portugal, Qatar, Puerto Rico, Réunion, Romania, Russian Federation, Rwanda, Saint Barthélemy, Saint Helena Ascension and Tristan da Cunha, Saint Kitts and Nevis, Saint Lucia, Saint Martin (French part), Saint Pierre and Miquelon, Saint Vincent and the Grenadines, Samoa, San Marino, Sao Tome and Principe, Saudi Arabia, Senegal, Serbia, Seychelles, Sierra Leone, Singapore, Sint Maarten (Dutch part), Slovakia, Slovenia, Solomon Islands, Somalia, South Africa, South Georgia and the South Sandwich Islands, South Sudan, Spain, Sri Lanka, Sudan, Suriname, Svalbard and Jan Mayen, Swaziland, Sweden, Switzerland, Syrian Arab Republic, Tajikistan, Taiwan (Province of China), Timor-Leste, Trinidad and Tobago, Tuvalu, Uruguay, Virgin Islands (U.S.), Yemen, Tanzania United Republic of, Turkey, Ukraine, United States of America, Viet Nam, Western Sahara*, Thailand, Tonga, Turks and Caicos Islands, United States Minor Outlying Islands, Venezuela (Bolivarian Republic of), Zimbabwe, Togo, Tunisia, Uganda, United Arab Emirates, Uzbekistan, Virgin Islands (British), Zambia, Tokelau, Turkmenistan, United Kingdom of Great Britain and Northern Ireland, Vanuatu, Wallis and Futuna, Côte dIvoire, Korea (the Democratic Peoples Republic of), Unknown |
| `Patient.Demographics.Address` | object | No | Patient's home address |
| `Patient.Demographics.Address.StreetAddress` | string or null | No | Street address |
| `Patient.Demographics.Address.City` | string or null | No | City |
| `Patient.Demographics.Address.State` | string or null | No | State |
| `Patient.Demographics.Address.ZIP` | string or null | No | ZIP |
| `Patient.Demographics.Address.County` | string or null | No | County |
| `Patient.Demographics.Address.Country` | string or null | No | Country. Value set 39791e31-0cee-4c58-a6c1-3d9e2c71d13b: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, IO, CM, CL, CO, CI, DK, EC, ER, FK, TF, GM, GI, GW, VA, IS, IM, JP, KI, LS, LT, MK, MV, MX, MS, NA, NC, MP, PK, PG, PL, RU, PM, SA, SG, SB, SS, SE, TZ, TO, TV, US, VN, EH, ZW, BQ, BR, BF, CA, TD, KM, CK, CU, DO, EE, FI, GE, GL, GN, GY, IN, IE, JE, KW, LB, LY, MO, ML, MR, MN, MM, NZ, NU, OM, PY, PT, RO, KN, SN, RS, ZA, LK, SJ, SY, TK, TM, UG, UM, UZ, WF, BA, BG, CV, CX, CD, CW, DJ, GQ, FO, PF, DE, GD, GG, HT, HK, IR, IL, KE, KG, LU, MY, MT, MU, ME, MZ, NP, NF, PW, PH, QA, BL, MF, ST, SX, SI, GS, SR, TJ, TG, TN, UA, VU, VG, BW, BN, KH, KY, CC, CR, CY, EG, FJ, FR, GH, GP, GU, HN, IQ, JM, KZ, KP, LA, LR, MW, MH, YT, MD, MA, NI, NG, NO, PA, PN, RE, RW, LC, SM, SC, SK, ES, CH, TH, TT, TR, GB, VE, VI, ZM, BV, BI, CF, CN, CG, HR, CZ, DM, SV, ET, GF, GA, GR, GT, HM, HU, ID, IT, JO, KR, LV, LI, MG, MQ, FM, MC, NR, NL, NE, PS, PE, PR, SH, VC, WS, SL, SO, SD, SZ, TW, TL, TC, AE, UY, YE, DR |
| `Patient.Notes` | Array of string | No | Patient-level notes |
| `Note` | object | Yes |  |
| `Note.ContentType` | string | Yes | 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 |
| `Note.DocumentType` | string | Yes | Classifies the type of document (e.g., consent form, treatment plan). |
| `Note.OriginalDocumentID` | string | Yes | ID of the note being replaced |
| `Note.DocumentID` | string | Yes | 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* |
| `Note.Provider` | object | Yes |  |
| `Note.Provider.ID` | string | Yes | ID of the Provider responsible for the document |
| `Note.Provider.IDType` | string or null | No | ID type of the ID for the Provider responsible for the document |
| `Note.Provider.FirstName` | string or null | No | First name of the Provider responsible for the document |
| `Note.Provider.LastName` | string or null | No | Last name of the Provider responsible for the document |
| `Note.Provider.Credentials` | Array of string | No | List of credentials for the Provider responsible for the document. *e.g. MD, PhD* |
| `Note.Provider.Address` | object | No | Provider's address |
| `Note.Provider.Address.StreetAddress` | string or null | No | Street address |
| `Note.Provider.Address.City` | string or null | No | City |
| `Note.Provider.Address.State` | string or null | No | State |
| `Note.Provider.Address.ZIP` | string or null | No | ZIP |
| `Note.Provider.Address.County` | string or null | No | County |
| `Note.Provider.Address.Country` | string or null | No | Country. Value set 39791e31-0cee-4c58-a6c1-3d9e2c71d13b: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, IO, CM, CL, CO, CI, DK, EC, ER, FK, TF, GM, GI, GW, VA, IS, IM, JP, KI, LS, LT, MK, MV, MX, MS, NA, NC, MP, PK, PG, PL, RU, PM, SA, SG, SB, SS, SE, TZ, TO, TV, US, VN, EH, ZW, BQ, BR, BF, CA, TD, KM, CK, CU, DO, EE, FI, GE, GL, GN, GY, IN, IE, JE, KW, LB, LY, MO, ML, MR, MN, MM, NZ, NU, OM, PY, PT, RO, KN, SN, RS, ZA, LK, SJ, SY, TK, TM, UG, UM, UZ, WF, BA, BG, CV, CX, CD, CW, DJ, GQ, FO, PF, DE, GD, GG, HT, HK, IR, IL, KE, KG, LU, MY, MT, MU, ME, MZ, NP, NF, PW, PH, QA, BL, MF, ST, SX, SI, GS, SR, TJ, TG, TN, UA, VU, VG, BW, BN, KH, KY, CC, CR, CY, EG, FJ, FR, GH, GP, GU, HN, IQ, JM, KZ, KP, LA, LR, MW, MH, YT, MD, MA, NI, NG, NO, PA, PN, RE, RW, LC, SM, SC, SK, ES, CH, TH, TT, TR, GB, VE, VI, ZM, BV, BI, CF, CN, CG, HR, CZ, DM, SV, ET, GF, GA, GR, GT, HM, HU, ID, IT, JO, KR, LV, LI, MG, MQ, FM, MC, NR, NL, NE, PS, PE, PR, SH, VC, WS, SL, SO, SD, SZ, TW, TL, TC, AE, UY, YE, DR |
| `Note.Provider.EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Note.Provider.PhoneNumber` | object | No |  |
| `Note.Provider.PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Note.Provider.Location` | object | No | Provider's location |
| `Note.Provider.Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Note.Provider.Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Note.Provider.Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Note.Provider.Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Note.Provider.Location.FacilityIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Note.Provider.Location.Department` | string or null | No | Department |
| `Note.Provider.Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Note.Provider.Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Note.Provider.Location.DepartmentIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Note.Provider.Location.Room` | string or null | No | Room. *Example: 136* |
| `Note.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. *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.* |
| `Note.FileName` | string or null | No | Displays the name of the document. |
| `Note.FileType` | string or null | No | 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.* |
| `Note.DocumentDescription` | string or null | No | Contains a descriptive label for the document. *Not supported with data on demand.* |
| `Note.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. |
| `Note.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.* |
| `Note.Status` | string or null | No | 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.* Value set 8ceb38dd-4840-4ccc-a3f6-9ea324f20bf7: Authenticated, In progress, In Progress |
| `Note.Availability` | string or null | No | Indicates whether the document is available for use. *Not supported with data on demand.* Value set 75206c66-eeb4-47e5-a012-6c1b2ace1550: Available, Unavailable, Obsolete, Deleted, Cancelled |
| `Note.Authenticator` | object | No |  |
| `Note.Authenticator.ID` | string or null | No | ID of the provider who authenticated the document. *This ID is often required for Inpatient Visits.* |
| `Note.Authenticator.IDType` | string or null | No | ID type of the ID for the provider who authenticated the document |
| `Note.Authenticator.FirstName` | string or null | No | First name of the provider who authenticated the document |
| `Note.Authenticator.LastName` | string or null | No | Last name of the provider who authenticated the document |
| `Note.Authenticator.Credentials` | Array of string | No | List of credentials for the provider who authenticated the document. *e.g. MD, PhD* |
| `Note.Authenticator.Address` | object | No | Provider's address |
| `Note.Authenticator.Address.StreetAddress` | string or null | No | Street address |
| `Note.Authenticator.Address.City` | string or null | No | City |
| `Note.Authenticator.Address.State` | string or null | No | State |
| `Note.Authenticator.Address.ZIP` | string or null | No | ZIP |
| `Note.Authenticator.Address.County` | string or null | No | County |
| `Note.Authenticator.Address.Country` | string or null | No | Country. Value set 39791e31-0cee-4c58-a6c1-3d9e2c71d13b: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, IO, CM, CL, CO, CI, DK, EC, ER, FK, TF, GM, GI, GW, VA, IS, IM, JP, KI, LS, LT, MK, MV, MX, MS, NA, NC, MP, PK, PG, PL, RU, PM, SA, SG, SB, SS, SE, TZ, TO, TV, US, VN, EH, ZW, BQ, BR, BF, CA, TD, KM, CK, CU, DO, EE, FI, GE, GL, GN, GY, IN, IE, JE, KW, LB, LY, MO, ML, MR, MN, MM, NZ, NU, OM, PY, PT, RO, KN, SN, RS, ZA, LK, SJ, SY, TK, TM, UG, UM, UZ, WF, BA, BG, CV, CX, CD, CW, DJ, GQ, FO, PF, DE, GD, GG, HT, HK, IR, IL, KE, KG, LU, MY, MT, MU, ME, MZ, NP, NF, PW, PH, QA, BL, MF, ST, SX, SI, GS, SR, TJ, TG, TN, UA, VU, VG, BW, BN, KH, KY, CC, CR, CY, EG, FJ, FR, GH, GP, GU, HN, IQ, JM, KZ, KP, LA, LR, MW, MH, YT, MD, MA, NI, NG, NO, PA, PN, RE, RW, LC, SM, SC, SK, ES, CH, TH, TT, TR, GB, VE, VI, ZM, BV, BI, CF, CN, CG, HR, CZ, DM, SV, ET, GF, GA, GR, GT, HM, HU, ID, IT, JO, KR, LV, LI, MG, MQ, FM, MC, NR, NL, NE, PS, PE, PR, SH, VC, WS, SL, SO, SD, SZ, TW, TL, TC, AE, UY, YE, DR |
| `Note.Authenticator.EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Note.Authenticator.PhoneNumber` | object | No |  |
| `Note.Authenticator.PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Note.Authenticator.Location` | object | No | Provider's location |
| `Note.Authenticator.Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Note.Authenticator.Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Note.Authenticator.Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Note.Authenticator.Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Note.Authenticator.Location.FacilityIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Note.Authenticator.Location.Department` | string or null | No | Department |
| `Note.Authenticator.Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Note.Authenticator.Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Note.Authenticator.Location.DepartmentIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Note.Authenticator.Location.Room` | string or null | No | Room. *Example: 136* |
| `Note.Notifications` | Array of object | No |  |
| `Note.Notifications[].ID` | string or null | No | ID of the provider who should be notified. *This ID is often required for Inpatient Visits.* |
| `Note.Notifications[].IDType` | string or null | No | ID type of the ID for the provider who should be notified |
| `Note.Notifications[].FirstName` | string or null | No | First name of the provider who should be notified |
| `Note.Notifications[].LastName` | string or null | No | Last name of the provider who should be notified |
| `Note.Notifications[].Credentials` | Array of string | No | List of credentials for the provider who should be notified. *e.g. MD, PhD* |
| `Note.Notifications[].Address` | object | No | Provider's address |
| `Note.Notifications[].Address.StreetAddress` | string or null | No | Street address |
| `Note.Notifications[].Address.City` | string or null | No | City |
| `Note.Notifications[].Address.State` | string or null | No | State |
| `Note.Notifications[].Address.ZIP` | string or null | No | ZIP |
| `Note.Notifications[].Address.County` | string or null | No | County |
| `Note.Notifications[].Address.Country` | string or null | No | Country. Value set 39791e31-0cee-4c58-a6c1-3d9e2c71d13b: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, IO, CM, CL, CO, CI, DK, EC, ER, FK, TF, GM, GI, GW, VA, IS, IM, JP, KI, LS, LT, MK, MV, MX, MS, NA, NC, MP, PK, PG, PL, RU, PM, SA, SG, SB, SS, SE, TZ, TO, TV, US, VN, EH, ZW, BQ, BR, BF, CA, TD, KM, CK, CU, DO, EE, FI, GE, GL, GN, GY, IN, IE, JE, KW, LB, LY, MO, ML, MR, MN, MM, NZ, NU, OM, PY, PT, RO, KN, SN, RS, ZA, LK, SJ, SY, TK, TM, UG, UM, UZ, WF, BA, BG, CV, CX, CD, CW, DJ, GQ, FO, PF, DE, GD, GG, HT, HK, IR, IL, KE, KG, LU, MY, MT, MU, ME, MZ, NP, NF, PW, PH, QA, BL, MF, ST, SX, SI, GS, SR, TJ, TG, TN, UA, VU, VG, BW, BN, KH, KY, CC, CR, CY, EG, FJ, FR, GH, GP, GU, HN, IQ, JM, KZ, KP, LA, LR, MW, MH, YT, MD, MA, NI, NG, NO, PA, PN, RE, RW, LC, SM, SC, SK, ES, CH, TH, TT, TR, GB, VE, VI, ZM, BV, BI, CF, CN, CG, HR, CZ, DM, SV, ET, GF, GA, GR, GT, HM, HU, ID, IT, JO, KR, LV, LI, MG, MQ, FM, MC, NR, NL, NE, PS, PE, PR, SH, VC, WS, SL, SO, SD, SZ, TW, TL, TC, AE, UY, YE, DR |
| `Note.Notifications[].EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Note.Notifications[].PhoneNumber` | object | No |  |
| `Note.Notifications[].PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Note.Notifications[].Location` | object | No | Provider's location |
| `Note.Notifications[].Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Note.Notifications[].Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Note.Notifications[].Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Note.Notifications[].Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Note.Notifications[].Location.FacilityIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Note.Notifications[].Location.Department` | string or null | No | Department |
| `Note.Notifications[].Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Note.Notifications[].Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Note.Notifications[].Location.DepartmentIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Note.Notifications[].Location.Room` | string or null | No | Room. *Example: 136* |
| `Note.Components` | Array of object | No |  |
| `Note.Components[].ID` | string or null | No | 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.* |
| `Note.Components[].Name` | string or null | No | Displays the name of the discrete note component (e.g., severity). *Not supported with data on demand.* |
| `Note.Components[].Value` | string or null | No | Contains the text of the note component, either in plain text or rich text. *Not supported with data on demand.* |
| `Note.Components[].Comments` | string or null | No | Contains any additional comments for the discrete note field. *Not supported with data on demand.* |
| `Visit` | object | No |  |
| `Visit.VisitNumber` | string or null | No | 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. |
| `Visit.AccountNumber` | string or null | No | 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. |
| `Visit.PatientClass` | string or null | No | 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). |
| `Visit.VisitDateTime` | string or null | No | Displays the timestamp for the patient visit or the time that the patient arrived for admission. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Visit.Location` | object | No | Displays the location of the patient visit. This may be used to validate or to identify your application/device. |
| `Visit.Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Visit.Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Visit.Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Visit.Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Visit.Location.FacilityIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Visit.Location.Department` | string or null | No | Department |
| `Visit.Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Visit.Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Visit.Location.DepartmentIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Visit.Location.Room` | string or null | No | Room. *Example: 136* |
| `Visit.Location.Bed` | string or null | No | Bed. *Example: B* |
| `Visit.AdditionalStaff` | Array of object | No | Contains information about all other staff assigned to the assist with the patient visit. Each may be scheduled individually. |
| `Visit.AdditionalStaff[].ID` | string or null | No | ID of the Additional staff member. *This ID is often required for Inpatient Visits.* |
| `Visit.AdditionalStaff[].IDType` | string or null | No | ID type of the ID for the Additional staff member |
| `Visit.AdditionalStaff[].FirstName` | string or null | No | First name of the Additional staff member |
| `Visit.AdditionalStaff[].LastName` | string or null | No | Last name of the Additional staff member |
| `Visit.AdditionalStaff[].Credentials` | Array of string | No | List of credentials for the Additional staff member. *e.g. MD, PhD* |
| `Visit.AdditionalStaff[].Address` | object | No | Provider's address |
| `Visit.AdditionalStaff[].Address.StreetAddress` | string or null | No | Street address |
| `Visit.AdditionalStaff[].Address.City` | string or null | No | City |
| `Visit.AdditionalStaff[].Address.State` | string or null | No | State |
| `Visit.AdditionalStaff[].Address.ZIP` | string or null | No | ZIP |
| `Visit.AdditionalStaff[].Address.County` | string or null | No | County |
| `Visit.AdditionalStaff[].Address.Country` | string or null | No | Country. Value set 39791e31-0cee-4c58-a6c1-3d9e2c71d13b: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, IO, CM, CL, CO, CI, DK, EC, ER, FK, TF, GM, GI, GW, VA, IS, IM, JP, KI, LS, LT, MK, MV, MX, MS, NA, NC, MP, PK, PG, PL, RU, PM, SA, SG, SB, SS, SE, TZ, TO, TV, US, VN, EH, ZW, BQ, BR, BF, CA, TD, KM, CK, CU, DO, EE, FI, GE, GL, GN, GY, IN, IE, JE, KW, LB, LY, MO, ML, MR, MN, MM, NZ, NU, OM, PY, PT, RO, KN, SN, RS, ZA, LK, SJ, SY, TK, TM, UG, UM, UZ, WF, BA, BG, CV, CX, CD, CW, DJ, GQ, FO, PF, DE, GD, GG, HT, HK, IR, IL, KE, KG, LU, MY, MT, MU, ME, MZ, NP, NF, PW, PH, QA, BL, MF, ST, SX, SI, GS, SR, TJ, TG, TN, UA, VU, VG, BW, BN, KH, KY, CC, CR, CY, EG, FJ, FR, GH, GP, GU, HN, IQ, JM, KZ, KP, LA, LR, MW, MH, YT, MD, MA, NI, NG, NO, PA, PN, RE, RW, LC, SM, SC, SK, ES, CH, TH, TT, TR, GB, VE, VI, ZM, BV, BI, CF, CN, CG, HR, CZ, DM, SV, ET, GF, GA, GR, GT, HM, HU, ID, IT, JO, KR, LV, LI, MG, MQ, FM, MC, NR, NL, NE, PS, PE, PR, SH, VC, WS, SL, SO, SD, SZ, TW, TL, TC, AE, UY, YE, DR |
| `Visit.AdditionalStaff[].EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Visit.AdditionalStaff[].PhoneNumber` | object | No |  |
| `Visit.AdditionalStaff[].PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Visit.AdditionalStaff[].Location` | object | No | Provider's location |
| `Visit.AdditionalStaff[].Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Visit.AdditionalStaff[].Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Visit.AdditionalStaff[].Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Visit.AdditionalStaff[].Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Visit.AdditionalStaff[].Location.FacilityIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Visit.AdditionalStaff[].Location.Department` | string or null | No | Department |
| `Visit.AdditionalStaff[].Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Visit.AdditionalStaff[].Location.Room` | string or null | No | Room. *Example: 136* |
| `Visit.AdditionalStaff[].Role` | object | No | Identifies an additional staff member. |
| `Visit.AdditionalStaff[].Role.Code` | string or null | No | Code for the service |
| `Visit.AdditionalStaff[].Role.Codeset` | string or null | No | Code set used to identify the service. *Codeset will be blank for system-defined codes.* |
| `Visit.AdditionalStaff[].Role.Description` | string or null | No | Description of the service. *Example: Primary Physician, Technologist, etc.* |
| `Orders` | Array of object | No |  |
| `Orders[].ID` | string or null | No | Contains the unique identifier of the order request, which is assigned by the system that placed the order. *Not supported with data on demand.* |
| `Orders[].Name` | string or null | No | Displays the name of the order, which is assigned by the system that placed the order. *Not supported with data on demand.* |

## Example

```json
{
  "Meta": {
    "DataModel": "Notes",
    "EventType": "Replace",
    "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
  },
  "Patient": {
    "Identifiers": [
      {
        "ID": "0000000001",
        "IDType": "MR"
      },
      {
        "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
        "IDType": "EHRID"
      },
      {
        "ID": "a1d4ee8aba494ca",
        "IDType": "NIST"
      }
    ],
    "Demographics": {
      "FirstName": "Timothy",
      "MiddleName": "Paul",
      "LastName": "Bixby",
      "DOB": "2008-01-06",
      "SSN": "101-01-0001",
      "Sex": "Male",
      "Race": "White",
      "IsHispanic": null,
      "Religion": null,
      "MaritalStatus": "Single",
      "IsDeceased": null,
      "DeathDateTime": null,
      "PhoneNumber": {
        "Home": "+18088675301",
        "Office": null,
        "Mobile": null
      },
      "EmailAddresses": [],
      "Language": "en",
      "Citizenship": [],
      "Address": {
        "StreetAddress": "4762 Hickory Street",
        "City": "Monroe",
        "State": "WI",
        "ZIP": "53566",
        "County": "Green",
        "Country": "US"
      }
    },
    "Notes": []
  },
  "Visit": {
    "VisitNumber": "1234",
    "AccountNumber": null,
    "PatientClass": null,
    "VisitDateTime": "2015-05-06T06:00:58.872Z",
    "Location": {
      "Type": null,
      "Facility": null,
      "FacilityIdentifiers": [],
      "Department": null,
      "DepartmentIdentifiers": [],
      "Room": null,
      "Bed": null
    },
    "AdditionalStaff": []
  },
  "Note": {
    "ContentType": "Base64 Encoded",
    "FileContents": "<...base 64 file contents...>",
    "FileName": "SamplePDF-Order Specific Note",
    "FileType": null,
    "DocumentType": "Empty File",
    "OriginalDocumentID": "93770d83-f1f2-4a4c-a28e-065626a76ba8",
    "DocumentID": "b169267c-10c9-4fe3-91ae-9ckf5703e90l",
    "DocumentDescription": null,
    "ServiceDateTime": "2015-05-06T06:00:58.872Z",
    "DocumentationDateTime": "2015-05-06T06:00:58.872Z",
    "Status": null,
    "Availability": "Unavailable",
    "Provider": {
      "ID": "4356789876",
      "IDType": "NPI",
      "FirstName": "Pat",
      "LastName": "Granite",
      "Credentials": [
        "MD"
      ],
      "Address": {
        "StreetAddress": "123 Main St.",
        "City": "Madison",
        "State": "WI",
        "ZIP": "53703",
        "County": "Dane",
        "Country": "USA"
      },
      "EmailAddresses": [],
      "PhoneNumber": {
        "Office": "+16085551234"
      },
      "Location": {
        "Type": null,
        "Facility": null,
        "FacilityIdentifiers": [],
        "Department": null,
        "DepartmentIdentifiers": [],
        "Room": null
      }
    },
    "Authenticator": {
      "ID": null,
      "IDType": null,
      "FirstName": null,
      "LastName": null,
      "Credentials": [],
      "Address": {
        "StreetAddress": null,
        "City": null,
        "State": null,
        "ZIP": null,
        "County": null,
        "Country": null
      },
      "EmailAddresses": [],
      "PhoneNumber": {
        "Office": null
      },
      "Location": {
        "Type": null,
        "Facility": null,
        "FacilityIdentifiers": [],
        "Department": null,
        "DepartmentIdentifiers": [],
        "Room": null
      }
    },
    "Notifications": [
      {
        "ID": "2434534567",
        "IDType": "NPI",
        "FirstName": "Sharon",
        "LastName": "Chalk",
        "Credentials": [
          "MD",
          "PhD"
        ],
        "Address": {
          "StreetAddress": "312 Maple Dr. Suite 400",
          "City": "Verona",
          "State": "WI",
          "ZIP": "53593",
          "County": "Dane",
          "Country": "USA"
        },
        "EmailAddresses": [],
        "PhoneNumber": {
          "Office": "+16085559999"
        },
        "Location": {
          "Type": null,
          "Facility": null,
          "FacilityIdentifiers": [],
          "Department": null,
          "DepartmentIdentifiers": [],
          "Room": null
        }
      },
      {
        "ID": "8263749385",
        "IDType": "NPI",
        "FirstName": "Jim",
        "LastName": "Mica",
        "Credentials": [
          "RN"
        ],
        "Address": {
          "StreetAddress": "5235 Kennedy Ave.",
          "City": "Creve Cour",
          "State": "MO",
          "ZIP": "63141",
          "County": "Saint Louis",
          "Country": "USA"
        },
        "EmailAddresses": [],
        "PhoneNumber": {
          "Office": "+13145557777"
        },
        "Location": {
          "Type": null,
          "Facility": null,
          "FacilityIdentifiers": [],
          "Department": null,
          "DepartmentIdentifiers": [],
          "Room": null
        }
      }
    ],
    "Components": []
  },
  "Orders": [
    {
      "ID": 123456,
      "Name": "Stress Test"
    }
  ]
}
```
