# Financial AccountUpdate

This data model conveys when the patient owes something for a medication, lab, test, or other care (e.g., bed charges). It contains details about the product or service, as well as details like date, time, amounts, and participating organizations and persons. 

Providers typically use `Financial` for billing and internal cost allocation. 

This data model has event types that allow you to:

- post a new charge to a patient's account; or
- update a charge on a patient's account. 

> **EHR support for Financial**
>
> Almost all EHR systems support the `Financial` data model to facilitate financial transactions between the main EHR system, third-party systems producing charges, and any external billing systems. Typically, this is facilitated via a DFT HL7v2 interface or proprietary API.

> **Claim vs. Financial data model**
>
> `Claim` is generally a summary of patient care that’s sent or received after an inpatient admission or outpatient encounter is concluded. 
>
> `Financial` is for handling financial charges on the fly during a patient’s care.

Update a charge on a patient's account. 

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Meta` | object | Yes |  |
| `Meta.DataModel` | string | Yes | Financial |
| `Meta.EventType` | string | Yes | AccountUpdate |
| `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 |
| `Visit` | object | No | The visit that relates to this account update. |
| `Visit.VisitDateTime` | string or null | No | DateTime of visit or the arrival time of the admission. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `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.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* |
| `Visit.Location.Address` | object | No | Physical address |
| `Visit.Location.Address.StreetAddress` | string or null | No | Street address |
| `Visit.Location.Address.City` | string or null | No | City |
| `Visit.Location.Address.State` | string or null | No | State |
| `Visit.Location.Address.ZIP` | string or null | No | ZIP |
| `Visit.Location.Address.County` | string or null | No | County |
| `Visit.Location.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` | object | No |  |
| `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.ReferringProvider` | object | No |  |
| `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.Guarantor` | object | No | Person ultimately responsible for the bill of the appointment |
| `Visit.Guarantor.Number` | string or null | No | Number of the guarantor |
| `Visit.Guarantor.FirstName` | string or null | No | First name |
| `Visit.Guarantor.MiddleName` | string or null | No | Middle name |
| `Visit.Guarantor.LastName` | string or null | No | Last name |
| `Visit.Guarantor.SSN` | string or null | No | Guarantor's social security number |
| `Visit.Guarantor.DOB` | string or null | No | Guarantor's date of birth. *In [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Visit.Guarantor.Sex` | string or null | No | Guarantor's sex. *One of the following: Female, Male, Unknown, Other* Value set ca03256a-4fd3-4b3d-8e37-912cd22b5cda: Female, Male, Unknown, Other, Nonbinary, Prefer not to answer |
| `Visit.Guarantor.Spouse` | object | No |  |
| `Visit.Guarantor.Spouse.FirstName` | string or null | No | Spouse's first name |
| `Visit.Guarantor.Spouse.LastName` | string or null | No | Spouse's last name |
| `Visit.Guarantor.Address` | object | No | Address of the guarantor |
| `Visit.Guarantor.Address.StreetAddress` | string or null | No | Street address |
| `Visit.Guarantor.Address.City` | string or null | No | City |
| `Visit.Guarantor.Address.State` | string or null | No | State |
| `Visit.Guarantor.Address.ZIP` | string or null | No | ZIP |
| `Visit.Guarantor.Address.County` | string or null | No | County |
| `Visit.Guarantor.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.Guarantor.PhoneNumber` | object | No |  |
| `Visit.Guarantor.PhoneNumber.Home` | string or null | No | Home phone number. *In E. 164 Format (i.e. +16085551234)* |
| `Visit.Guarantor.PhoneNumber.Business` | string or null | No | Business phone number. *In E. 164 Format (i.e. +16085551234)* |
| `Visit.Guarantor.PhoneNumber.Mobile` | string or null | No | Mobile phone number. *In E. 164 Format (i.e. +16085551234)* |
| `Visit.Guarantor.EmailAddresses` | Array of string | No | Guarantor's email address(es) |
| `Visit.Guarantor.Type` | string or null | No | Type of guarantor. *E.g. institution, individual* |
| `Visit.Guarantor.RelationToPatient` | string or null | No | Relation to the patient. Value set 17a07a93-1898-4d62-988f-6a2336aeb92e: Self, Spouse, Other, Child, Life Partner, Employer, Father, Grandparent, Mother, Unknown, Sibling, Parent, Grandchild, Guardian, Aunt, Uncle, Brother, Ward Of Court, Cadaver Donor, Wife, Employee, Daughter, Significant Other, Foster Father, Other Adult, Foster Mother, Family/Other, Friend, Granddaughter, Grandfather, Grandmother, Grandson, Guar of Handicapped Pt, Husband, Injured Plaintiff, Minor Dependent, Organ Donor, Step Father, Sister, Step Mother, Sponsor, Son, Self/Same As Patient, Nephew, Niece, Foster Child, Step Child, Step Parent, Legal Guardian |
| `Visit.Guarantor.Employer` | object | No |  |
| `Visit.Guarantor.Employer.Name` | string or null | No | Employer's name |
| `Visit.Guarantor.Employer.Address` | object | No | Employer's address |
| `Visit.Guarantor.Employer.Address.StreetAddress` | string or null | No | Street address |
| `Visit.Guarantor.Employer.Address.City` | string or null | No | City |
| `Visit.Guarantor.Employer.Address.State` | string or null | No | State |
| `Visit.Guarantor.Employer.Address.ZIP` | string or null | No | ZIP |
| `Visit.Guarantor.Employer.Address.County` | string or null | No | County |
| `Visit.Guarantor.Employer.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.Guarantor.Employer.PhoneNumber` | string or null | No | Employer phone number. *In E. 164 Format (i.e. +16085551234)* |
| `Visit.ConsultingProvider` | object | No |  |
| `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.DischargeDateTime` | string or null | No | DateTime the patient was discharged. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Visit.Diagnoses` | Array of object | No | List of diagnoses associated with the visit |
| `Visit.Diagnoses[].Code` | string or null | No | Code for the diagnosis |
| `Visit.Diagnoses[].Codeset` | string or null | No | Code set used to identify the diagnosis. *One of the following: ICD-9, ICD-10, HCPCS, CPT* Value set 5730b002-4623-48de-8336-a38e57989cf5: ICD-10, ICD-9, HCPCS, CPT, Unknown, SNOMED CT |
| `Visit.Diagnoses[].Name` | string or null | No | Name of the diagnosis |
| `Visit.Diagnoses[].Type` | string or null | No | Type of the diagnosis. Value set 355dbdb5-f708-4f35-8fb2-85ba4bbe67b7: Unknown, Admitting, Final, Self, Working, Principal |
| `Visit.Diagnoses[].DocumentedDateTime` | string or null | No | DateTime the diagnosis was documented. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Visit.DiagnosisRelatedGroup` | number or null | No | Diagnosis Related Group for this visit |
| `Visit.DiagnosisRelatedGroupType` | number or null | No | Type or System of Diagnosis Related Group for this visit. *Examples include Medicare (CMS-DRG), Refined (R-D DRG), All Patient (AP-DRG), etc* |
| `Visit.Balance` | number or null | No | Patient balance due for this visit. *This field depends on whether or not the sending system has billing functionality, and whether they calculate this field.* |
| `Visit.Insurances` | Array of object | No | List of insurance coverages for the patient |
| `Visit.Insurances[].Plan` | object | No |  |
| `Visit.Insurances[].Plan.ID` | string or null | No | Identifier of insurance plan |
| `Visit.Insurances[].Plan.IDType` | string or null | No | ID type of insurance plan |
| `Visit.Insurances[].Plan.Name` | string or null | No | Name of insurance plan |
| `Visit.Insurances[].Plan.Type` | string or null | No | Type of insurance plan |
| `Visit.Insurances[].MemberNumber` | string or null | No | Patient member number |
| `Visit.Insurances[].Company` | object | No |  |
| `Visit.Insurances[].Company.ID` | string or null | No | ID of insurance company (payor) |
| `Visit.Insurances[].Company.IDType` | string or null | No | ID type of insurance company (payor) |
| `Visit.Insurances[].Company.Name` | string or null | No | Name of insurance company (payor) |
| `Visit.Insurances[].Company.Address` | object | No | Insurance company's address |
| `Visit.Insurances[].Company.Address.StreetAddress` | string or null | No | Street address |
| `Visit.Insurances[].Company.Address.City` | string or null | No | City |
| `Visit.Insurances[].Company.Address.State` | string or null | No | State |
| `Visit.Insurances[].Company.Address.ZIP` | string or null | No | ZIP |
| `Visit.Insurances[].Company.Address.County` | string or null | No | County |
| `Visit.Insurances[].Company.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.Insurances[].Company.PhoneNumber` | string or null | No | Insurance companys phone number. *In E. 164 Format (i.e. +16085551234)* |
| `Visit.Insurances[].GroupNumber` | string or null | No | Insurance policy group number |
| `Visit.Insurances[].GroupName` | string or null | No | Insurance policy group name |
| `Visit.Insurances[].EffectiveDate` | string or null | No | Effect date of this insurance policy. *In [YYYY-MM-DD format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Visit.Insurances[].ExpirationDate` | string or null | No | Expiration date of this insurance policy. *In [YYYY-MM-DD format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Visit.Insurances[].PolicyNumber` | string or null | No | Insurance policy number |
| `Visit.Insurances[].Priority` | string or null | No | The insurance priority sequence. *If the insurance works in conjunction with other insurance plans, this field contains priority sequence.* Value set 39c37420-b45f-4ec0-b3af-15520b49c202: 1, 2, 3, 4 |
| `Visit.Insurances[].AgreementType` | string or null | No | Type of insurance agreement. Value set db651e3c-4a48-40e3-bc45-eddf613d0ff3: Standard, Unified, Maternity |
| `Visit.Insurances[].CoverageType` | string or null | No | Type of insurance agreement. *Indicates who will be receiving the bill for the service.* Value set aaa2e196-f275-48cd-80ab-6ccbbbdb6824: Patient, Clinic, Insurance, Other |
| `Visit.Insurances[].Insured` | object | No | Individual who has the agreement with the insurance company for the related policy |
| `Visit.Insurances[].Insured.Identifiers` | Array of object | No | List of IDs and ID types that identify the insured |
| `Visit.Insurances[].Insured.Identifiers[].ID` | string or null | No | ID for the insured |
| `Visit.Insurances[].Insured.Identifiers[].IDType` | string or null | No | Type of ID. *E.g. MRN, EPI* |
| `Visit.Insurances[].Insured.LastName` | string or null | No | Last name of the insured |
| `Visit.Insurances[].Insured.MiddleName` | string or null | No | Middle name of the insured |
| `Visit.Insurances[].Insured.FirstName` | string or null | No | First name of the insured |
| `Visit.Insurances[].Insured.SSN` | string or null | No | Insured's social security number |
| `Visit.Insurances[].Insured.Relationship` | string or null | No | Relationship of the insured to the patient. Value set 17a07a93-1898-4d62-988f-6a2336aeb92e: Self, Spouse, Other, Child, Life Partner, Employer, Father, Grandparent, Mother, Unknown, Sibling, Parent, Grandchild, Guardian, Aunt, Uncle, Brother, Ward Of Court, Cadaver Donor, Wife, Employee, Daughter, Significant Other, Foster Father, Other Adult, Foster Mother, Family/Other, Friend, Granddaughter, Grandfather, Grandmother, Grandson, Guar of Handicapped Pt, Husband, Injured Plaintiff, Minor Dependent, Organ Donor, Step Father, Sister, Step Mother, Sponsor, Son, Self/Same As Patient, Nephew, Niece, Foster Child, Step Child, Step Parent, Legal Guardian |
| `Visit.Insurances[].Insured.DOB` | string or null | No | Date of birth of the insured. *In [YYYY-MM-DD format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Visit.Insurances[].Insured.Sex` | string or null | No | Sex of the insured. Value set ca03256a-4fd3-4b3d-8e37-912cd22b5cda: Female, Male, Unknown, Other, Nonbinary, Prefer not to answer |
| `Visit.Insurances[].Insured.Address` | object | No | Address of the insured |
| `Visit.Insurances[].Insured.Address.StreetAddress` | string or null | No | Street address |
| `Visit.Insurances[].Insured.Address.City` | string or null | No | City |
| `Visit.Insurances[].Insured.Address.State` | string or null | No | State |
| `Visit.Insurances[].Insured.Address.ZIP` | string or null | No | ZIP |
| `Visit.Insurances[].Insured.Address.County` | string or null | No | County |
| `Visit.Insurances[].Insured.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.Procedures` | Array of object | No | Procedures associated with the visit |
| `Visit.Procedures[].Code` | string or null | No | Code for the procedure |
| `Visit.Procedures[].Codeset` | string or null | No | Code set used to identify the procedure. *CPT, HCPCS, SNOMED, or LOINC. If no code set is specified, a health system specific identifier is being used.* |
| `Visit.Procedures[].Description` | string or null | No | Description of the procedure |
| `Visit.Procedures[].PerformedDateTime` | string or null | No | The DateTime the procedure was performed |
| `Visit.Procedures[].Performers` | Array of object | No |  |
| `Visit.Procedures[].Performers[].ID` | string or null | No | ID of the performer. *This ID is often required for Inpatient Visits.* |
| `Visit.Procedures[].Performers[].IDType` | string or null | No | ID type of the ID for the performer |
| `Visit.Procedures[].Performers[].FirstName` | string or null | No | First name of the performer |
| `Visit.Procedures[].Performers[].LastName` | string or null | No | Last name of the performer |
| `Visit.Procedures[].Performers[].Credentials` | Array of string | No | List of credentials for the performer. *e.g. MD, PhD* |
| `Visit.Procedures[].Performers[].Address` | object | No | Provider's address |
| `Visit.Procedures[].Performers[].Address.StreetAddress` | string or null | No | Street address |
| `Visit.Procedures[].Performers[].Address.City` | string or null | No | City |
| `Visit.Procedures[].Performers[].Address.State` | string or null | No | State |
| `Visit.Procedures[].Performers[].Address.ZIP` | string or null | No | ZIP |
| `Visit.Procedures[].Performers[].Address.County` | string or null | No | County |
| `Visit.Procedures[].Performers[].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.Procedures[].Performers[].EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Visit.Procedures[].Performers[].PhoneNumber` | object | No |  |
| `Visit.Procedures[].Performers[].PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Visit.Procedures[].Performers[].Location` | object | No | Provider's location |
| `Visit.Procedures[].Performers[].Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Visit.Procedures[].Performers[].Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Visit.Procedures[].Performers[].Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Visit.Procedures[].Performers[].Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Visit.Procedures[].Performers[].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.Procedures[].Performers[].Location.Department` | string or null | No | Department |
| `Visit.Procedures[].Performers[].Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Visit.Procedures[].Performers[].Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Visit.Procedures[].Performers[].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.Procedures[].Performers[].Location.Room` | string or null | No | Room. *Example: 136* |

## Example

```json
{
  "Meta": {
    "DataModel": "Financial",
    "EventType": "AccountUpdate",
    "EventDateTime": "2026-11-20T22:18:53.621Z",
    "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": {
    "VisitDateTime": "2018-01-01T00:00:01Z",
    "VisitNumber": "1234",
    "AccountNumber": null,
    "PatientClass": null,
    "Location": {
      "Type": "Inpatient",
      "Facility": "RES General Hospital",
      "FacilityIdentifiers": [],
      "Department": "3N",
      "DepartmentIdentifiers": [],
      "Room": "136",
      "Bed": "B",
      "Address": {
        "StreetAddress": "9509 Integration Ln",
        "City": "Madison",
        "State": "WI",
        "ZIP": "53719",
        "County": "Dane",
        "Country": "US"
      }
    },
    "AttendingProvider": {
      "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": {
      "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
      }
    },
    "Guarantor": {
      "Number": null,
      "FirstName": null,
      "MiddleName": null,
      "LastName": null,
      "SSN": null,
      "DOB": null,
      "Sex": null,
      "Spouse": {
        "FirstName": null,
        "LastName": null
      },
      "Address": {
        "StreetAddress": null,
        "City": null,
        "State": null,
        "ZIP": null,
        "County": null,
        "Country": null
      },
      "PhoneNumber": {
        "Home": null,
        "Business": null,
        "Mobile": null
      },
      "EmailAddresses": [],
      "Type": null,
      "RelationToPatient": null,
      "Employer": {
        "Name": null,
        "Address": {
          "StreetAddress": null,
          "City": null,
          "State": null,
          "ZIP": null,
          "County": null,
          "Country": null
        },
        "PhoneNumber": null
      }
    },
    "ConsultingProvider": {
      "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
      }
    },
    "DischargeDateTime": "2018-01-05T00:00:00Z",
    "Diagnoses": [],
    "DiagnosisRelatedGroup": null,
    "DiagnosisRelatedGroupType": null,
    "Balance": null,
    "Insurances": [
      {
        "Plan": {
          "ID": "31572",
          "IDType": "Payor ID",
          "Name": "HMO Deductible Plan",
          "Type": null
        },
        "MemberNumber": null,
        "Company": {
          "ID": "60054",
          "IDType": null,
          "Name": "aetna (60054 0131)",
          "Address": {
            "StreetAddress": "PO Box 14080",
            "City": "Lexington",
            "State": "KY",
            "ZIP": "40512-4079",
            "County": "Fayette",
            "Country": "US"
          },
          "PhoneNumber": "+18089541123"
        },
        "GroupNumber": "847025-024-0009",
        "GroupName": "Accelerator Labs",
        "EffectiveDate": "2015-01-01",
        "ExpirationDate": "2020-12-31",
        "PolicyNumber": "9140860055",
        "Priority": null,
        "AgreementType": null,
        "CoverageType": null,
        "Insured": {
          "Identifiers": [],
          "LastName": null,
          "MiddleName": null,
          "FirstName": null,
          "SSN": null,
          "Relationship": null,
          "DOB": null,
          "Sex": null,
          "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
          }
        }
      }
    ],
    "Procedures": [
      {
        "Code": "027034Z",
        "Codeset": "I10PCS",
        "Description": "Dilation of Coronary Artery",
        "PerformedDateTime": null,
        "Performers": [
          {
            "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
            }
          }
        ]
      }
    ]
  }
}
```
