# Referral New

This data model communicates patient demographic and clinical information from a referring provider to send the patient's case to another provider. 

This typically differs from a consultation, where a provider may review a patient without assuming authority over the patient’s care. Referrals can be internal to an organization (e.g., from one department to another) or external between organizations.

A referral is useful to maintain the administrative aspects of a referral order. You can receive notifications when: 

- A new referral order is placed.
- An existing referral order is modified or canceled. 
- An authorization review is requested or responded to. 

Or, you can search for referral orders based on a patient's demographic and insurance information.

> **EHR support for Referral**
>
> EHR systems with advanced referral management capabilities and robust interfacing libraries typically support the `Referral` data model via an HL7v2 REF interface or their own proprietary API.
>
> Alternatively, some EHR systems may not support the `Referral` data model. However, since a referral can be a specific type of order when it pertains to a transfer of patient responsibility for specialty care, an EHR system may support creating a referral with the `Order` data model instead. Just note that you may not be able to update the referral details after it’s created. This customized type of workflow varies per EHR system. Work with your connection and your Technical Account Manager to determine which data model is best for your referral workflow.

Receive a notification when a new referral order is placed in the EHR system. 

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Meta` | object | Yes |  |
| `Meta.DataModel` | string | Yes | Referral |
| `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: 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 |
| `Patient.Contacts` | Array of object | No |  |
| `Patient.Contacts[].FirstName` | string or null | No | First name of the contact |
| `Patient.Contacts[].MiddleName` | string or null | No | Middle name of the contact |
| `Patient.Contacts[].LastName` | string or null | No | Last name of the contact |
| `Patient.Contacts[].Address` | object | No | Address of the contact |
| `Patient.Contacts[].Address.StreetAddress` | string or null | No | Street address |
| `Patient.Contacts[].Address.City` | string or null | No | City |
| `Patient.Contacts[].Address.State` | string or null | No | State |
| `Patient.Contacts[].Address.ZIP` | string or null | No | ZIP |
| `Patient.Contacts[].Address.County` | string or null | No | County |
| `Patient.Contacts[].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.Contacts[].PhoneNumber` | object | No |  |
| `Patient.Contacts[].PhoneNumber.Home` | string or null | No | Home phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Patient.Contacts[].PhoneNumber.Office` | string or null | No | Office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Patient.Contacts[].PhoneNumber.Mobile` | string or null | No | Mobile phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Patient.Contacts[].RelationToPatient` | string or null | No | Personal relationship to the patient. *e.x. Father, Spouse* Value set: 17a07a93-1898-4d62-988f-6a2336aeb92e |
| `Patient.Contacts[].EmailAddresses` | Array of string | No | Email address(es) of the contact person |
| `Patient.Contacts[].Roles` | Array of string | No | Role of this contact for the patient. *e.x. Employer, Emergency Contact* |
| `Patient.Guarantor` | object | No | Person ultimately responsible for the bill of the appointment |
| `Patient.Guarantor.Number` | string or null | No | Number of the guarantor |
| `Patient.Guarantor.FirstName` | string or null | No | First name |
| `Patient.Guarantor.MiddleName` | string or null | No | Middle name |
| `Patient.Guarantor.LastName` | string or null | No | Last name |
| `Patient.Guarantor.SSN` | string or null | No | Guarantor's social security number |
| `Patient.Guarantor.DOB` | string or null | No | Guarantor's date of birth. *In [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Patient.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 |
| `Patient.Guarantor.Spouse` | object | No |  |
| `Patient.Guarantor.Spouse.FirstName` | string or null | No | Spouse's first name |
| `Patient.Guarantor.Spouse.LastName` | string or null | No | Spouse's last name |
| `Patient.Guarantor.Address` | object | No | Address of the guarantor |
| `Patient.Guarantor.Address.StreetAddress` | string or null | No | Street address |
| `Patient.Guarantor.Address.City` | string or null | No | City |
| `Patient.Guarantor.Address.State` | string or null | No | State |
| `Patient.Guarantor.Address.ZIP` | string or null | No | ZIP |
| `Patient.Guarantor.Address.County` | string or null | No | County |
| `Patient.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 |
| `Patient.Guarantor.PhoneNumber` | object | No |  |
| `Patient.Guarantor.PhoneNumber.Home` | string or null | No | Home phone number. *In E. 164 Format (i.e. +16085551234)* |
| `Patient.Guarantor.PhoneNumber.Business` | string or null | No | Business phone number. *In E. 164 Format (i.e. +16085551234)* |
| `Patient.Guarantor.PhoneNumber.Mobile` | string or null | No | Mobile phone number. *In E. 164 Format (i.e. +16085551234)* |
| `Patient.Guarantor.EmailAddresses` | Array of string | No | Guarantor's email address(es) |
| `Patient.Guarantor.Type` | string or null | No | Type of guarantor. *E.g. institution, individual* |
| `Patient.Guarantor.RelationToPatient` | string or null | No | Relation to the patient. Value set: 17a07a93-1898-4d62-988f-6a2336aeb92e |
| `Patient.Guarantor.Employer` | object | No |  |
| `Patient.Guarantor.Employer.Name` | string or null | No | Employer's name |
| `Patient.Guarantor.Employer.Address` | object | No | Employer's address |
| `Patient.Guarantor.Employer.Address.StreetAddress` | string or null | No | Street address |
| `Patient.Guarantor.Employer.Address.City` | string or null | No | City |
| `Patient.Guarantor.Employer.Address.State` | string or null | No | State |
| `Patient.Guarantor.Employer.Address.ZIP` | string or null | No | ZIP |
| `Patient.Guarantor.Employer.Address.County` | string or null | No | County |
| `Patient.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 |
| `Patient.Guarantor.Employer.PhoneNumber` | string or null | No | Employer phone number. *In E. 164 Format (i.e. +16085551234)* |
| `Patient.Insurances` | Array of object | No | List of insurance coverages for the patient |
| `Patient.Insurances[].Plan` | object | No |  |
| `Patient.Insurances[].Plan.ID` | string or null | No | Identifier of insurance plan |
| `Patient.Insurances[].Plan.IDType` | string or null | No | ID type of insurance plan |
| `Patient.Insurances[].Plan.Name` | string or null | No | Name of insurance plan |
| `Patient.Insurances[].Plan.Type` | string or null | No | Type of insurance plan |
| `Patient.Insurances[].MemberNumber` | string or null | No | Patient member number |
| `Patient.Insurances[].Company` | object | No |  |
| `Patient.Insurances[].Company.ID` | string or null | No | ID of insurance company (payor) |
| `Patient.Insurances[].Company.IDType` | string or null | No | ID type of insurance company (payor) |
| `Patient.Insurances[].Company.Name` | string or null | No | Name of insurance company (payor) |
| `Patient.Insurances[].Company.Address` | object | No | Insurance company's address |
| `Patient.Insurances[].Company.Address.StreetAddress` | string or null | No | Street address |
| `Patient.Insurances[].Company.Address.City` | string or null | No | City |
| `Patient.Insurances[].Company.Address.State` | string or null | No | State |
| `Patient.Insurances[].Company.Address.ZIP` | string or null | No | ZIP |
| `Patient.Insurances[].Company.Address.County` | string or null | No | County |
| `Patient.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 |
| `Patient.Insurances[].Company.PhoneNumber` | string or null | No | Insurance companys phone number. *In E. 164 Format (i.e. +16085551234)* |
| `Patient.Insurances[].GroupNumber` | string or null | No | Insurance policy group number |
| `Patient.Insurances[].GroupName` | string or null | No | Insurance policy group name |
| `Patient.Insurances[].EffectiveDate` | string or null | No | Effect date of this insurance policy. *In [YYYY-MM-DD format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Patient.Insurances[].ExpirationDate` | string or null | No | Expiration date of this insurance policy. *In [YYYY-MM-DD format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Patient.Insurances[].PolicyNumber` | string or null | No | Insurance policy number |
| `Patient.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 |
| `Patient.Insurances[].AgreementType` | string or null | No | Type of insurance agreement. Value set db651e3c-4a48-40e3-bc45-eddf613d0ff3: Standard, Unified, Maternity |
| `Patient.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 |
| `Patient.Insurances[].Insured` | object | No | Individual who has the agreement with the insurance company for the related policy |
| `Patient.Insurances[].Insured.Identifiers` | Array of object | No | List of IDs and ID types that identify the insured |
| `Patient.Insurances[].Insured.Identifiers[].ID` | string or null | No | ID for the insured |
| `Patient.Insurances[].Insured.Identifiers[].IDType` | string or null | No | Type of ID. *E.g. MRN, EPI* |
| `Patient.Insurances[].Insured.LastName` | string or null | No | Last name of the insured |
| `Patient.Insurances[].Insured.MiddleName` | string or null | No | Middle name of the insured |
| `Patient.Insurances[].Insured.FirstName` | string or null | No | First name of the insured |
| `Patient.Insurances[].Insured.SSN` | string or null | No | Insured's social security number |
| `Patient.Insurances[].Insured.Relationship` | string or null | No | Relationship of the insured to the patient. Value set: 17a07a93-1898-4d62-988f-6a2336aeb92e |
| `Patient.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)* |
| `Patient.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 |
| `Patient.Insurances[].Insured.Address` | object | No | Address of the insured |
| `Patient.Insurances[].Insured.Address.StreetAddress` | string or null | No | Street address |
| `Patient.Insurances[].Insured.Address.City` | string or null | No | City |
| `Patient.Insurances[].Insured.Address.State` | string or null | No | State |
| `Patient.Insurances[].Insured.Address.ZIP` | string or null | No | ZIP |
| `Patient.Insurances[].Insured.Address.County` | string or null | No | County |
| `Patient.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 |
| `Referral` | object | No |  |
| `Referral.ID` | string or null | No | The Health System ID of the referral |
| `Referral.IDType` | string or null | No | The ID type |
| `Referral.AlternateID` | string or null | No | The alternate ID of the referral, often used by external/3rd party systems |
| `Referral.Type` | string or null | No | The type of the referral. Value set b32cd624-09e6-407f-aec3-41dd579fb8b4: Other, Consultation, Laboratory, Radiology, Medical, Skilled Nursing, Home Care, Psychiatric |
| `Referral.Category` | string or null | No | The category of the referral. Value set 15610ad8-bc9f-4d61-86f7-f47405092379: Outpatient, Inpatient, Emergency, Ambulatory |
| `Referral.Priority` | string or null | No | The priority of the referral. Value set 5862051b-1d6f-48c2-a291-bc8452419e0a: STAT, ASAP, Routine |
| `Referral.Status` | string or null | No | The status of the referral. Value set 1ed16f2d-4bfe-49ba-8337-5d66f55d2e57: Accepted, Pending, Rejected, Expired, Closed |
| `Referral.DateTime` | string or null | No | The date and time the referral is considered active. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Referral.ExpirationDateTime` | string or null | No | The date and time the referral expires. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Referral.ProcessDateTime` | string or null | No | The date and time the referral was processed. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Referral.Reason` | string or null | No | The reason for the referral. Value set fe0214ba-6111-4f16-9056-a828d753c510: Patient Preference, Second Opinion, Provider Ordered, Work Load |
| `Referral.ProviderSpecialty` | string or null | No | The provider specialty of the referral |
| `Referral.DepartmentSpecialty` | string or null | No | The department specialty of the referral |
| `Referral.Notes` | Array of string | No | Referral Notes |
| `Referral.Authorization` | object | No |  |
| `Referral.Authorization.Plan` | object | No |  |
| `Referral.Authorization.Plan.ID` | string or null | No | The ID of the plan |
| `Referral.Authorization.Plan.IDType` | string or null | No | The ID type |
| `Referral.Authorization.Plan.Name` | string or null | No | The name of the plan |
| `Referral.Authorization.Company` | object | No |  |
| `Referral.Authorization.Company.ID` | string or null | No | The ID of the payor |
| `Referral.Authorization.Company.IDType` | string or null | No | The ID type |
| `Referral.Authorization.Company.Name` | string or null | No | The name of the payor |
| `Referral.Authorization.DateTime` | string or null | No | The date and time the authorization is effective. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Referral.Authorization.ExpirationDateTime` | string or null | No | The date and time the authorization expires. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Referral.Authorization.Number` | string or null | No | The identifier for the authorization assigned by the payor |
| `Referral.Authorization.ReimbursementLimit` | string or null | No | The reimbursement limit for this referral |
| `Referral.Authorization.RequestedTreatmentCount` | string or null | No | The number of treatments requested |
| `Referral.Authorization.RequestedTreatmentUnits` | string or null | No | The units associated to the treatment count. *e.g. 'instances' or 'days'* |
| `Referral.Authorization.AuthorizedTreatmentCount` | string or null | No | The number of treatments authorized |
| `Referral.Authorization.Notes` | Array of string | No | Notes about the authorizations |
| `Referral.Diagnoses` | Array of object | No | List of diagnoses |
| `Referral.Diagnoses[].Code` | string or null | No | Code for the diagnoses |
| `Referral.Diagnoses[].Codeset` | string or null | No | Code set used to identify the diagnoses. *One of the following: ICD-9, ICD-10, HCPCS, CPT* Value set: 5730b002-4623-48de-8336-a38e57989cf5 |
| `Referral.Diagnoses[].Name` | string or null | No | Name of the diagnoses |
| `Referral.Diagnoses[].Type` | string or null | No | Type of the diagnosis. Value set 355dbdb5-f708-4f35-8fb2-85ba4bbe67b7: Unknown, Admitting, Final, Self, Working, Principal |
| `Referral.Diagnoses[].DocumentedDateTime` | string or null | No | DateTime the diagnoses was documented. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Referral.Diagnoses[].Notes` | Array of string | No | Notes about the diagnosis |
| `Referral.Procedures` | Array of object | No | Ordered procedure |
| `Referral.Procedures[].Code` | string or null | No | Code for the procedure |
| `Referral.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.* |
| `Referral.Procedures[].Description` | string or null | No | Description of the procedure |
| `Referral.Procedures[].Notes` | Array of string | No | Notes about the procedure |
| `Referral.Procedures[].Quantity` | string or null | No | Number of instances for the procedure |
| `Referral.Procedures[].Units` | string or null | No | Related units associated to the procedure quantity |
| `Referral.Procedures[].Modifiers` | Array of string | No | Associated procedure modifiers |
| `Referral.Providers` | Array of object | No |  |
| `Referral.Providers[].ID` | string or null | No | ID of the provider. *This ID is often required for Inpatient Visits.* |
| `Referral.Providers[].IDType` | string or null | No | ID type of the ID for the provider |
| `Referral.Providers[].FirstName` | string or null | No | First name of the undefined |
| `Referral.Providers[].LastName` | string or null | No | Last name of the undefined |
| `Referral.Providers[].Credentials` | Array of string | No | List of credentials for the undefined. *e.g. MD, PhD* |
| `Referral.Providers[].Address` | object | No | Provider's address |
| `Referral.Providers[].Address.StreetAddress` | string or null | No | Street address |
| `Referral.Providers[].Address.City` | string or null | No | City |
| `Referral.Providers[].Address.State` | string or null | No | State |
| `Referral.Providers[].Address.ZIP` | string or null | No | ZIP |
| `Referral.Providers[].Address.County` | string or null | No | County |
| `Referral.Providers[].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 |
| `Referral.Providers[].EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Referral.Providers[].PhoneNumber` | object | No |  |
| `Referral.Providers[].PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Referral.Providers[].Type` | string or null | No | The type of provider. Value set 34b5bdb4-1fed-4bdb-a26b-b21d58b0629e: Referred To Provider, Referring Provider, Patient PCP, Other |
| `Referral.Providers[].ContactInfo` | string or null | No | Additional contact information for this provider |
| `Referral.Providers[].Location` | object | No | Provider's location |
| `Referral.Providers[].Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Referral.Providers[].Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Referral.Providers[].Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Referral.Providers[].Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Referral.Providers[].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* |
| `Referral.Providers[].Location.Department` | string or null | No | Department |
| `Referral.Providers[].Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Referral.Providers[].Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Referral.Providers[].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* |
| `Referral.Providers[].Location.Room` | string or null | No | Room. *Example: 136* |
| `Referral.Visit` | object | No |  |
| `Referral.Visit.VisitNumber` | string or null | No | Visit Number. *Unique ID of the visit associated to the referral* |
| `Visit` | object | No |  |
| `Visit.VisitNumber` | string or null | No | Visit Number. *Unique ID of the visit associated to the referral* |

## Example

```json
{
  "Meta": {
    "DataModel": "Referral",
    "EventType": "New",
    "EventDateTime": "2026-11-18T19:05:05.809Z",
    "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
  },
  "Referral": {
    "ID": "4356789876",
    "IDType": null,
    "AlternateID": "2133311",
    "Type": "Medical",
    "Category": "Outpatient",
    "Priority": "Routine",
    "Status": "Pending",
    "DateTime": "2015-05-05T00:00:00.000Z",
    "ExpirationDateTime": "2015-06-05T00:00:00.000Z",
    "ProcessDateTime": null,
    "Reason": "Provider Ordered",
    "ProviderSpecialty": null,
    "DepartmentSpecialty": null,
    "Notes": [],
    "Authorization": {
      "Plan": {
        "ID": "31572",
        "IDType": null,
        "Name": "HMO Deductible Plan"
      },
      "Company": {
        "ID": "60054",
        "IDType": null,
        "Name": "aetna (60054 0131)"
      },
      "DateTime": "2015-05-05T00:00:00.000Z",
      "ExpirationDateTime": "2015-06-05T00:00:00.000Z",
      "Number": "9140860055",
      "ReimbursementLimit": null,
      "RequestedTreatmentCount": null,
      "RequestedTreatmentUnits": null,
      "AuthorizedTreatmentCount": null,
      "Notes": []
    },
    "Diagnoses": [],
    "Procedures": [
      {
        "Code": "400500400",
        "Codeset": "CPT4",
        "Description": "Anticoag Therapy Referral",
        "Notes": [],
        "Quantity": null,
        "Units": null,
        "Modifiers": []
      }
    ],
    "Providers": [
      {
        "ID": "4236464757",
        "IDType": "NPI",
        "FirstName": "John",
        "LastName": "Slate",
        "Credentials": [
          "DO"
        ],
        "Address": {
          "StreetAddress": "500 First St.",
          "City": "Clayton",
          "State": "MO",
          "ZIP": "63105",
          "County": "Saint Louis",
          "Country": "USA"
        },
        "EmailAddresses": [],
        "PhoneNumber": {
          "Office": null
        },
        "Type": "Referring Provider",
        "ContactInfo": null,
        "Location": {
          "Type": null,
          "Facility": null,
          "FacilityIdentifiers": [],
          "Department": null,
          "DepartmentIdentifiers": [],
          "Room": null
        }
      }
    ],
    "Visit": {
      "VisitNumber": 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": [],
    "Contacts": [
      {
        "FirstName": "Barbara",
        "MiddleName": null,
        "LastName": "Bixby",
        "Address": {
          "StreetAddress": "4762 Hickory Street",
          "City": "Monroe",
          "State": "WI",
          "ZIP": "53566",
          "County": "Green",
          "Country": "US"
        },
        "PhoneNumber": {
          "Home": "+18088675303",
          "Office": "+17077543758",
          "Mobile": "+19189368865"
        },
        "RelationToPatient": "Mother",
        "EmailAddresses": [
          "barb.bixby@test.net"
        ],
        "Roles": [
          "Emergency Contact"
        ]
      }
    ],
    "Guarantor": {
      "Number": "10001910",
      "FirstName": "Kent",
      "MiddleName": null,
      "LastName": "Bixby",
      "SSN": null,
      "DOB": null,
      "Sex": null,
      "Spouse": {
        "FirstName": "Barbara",
        "LastName": "Bixby"
      },
      "Address": {
        "StreetAddress": "4762 Hickory Street",
        "City": "Monroe",
        "State": "WI",
        "ZIP": "53566",
        "County": "Green",
        "Country": "USA"
      },
      "PhoneNumber": {
        "Home": null,
        "Business": null,
        "Mobile": null
      },
      "EmailAddresses": [],
      "Type": null,
      "RelationToPatient": "Father",
      "Employer": {
        "Name": "Accelerator Labs",
        "Address": {
          "StreetAddress": "1456 Old Sauk Road",
          "City": "Madison",
          "State": "WI",
          "ZIP": "53719",
          "County": "Dane",
          "Country": "USA"
        },
        "PhoneNumber": "+18083451121"
      }
    },
    "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
          }
        }
      }
    ]
  },
  "Visit": {
    "VisitNumber": null
  }
}
```
