# Vaccination Administration

This data model communicates details like specific immunization administered, the site and route of administration, and which provider administered it. These messages are useful if you want to know when a vaccination has been administered since the messages are typically triggered at the time of administration, not ordering.

This data model has event types that allow you to: 

- receive a notification about vaccine administrations; or 
- query for and receive a patient's vaccination details. 

> **EHR support for Vaccination**
>
> EHR systems with an ambulatory focus often support exchanging vaccination data typically via HL7v2 VXU messages. Supporting vaccination data exchange also meets Meaningful Use 2 criteria.

Receive a notification when a new vaccine administration is created or an existing administration is updated or canceled. Cancellations are usually due to an input error. 

One message may contain multiple administrations for a patient. 

Status: Beta

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Meta` | object | Yes |  |
| `Meta.DataModel` | string | Yes | Vaccination |
| `Meta.EventType` | string | Yes | Administration |
| `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.Consent` | object | No |  |
| `Patient.Consent.Status` | string or null | No | An indicator if the patient has provided consent. |
| `Patient.Consent.EffectiveDate` | string or null | No | The date in which the consent is effective. |
| `Patient.Consent.Notification` | string or null | No | An indication if the person has consented to communication for notifications. |
| `Vaccinations` | Array of object | Yes | Array of vaccine administrations |
| `Vaccinations[].DateTime` | string | Yes | When the vaccine was administered, or if documenting a refusal, when the vaccination was refused. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Vaccinations[].Product` | object | Yes | Vaccine that was administered |
| `Vaccinations[].Product.Code` | string | Yes | Code for the vaccine |
| `Vaccinations[].Product.Codeset` | string or null | No | Code set used to identify the vaccine. *[CVX](http://www2a.cdc.gov/vaccines/iis/iisstandards/vaccines.asp?rpt=cvx) or other code set used to identify the product* |
| `Vaccinations[].Product.Description` | string or null | No | Description of the vaccine |
| `Vaccinations[].Product.LotNumber` | string or null | No | Lot number of the vaccine |
| `Vaccinations[].Product.ExpirationDate` | string or null | No | Expiration date of the vaccine. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Vaccinations[].Product.Manufacturer` | object | No | Organization that manufactured the vaccine |
| `Vaccinations[].Product.Manufacturer.Code` | string or null | No | Code for the manufacturer |
| `Vaccinations[].Product.Manufacturer.Codeset` | string or null | No | Code set used to identify the manufacturer. *[MVX Codeset](http://www2a.cdc.gov/vaccines/iis/iisstandards/vaccines.asp?rpt=mvx)* |
| `Vaccinations[].Product.Manufacturer.Name` | string or null | No | Name of the manufacturer |
| `Vaccinations[].Action` | string | Yes | Administrative action. Value set 597bc3ff-8a53-41bf-adf2-744769512831: New, Update, Cancel |
| `Vaccinations[].Route` | object | No | Route by which the vaccine was administered |
| `Vaccinations[].Route.Code` | string or null | No | Code for the route |
| `Vaccinations[].Route.Codeset` | string or null | No | Code set used to identify the route. *[Medication Route FDA Value Set](http://www.fda.gov/ForIndustry/DataStandards/StructuredProductLabeling/ucm162034.htm)* |
| `Vaccinations[].Route.Name` | string or null | No | Name of the route |
| `Vaccinations[].Site` | object | No | Site where the vaccine was administered |
| `Vaccinations[].Site.Code` | string or null | No | Code for the site |
| `Vaccinations[].Site.Codeset` | string or null | No | Code set used to identify the site |
| `Vaccinations[].Site.Name` | string or null | No | Name of the site |
| `Vaccinations[].Dose` | object | No |  |
| `Vaccinations[].Dose.Quantity` | string or null | No | Size of the dose |
| `Vaccinations[].Dose.Units` | string or null | No | Units of the dose. *[UCUM Units of Measure](http://unitsofmeasure.org/ucum.html)* |
| `Vaccinations[].Order` | object | No |  |
| `Vaccinations[].Order.ID` | string or null | No | ID of the order in your system |
| `Vaccinations[].Order.EHRID` | string or null | No | ID of the order from the EHR, if the order originated in the EHR |
| `Vaccinations[].Order.Provider` | object | No |  |
| `Vaccinations[].Order.Provider.NPI` | string or null | No | NPI of the ordering provider |
| `Vaccinations[].Order.Provider.ID` | string or null | No | ID of the ordering provider. *This ID is often required for Inpatient Visits.* |
| `Vaccinations[].Order.Provider.IDType` | string or null | No | ID type of the ID for the ordering provider |
| `Vaccinations[].Order.Provider.FirstName` | string or null | No | First name of the ordering provider |
| `Vaccinations[].Order.Provider.LastName` | string or null | No | Last name of the ordering provider |
| `Vaccinations[].Order.Provider.Credentials` | Array of string | No | List of credentials for the ordering provider. *e.g. MD, PhD* |
| `Vaccinations[].Order.Provider.Address` | object | No | Provider's address |
| `Vaccinations[].Order.Provider.Address.StreetAddress` | string or null | No | Street address |
| `Vaccinations[].Order.Provider.Address.City` | string or null | No | City |
| `Vaccinations[].Order.Provider.Address.State` | string or null | No | State |
| `Vaccinations[].Order.Provider.Address.ZIP` | string or null | No | ZIP |
| `Vaccinations[].Order.Provider.Address.County` | string or null | No | County |
| `Vaccinations[].Order.Provider.Address.Country` | string or null | No | Country. Value set 39791e31-0cee-4c58-a6c1-3d9e2c71d13b: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, IO, CM, CL, CO, CI, DK, EC, ER, FK, TF, GM, GI, GW, VA, IS, IM, JP, KI, LS, LT, MK, MV, MX, MS, NA, NC, MP, PK, PG, PL, RU, PM, SA, SG, SB, SS, SE, TZ, TO, TV, US, VN, EH, ZW, BQ, BR, BF, CA, TD, KM, CK, CU, DO, EE, FI, GE, GL, GN, GY, IN, IE, JE, KW, LB, LY, MO, ML, MR, MN, MM, NZ, NU, OM, PY, PT, RO, KN, SN, RS, ZA, LK, SJ, SY, TK, TM, UG, UM, UZ, WF, BA, BG, CV, CX, CD, CW, DJ, GQ, FO, PF, DE, GD, GG, HT, HK, IR, IL, KE, KG, LU, MY, MT, MU, ME, MZ, NP, NF, PW, PH, QA, BL, MF, ST, SX, SI, GS, SR, TJ, TG, TN, UA, VU, VG, BW, BN, KH, KY, CC, CR, CY, EG, FJ, FR, GH, GP, GU, HN, IQ, JM, KZ, KP, LA, LR, MW, MH, YT, MD, MA, NI, NG, NO, PA, PN, RE, RW, LC, SM, SC, SK, ES, CH, TH, TT, TR, GB, VE, VI, ZM, BV, BI, CF, CN, CG, HR, CZ, DM, SV, ET, GF, GA, GR, GT, HM, HU, ID, IT, JO, KR, LV, LI, MG, MQ, FM, MC, NR, NL, NE, PS, PE, PR, SH, VC, WS, SL, SO, SD, SZ, TW, TL, TC, AE, UY, YE, DR |
| `Vaccinations[].Order.Provider.EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Vaccinations[].Order.Provider.PhoneNumber` | object | No |  |
| `Vaccinations[].Order.Provider.PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Vaccinations[].Order.Provider.Location` | object | No | Provider's location |
| `Vaccinations[].Order.Provider.Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Vaccinations[].Order.Provider.Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Vaccinations[].Order.Provider.Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Vaccinations[].Order.Provider.Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Vaccinations[].Order.Provider.Location.FacilityIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Vaccinations[].Order.Provider.Location.Department` | string or null | No | Department |
| `Vaccinations[].Order.Provider.Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Vaccinations[].Order.Provider.Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Vaccinations[].Order.Provider.Location.DepartmentIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Vaccinations[].Order.Provider.Location.Room` | string or null | No | Room. *Example: 136* |
| `Vaccinations[].ClinicalInfo` | Array of object | No | List of supplementary information associated with the vaccination administration. |
| `Vaccinations[].ClinicalInfo[].Code` | string or null | No | Code for the information element |
| `Vaccinations[].ClinicalInfo[].Codeset` | string or null | No | Code set used to identify the information element. *LOINC is typically used.* |
| `Vaccinations[].ClinicalInfo[].Description` | string or null | No | Description of the information element |
| `Vaccinations[].ClinicalInfo[].Value` | string or null | No | Value of the information element |
| `Vaccinations[].ClinicalInfo[].ValueType` | string or null | No | Value of the information element. Value set 481cd476-e9b8-4dd6-bc8f-7e487de9e4e4: Address, Coded Entry, Date, DateTime, Encapsulated Data, Formatted Text, ID, ID And Name, Money, Name, Numeric, Phone Number, Price, Reference Pointer, String, Time, Structured Numeric |
| `Vaccinations[].ClinicalInfo[].Units` | string or null | No | Units of the value |
| `Vaccinations[].ClinicalInfo[].Notes` | Array of string | No | Notes related to the information element. |
| `Vaccinations[].ClinicalInfo[].CompletionDateTime` | string or null | No | Date and time the clinical info was composed into a report and released. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Vaccinations[].ClinicalInfo[].RelatedGroupID` | string or null | No | ID to group separate Clinical Info components |
| `Vaccinations[].Notes` | Array of string | No | Notes on the vaccine administration, such as Vaccine Information Statement publication date |
| `Vaccinations[].RefusalReason` | string or null | No | Reason the vaccination was refused |
| `Vaccinations[].Provider` | object | No |  |
| `Vaccinations[].Provider.ID` | string or null | No | ID of the provider who administered the vaccine. *This ID is often required for Inpatient Visits.* |
| `Vaccinations[].Provider.IDType` | string or null | No | ID type of the ID for the provider who administered the vaccine |
| `Vaccinations[].Provider.FirstName` | string or null | No | First name of the provider who administered the vaccine |
| `Vaccinations[].Provider.LastName` | string or null | No | Last name of the provider who administered the vaccine |
| `Vaccinations[].Provider.Credentials` | Array of string | No | List of credentials for the provider who administered the vaccine. *e.g. MD, PhD* |
| `Vaccinations[].Provider.Address` | object | No | Provider's address |
| `Vaccinations[].Provider.Address.StreetAddress` | string or null | No | Street address |
| `Vaccinations[].Provider.Address.City` | string or null | No | City |
| `Vaccinations[].Provider.Address.State` | string or null | No | State |
| `Vaccinations[].Provider.Address.ZIP` | string or null | No | ZIP |
| `Vaccinations[].Provider.Address.County` | string or null | No | County |
| `Vaccinations[].Provider.Address.Country` | string or null | No | Country. Value set 39791e31-0cee-4c58-a6c1-3d9e2c71d13b: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, IO, CM, CL, CO, CI, DK, EC, ER, FK, TF, GM, GI, GW, VA, IS, IM, JP, KI, LS, LT, MK, MV, MX, MS, NA, NC, MP, PK, PG, PL, RU, PM, SA, SG, SB, SS, SE, TZ, TO, TV, US, VN, EH, ZW, BQ, BR, BF, CA, TD, KM, CK, CU, DO, EE, FI, GE, GL, GN, GY, IN, IE, JE, KW, LB, LY, MO, ML, MR, MN, MM, NZ, NU, OM, PY, PT, RO, KN, SN, RS, ZA, LK, SJ, SY, TK, TM, UG, UM, UZ, WF, BA, BG, CV, CX, CD, CW, DJ, GQ, FO, PF, DE, GD, GG, HT, HK, IR, IL, KE, KG, LU, MY, MT, MU, ME, MZ, NP, NF, PW, PH, QA, BL, MF, ST, SX, SI, GS, SR, TJ, TG, TN, UA, VU, VG, BW, BN, KH, KY, CC, CR, CY, EG, FJ, FR, GH, GP, GU, HN, IQ, JM, KZ, KP, LA, LR, MW, MH, YT, MD, MA, NI, NG, NO, PA, PN, RE, RW, LC, SM, SC, SK, ES, CH, TH, TT, TR, GB, VE, VI, ZM, BV, BI, CF, CN, CG, HR, CZ, DM, SV, ET, GF, GA, GR, GT, HM, HU, ID, IT, JO, KR, LV, LI, MG, MQ, FM, MC, NR, NL, NE, PS, PE, PR, SH, VC, WS, SL, SO, SD, SZ, TW, TL, TC, AE, UY, YE, DR |
| `Vaccinations[].Provider.EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Vaccinations[].Provider.PhoneNumber` | object | No |  |
| `Vaccinations[].Provider.PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Vaccinations[].Provider.Location` | object | No | Provider's location |
| `Vaccinations[].Provider.Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Vaccinations[].Provider.Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Vaccinations[].Provider.Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Vaccinations[].Provider.Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Vaccinations[].Provider.Location.FacilityIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Vaccinations[].Provider.Location.Department` | string or null | No | Department |
| `Vaccinations[].Provider.Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Vaccinations[].Provider.Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Vaccinations[].Provider.Location.DepartmentIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Vaccinations[].Provider.Location.Room` | string or null | No | Room. *Example: 136* |
| `Vaccinations[].Location` | object | No | Location of the visit in which the vaccine was administered |
| `Vaccinations[].Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Vaccinations[].Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Vaccinations[].Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Vaccinations[].Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Vaccinations[].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* |
| `Vaccinations[].Location.Department` | string or null | No | Department |
| `Vaccinations[].Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Vaccinations[].Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Vaccinations[].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* |
| `Vaccinations[].Location.Room` | string or null | No | Room. *Example: 136* |
| `Visit` | object | No |  |
| `Visit.VisitNumber` | string or null | No | Number for the appointment or visit in which the vaccine was administered. *Although not required, VisitNumber is highly recommended so that the vaccination can be associated with a specific encounter/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.* |

## Example

```json
{
  "Meta": {
    "DataModel": "Vaccination",
    "EventType": "Administration",
    "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
  },
  "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"
        ]
      }
    ],
    "Consent": {
      "Status": null,
      "EffectiveDate": null,
      "Notification": null
    }
  },
  "Visit": {
    "VisitNumber": "98765",
    "AccountNumber": null
  },
  "Vaccinations": [
    {
      "DateTime": "2015-08-13T21:08:57.581Z",
      "Product": {
        "Code": "20",
        "Codeset": "CVX",
        "Description": null,
        "LotNumber": "123456789",
        "ExpirationDate": null,
        "Manufacturer": {
          "Code": null,
          "Codeset": null,
          "Name": null
        }
      },
      "Route": {
        "Code": "Intramuscular",
        "Codeset": null,
        "Name": null
      },
      "Site": {
        "Code": "Left arm",
        "Codeset": null,
        "Name": null
      },
      "Dose": {
        "Quantity": "0.5",
        "Units": null
      },
      "Order": {
        "ID": "123",
        "EHRID": "456",
        "Provider": {
          "NPI": null,
          "ID": null,
          "IDType": null,
          "FirstName": null,
          "LastName": null,
          "Credentials": [],
          "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
          },
          "EmailAddresses": [],
          "PhoneNumber": {
            "Office": null
          },
          "Location": {
            "Type": null,
            "Facility": null,
            "FacilityIdentifiers": [],
            "Department": null,
            "DepartmentIdentifiers": [],
            "Room": null
          }
        }
      },
      "ClinicalInfo": [],
      "Notes": [
        "VIS date: May 17 2007"
      ],
      "RefusalReason": null,
      "Provider": {
        "ID": "4356789876",
        "IDType": "NPI",
        "FirstName": "Pat",
        "LastName": "Granite",
        "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
        }
      },
      "Location": {
        "Type": "Clinic",
        "Facility": "Rolling Oaks Outpatient Center",
        "FacilityIdentifiers": [],
        "Department": "Rolling Oaks Pediatrics",
        "DepartmentIdentifiers": [],
        "Room": null
      },
      "Action": "New"
    }
  ]
}
```
