# PatientEducation New
This data model communicates provider-initiated assignments to your system so the patient can view or act on content within your app. You can notify the provider when a patient progresses or completes the assignments.
`PatientEducation` event types are usually triggered from the EHR system when the clinician creates or updates a patient’s educational plan. This is commonly used for inpatient settings to help prevent readmissions.
> **Patient education use cases**
>
> Patient education can be used throughout the patient journey.
>
> - Before an appointment: Patients may receive educational materials to prepare them for an upcoming appointment so they know what to expect during an outpatient visit.
> - During an inpatient stay: Patients may received educational assignments during free time of an inpatient stay to prepare them for maintaining health after discharge.
> - After an appointment: Patients may receive post-visit education to ensure care plan adherence, like correct medication use, diet, or physical activity.
> **EHR support for PatientEducation**
>
> The `PatientEducation` data model is generally used when connecting to providers with a strong focus on patient education and an EHR system with robust interfacing capabilities. Typically, EHR systems make educational assignments available via PPR HL7v2-based messages or their own proprietary APIs.
This data model has event types that allow you to:
- receive a notification for new, updated, or deleted patient assignments.
Receive a notification when a provider adds new education assignments to a patient's chart.
Status: Beta
## Request body
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Meta` | object | Yes | |
| `Meta.DataModel` | string | Yes | PatientEducation |
| `Meta.EventType` | string | Yes | New |
| `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 |
| `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 |
| `Education` | Array of object | Yes | Education concepts |
| `Education[].Subject` | object | Yes | Subject of the education concept |
| `Education[].Subject.Code` | string | Yes | Code for the education subject |
| `Education[].Subject.Codeset` | string or null | No | Code set used to identify the education subject |
| `Education[].Subject.Description` | string or null | No | Description of the education subject |
| `Education[].InstanceID` | string or null | No | Unique ID that is assigned to the instance of the education resource |
| `Education[].CreatedDateTime` | string or null | No | The date and time the instance of the education resource was assigned. *[ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Education[].Status` | string or null | No | The status of the instance of the education resource. *Values will be one of the following: Active, Resolved, Deleted* |
| `Education[].ActionStatus` | string or null | No | The action taken on the instance of education resource. *Values will be one of the following: Assign, Delete, Update* |
| `Education[].ActionDateTime` | string or null | No | The date and time the action was taken on the instance of education resource. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Education[].Assignments` | Array of object | No | List of assigned patient education resources. Education assignments can be videos, handouts, etc. |
| `Education[].Assignments[].Code` | string or null | No | Code for the assignment |
| `Education[].Assignments[].Codeset` | string or null | No | Code set used to identify the assignment |
| `Education[].Assignments[].Description` | string or null | No | Description of the assignment |
| `Education[].Assignments[].Topic` | object | No | Topic of the education assignment |
| `Education[].Assignments[].Topic.Code` | string or null | No | Code for the assignment topic |
| `Education[].Assignments[].Topic.Codeset` | string or null | No | Code set used to identify the assignment topic |
| `Education[].Assignments[].Topic.Description` | string or null | No | Description of the assignment topic |
| `Education[].Assignments[].InstanceID` | string or null | No | Unique ID that is assigned to the instance of the education resource |
| `Education[].Assignments[].CreatedDateTime` | string or null | No | The date and time the instance of the education assignment was created. *[ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Education[].Assignments[].Status` | string or null | No | The status of the instance of the education assignment. *Values will be one of the following: Active, Resolved, Deleted* |
| `Education[].Assignments[].ActionStatus` | string or null | No | The action taken on the instance of education assignment. *Values will be one of the following: Assign, Delete, Update* |
| `Education[].Assignments[].ActionDateTime` | string or null | No | The date and time the action was taken on the instance of education assignment. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Education[].Assignments[].Assignees` | Array of object | No | The list of assignees associated to the education assignment |
| `Education[].Assignments[].Assignees[].Learner` | string or null | No | The learner type assigned. *Example: Patient, Parent, Caregiver* |
| `Education[].Assignments[].Assignees[].ContentType` | string or null | No | The type of content assigned to the learner. *Example: Video, pamphlet, demonstration* |
| `Education[].Assignments[].Assignees[].Readiness` | string or null | No | An indication of how eager the learner is to engage in the education. *Example: Eager, Accepting, Unwilling* |
| `Education[].Assignments[].Assignees[].Response` | string or null | No | The response of the learner once the education is complete. *Example: Verbalized understanding, Cannot demonstrate understanding* |
| `Education[].Assignments[].Assignees[].Notes` | Array of string | No | Notes about the assignee's assignment |
| `Visit` | object | No | |
| `Visit.VisitNumber` | string or null | No | Visit Number. *Unique ID of a single visit* |
| `Visit.AccountNumber` | string or null | No | Account Number. *An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.* |
| `Visit.PatientClass` | string or null | No | Patient class is used in many EHRs to determine where to put the patient. *Examples: Inpatient, Outpatient, Emergency* |
| `Visit.VisitDateTime` | string or null | No | DateTime of visit or the arrival time of the visit or admission. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Visit.AttendingProvider` | object | No | |
| `Visit.AttendingProvider.NPI` | string or null | No | NPI of the attending provider |
| `Visit.AttendingProvider.ID` | string or null | No | ID of the attending provider. *This ID is often required for Inpatient Visits.* |
| `Visit.AttendingProvider.IDType` | string or null | No | ID type of the ID for the attending provider |
| `Visit.AttendingProvider.FirstName` | string or null | No | First name of the attending provider |
| `Visit.AttendingProvider.LastName` | string or null | No | Last name of the attending provider |
| `Visit.AttendingProvider.Credentials` | Array of string | No | List of credentials for the attending provider. *e.g. MD, PhD* |
| `Visit.AttendingProvider.Address` | object | No | Provider's address |
| `Visit.AttendingProvider.Address.StreetAddress` | string or null | No | Street address |
| `Visit.AttendingProvider.Address.City` | string or null | No | City |
| `Visit.AttendingProvider.Address.State` | string or null | No | State |
| `Visit.AttendingProvider.Address.ZIP` | string or null | No | ZIP |
| `Visit.AttendingProvider.Address.County` | string or null | No | County |
| `Visit.AttendingProvider.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.AttendingProvider.EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Visit.AttendingProvider.PhoneNumber` | object | No | |
| `Visit.AttendingProvider.PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Visit.AttendingProvider.Location` | object | No | Provider's location |
| `Visit.AttendingProvider.Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Visit.AttendingProvider.Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Visit.AttendingProvider.Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Visit.AttendingProvider.Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Visit.AttendingProvider.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.AttendingProvider.Location.Department` | string or null | No | Department |
| `Visit.AttendingProvider.Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Visit.AttendingProvider.Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Visit.AttendingProvider.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.AttendingProvider.Location.Room` | string or null | No | Room. *Example: 136* |
| `Visit.ConsultingProvider` | object | No | |
| `Visit.ConsultingProvider.NPI` | string or null | No | NPI of the consulting provider |
| `Visit.ConsultingProvider.ID` | string or null | No | ID of the consulting provider. *This ID is often required for Inpatient Visits.* |
| `Visit.ConsultingProvider.IDType` | string or null | No | ID type of the ID for the consulting provider |
| `Visit.ConsultingProvider.FirstName` | string or null | No | First name of the consulting provider |
| `Visit.ConsultingProvider.LastName` | string or null | No | Last name of the consulting provider |
| `Visit.ConsultingProvider.Credentials` | Array of string | No | List of credentials for the consulting provider. *e.g. MD, PhD* |
| `Visit.ConsultingProvider.Address` | object | No | Provider's address |
| `Visit.ConsultingProvider.Address.StreetAddress` | string or null | No | Street address |
| `Visit.ConsultingProvider.Address.City` | string or null | No | City |
| `Visit.ConsultingProvider.Address.State` | string or null | No | State |
| `Visit.ConsultingProvider.Address.ZIP` | string or null | No | ZIP |
| `Visit.ConsultingProvider.Address.County` | string or null | No | County |
| `Visit.ConsultingProvider.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.ConsultingProvider.EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Visit.ConsultingProvider.PhoneNumber` | object | No | |
| `Visit.ConsultingProvider.PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Visit.ConsultingProvider.Location` | object | No | Provider's location |
| `Visit.ConsultingProvider.Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Visit.ConsultingProvider.Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Visit.ConsultingProvider.Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Visit.ConsultingProvider.Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Visit.ConsultingProvider.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.ConsultingProvider.Location.Department` | string or null | No | Department |
| `Visit.ConsultingProvider.Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Visit.ConsultingProvider.Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Visit.ConsultingProvider.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.ConsultingProvider.Location.Room` | string or null | No | Room. *Example: 136* |
| `Visit.ReferringProvider` | object | No | |
| `Visit.ReferringProvider.NPI` | string or null | No | NPI of the referring provider |
| `Visit.ReferringProvider.ID` | string or null | No | ID of the referring provider. *This ID is often required for Inpatient Visits.* |
| `Visit.ReferringProvider.IDType` | string or null | No | ID type of the ID for the referring provider |
| `Visit.ReferringProvider.FirstName` | string or null | No | First name of the referring provider |
| `Visit.ReferringProvider.LastName` | string or null | No | Last name of the referring provider |
| `Visit.ReferringProvider.Credentials` | Array of string | No | List of credentials for the referring provider. *e.g. MD, PhD* |
| `Visit.ReferringProvider.Address` | object | No | Provider's address |
| `Visit.ReferringProvider.Address.StreetAddress` | string or null | No | Street address |
| `Visit.ReferringProvider.Address.City` | string or null | No | City |
| `Visit.ReferringProvider.Address.State` | string or null | No | State |
| `Visit.ReferringProvider.Address.ZIP` | string or null | No | ZIP |
| `Visit.ReferringProvider.Address.County` | string or null | No | County |
| `Visit.ReferringProvider.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.ReferringProvider.EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Visit.ReferringProvider.PhoneNumber` | object | No | |
| `Visit.ReferringProvider.PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Visit.ReferringProvider.Location` | object | No | Provider's location |
| `Visit.ReferringProvider.Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Visit.ReferringProvider.Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Visit.ReferringProvider.Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Visit.ReferringProvider.Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Visit.ReferringProvider.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.ReferringProvider.Location.Department` | string or null | No | Department |
| `Visit.ReferringProvider.Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Visit.ReferringProvider.Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Visit.ReferringProvider.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.ReferringProvider.Location.Room` | string or null | No | Room. *Example: 136* |
| `Visit.Location` | object | No | Location of the visit |
| `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* |
## Example
```json
{
"Meta": {
"DataModel": "PatientEducation",
"EventType": "New",
"EventDateTime": "2026-11-13T22:05:58.042Z",
"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": "994002",
"IDType": "MRN"
}
],
"Demographics": {
"FirstName": "Ase",
"MiddleName": null,
"LastName": "Nzesi",
"DOB": "1978-01-25",
"SSN": "111-22-3333",
"Sex": "Female",
"Race": "Black",
"IsHispanic": false,
"Religion": null,
"MaritalStatus": "Married",
"IsDeceased": false,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675310",
"Office": null,
"Mobile": null
},
"EmailAddresses": [
"ase@nzesi.th"
],
"Language": "en",
"Citizenship": [
"US",
"TH",
"CR"
],
"Address": {
"StreetAddress": "Suan Dok Soi 6/3",
"City": "Chaing Mai",
"State": "Chang Wat Chang Mai",
"ZIP": "50200",
"County": "Amphoe Mueang Chiang Mai",
"Country": "Thailand"
}
},
"Notes": []
},
"Visit": {
"VisitNumber": "3498128348",
"AccountNumber": "12945932",
"PatientClass": "Inpatient",
"VisitDateTime": "2026-11-13T22:05:57.923Z",
"AttendingProvider": {
"NPI": null,
"ID": "426986",
"IDType": "NCT",
"FirstName": "Krittiya",
"LastName": "Somaketarin",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "8 Bunrueang Rit Rd",
"City": "Chiang Mai",
"State": "Chang Wat Chiang Mai",
"ZIP": "50200",
"County": "Amphoe Mueang Chiang Mai",
"Country": "Thailand"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+6653920300"
},
"Location": {
"Type": "Department",
"Facility": "Medical Center",
"FacilityIdentifiers": [],
"Department": "Obstetrics and Gynaecology",
"DepartmentIdentifiers": [],
"Room": "446"
}
},
"ConsultingProvider": {
"NPI": null,
"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
}
},
"ReferringProvider": {
"NPI": null,
"ID": "12981294",
"IDType": "NCT",
"FirstName": "Carol",
"LastName": "Fujiyoshi",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "3-3420 Kuhio Hwy Suite B",
"City": "Lihue",
"State": "HI",
"ZIP": "96766",
"County": "Kauai",
"Country": "United States"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+18082451511"
},
"Location": {
"Type": "Hawaii Pacific Health Hospital",
"Facility": "Wilcox Medical Center",
"FacilityIdentifiers": [],
"Department": "Obstetrics and Gynecology",
"DepartmentIdentifiers": [],
"Room": "32"
}
},
"Location": {
"Type": "Inpatient",
"Facility": "Chiang Mai Ram Hospital",
"FacilityIdentifiers": [],
"Department": "MA",
"DepartmentIdentifiers": [],
"Room": "13",
"Bed": "A"
}
},
"Education": [
{
"Subject": {
"Code": "DN-01",
"Codeset": null,
"Description": "Diet and Nutrition"
},
"InstanceID": "20898465",
"CreatedDateTime": "2026-11-13T22:05:58.204Z",
"Status": "Active",
"ActionStatus": "Assign",
"ActionDateTime": null,
"Assignments": [
{
"Code": "DN-PREG-01A",
"Codeset": "HCOPATED",
"Description": "Diet and Nutrition in Pregnancy - Prenatal Vitamins",
"Topic": {
"Code": "DN-PREG-01",
"Codeset": "HCOPATED",
"Description": "Diet and Nutrition in Pregnancy"
},
"InstanceID": "87300586",
"CreatedDateTime": "2026-11-13T22:05:57.923Z",
"Status": "Active",
"ActionStatus": "Assign",
"ActionDateTime": null,
"Assignees": [
{
"Learner": "Patient",
"ContentType": "Video",
"Readiness": "Eager",
"Response": null,
"Notes": []
}
]
}
]
}
]
}
```