# Claim SubmissionBatch

This data model facilitates transactions between providers and payers. We support submitting claims and sending payment notifications in batches.

Typically, the claims workflow kicks off with providers grouping (i.e., batching) and sending claims to payers with details about services rendered to a patient and a request for payment. After processing the claims, payers send batched payment notifications to the provider with a status of whether the payment request was accepted or denied. In some cases, the status may indicate that a third party transferred funds to the provider.

This data model has event types that allow you to:

- submit a batch of claims; or
- sent a batch of payment notifications.

> **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.

Send a batch of claims to a payer. 

A batch message contains multiple claims with payment requests for multiple patient services.

Status: Developer preview

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Meta` | object | Yes |  |
| `Meta.DataModel` | string | Yes | Claim |
| `Meta.EventType` | string | Yes | SubmissionBatch |
| `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.* |
| `Transactions` | Array of object | No |  |
| `Transactions[].ID` | string or null | No | ID used by submitter to reference this Claim Submission |
| `Transactions[].IDType` | string or null | No | Type of ID |
| `Transactions[].Type` | string or null | No | The type of Claim Submission, Institutional or Professional. Value set 91c5ff8a-778a-431e-981a-7a0dc10c5248: Institutional, Professional |
| `Transactions[].Submitter` | object | No | Submitter of a Claim Submission |
| `Transactions[].Submitter.Identifiers` | Array of object | No | List of IDs and ID Types that identify the concept |
| `Transactions[].Submitter.Identifiers[].ID` | string or null | No | ID for the submitter |
| `Transactions[].Submitter.Identifiers[].IDType` | string or null | No | The type of ID |
| `Transactions[].Submitter.Name` | string or null | No |  |
| `Transactions[].Submitter.Address` | object | No | Address of the Submitter |
| `Transactions[].Submitter.Address.StreetAddress` | string or null | No | Street address |
| `Transactions[].Submitter.Address.City` | string or null | No | City |
| `Transactions[].Submitter.Address.State` | string or null | No | State |
| `Transactions[].Submitter.Address.ZIP` | string or null | No | ZIP |
| `Transactions[].Submitter.Address.County` | string or null | No | County |
| `Transactions[].Submitter.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 |
| `Transactions[].Submitter.EmailAddress` | string or null | No |  |
| `Transactions[].Submitter.PhoneNumber` | object | No |  |
| `Transactions[].Submitter.PhoneNumber.Office` | string or null | No | *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Submitter.PhoneNumber.Fax` | string or null | No | *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Receiver` | object | No | Receiver of a Claim Submission |
| `Transactions[].Receiver.Identifiers` | Array of object | No | List of IDs and ID Types that identify the concept |
| `Transactions[].Receiver.Identifiers[].ID` | string or null | No | ID for the receiver |
| `Transactions[].Receiver.Identifiers[].IDType` | string or null | No | The type of ID |
| `Transactions[].Receiver.Name` | string or null | No |  |
| `Transactions[].Receiver.Address` | object | No | Address of the Receiver |
| `Transactions[].Receiver.Address.StreetAddress` | string or null | No | Street address |
| `Transactions[].Receiver.Address.City` | string or null | No | City |
| `Transactions[].Receiver.Address.State` | string or null | No | State |
| `Transactions[].Receiver.Address.ZIP` | string or null | No | ZIP |
| `Transactions[].Receiver.Address.County` | string or null | No | County |
| `Transactions[].Receiver.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 |
| `Transactions[].Receiver.EmailAddress` | string or null | No |  |
| `Transactions[].Receiver.PhoneNumber` | object | No |  |
| `Transactions[].Receiver.PhoneNumber.Office` | string or null | No | *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Receiver.PhoneNumber.Fax` | string or null | No | *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Submissions` | Array of object | No | A collection of claims submissions from a provider for services provided to patients. |
| `Transactions[].Submissions[].BillingProvider` | object | No | Billing Provider |
| `Transactions[].Submissions[].BillingProvider.Identifiers` | Array of object | No | List of IDs and ID Types that identify the concept |
| `Transactions[].Submissions[].BillingProvider.Identifiers[].ID` | string or null | No | ID for the business |
| `Transactions[].Submissions[].BillingProvider.Identifiers[].IDType` | string or null | No | The type of ID |
| `Transactions[].Submissions[].BillingProvider.Name` | string or null | No |  |
| `Transactions[].Submissions[].BillingProvider.Address` | object | No | Address of the business |
| `Transactions[].Submissions[].BillingProvider.Address.StreetAddress` | string or null | No | Street address |
| `Transactions[].Submissions[].BillingProvider.Address.City` | string or null | No | City |
| `Transactions[].Submissions[].BillingProvider.Address.State` | string or null | No | State |
| `Transactions[].Submissions[].BillingProvider.Address.ZIP` | string or null | No | ZIP |
| `Transactions[].Submissions[].BillingProvider.Address.County` | string or null | No | County |
| `Transactions[].Submissions[].BillingProvider.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 |
| `Transactions[].Submissions[].BillingProvider.EmailAddress` | string or null | No |  |
| `Transactions[].Submissions[].BillingProvider.PhoneNumber` | object | No |  |
| `Transactions[].Submissions[].BillingProvider.PhoneNumber.Office` | string or null | No | *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Submissions[].BillingProvider.PhoneNumber.Fax` | string or null | No | *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Submissions[].BillingProvider.Specialty` | object | No |  |
| `Transactions[].Submissions[].BillingProvider.Specialty.ID` | string or null | No | Billing provider's specialty. *Commonly the taxonomy ID* |
| `Transactions[].Submissions[].BillingProvider.Specialty.Description` | string or null | No | Billing provider's specialty description |
| `Transactions[].Submissions[].Subscribers` | Array of object | No | The subscriber is the individual who is contracted with the insurance plan |
| `Transactions[].Submissions[].Subscribers[].Identifiers` | Array of object | No | List of IDs and ID Types that identify the concept |
| `Transactions[].Submissions[].Subscribers[].Identifiers[].ID` | string or null | No | ID for the subscriber |
| `Transactions[].Submissions[].Subscribers[].Identifiers[].IDType` | string or null | No | The type of ID |
| `Transactions[].Submissions[].Subscribers[].Demographics` | object | No |  |
| `Transactions[].Submissions[].Subscribers[].Demographics.FirstName` | string or null | No | First name of the Subscriber |
| `Transactions[].Submissions[].Subscribers[].Demographics.MiddleName` | string or null | No | Middle name of the Subscriber |
| `Transactions[].Submissions[].Subscribers[].Demographics.LastName` | string or null | No | Last name of the Subscriber |
| `Transactions[].Submissions[].Subscribers[].Demographics.Address` | object | No | Address of the Subscriber |
| `Transactions[].Submissions[].Subscribers[].Demographics.Address.StreetAddress` | string or null | No | Street address |
| `Transactions[].Submissions[].Subscribers[].Demographics.Address.City` | string or null | No | City |
| `Transactions[].Submissions[].Subscribers[].Demographics.Address.State` | string or null | No | State |
| `Transactions[].Submissions[].Subscribers[].Demographics.Address.ZIP` | string or null | No | ZIP |
| `Transactions[].Submissions[].Subscribers[].Demographics.Address.County` | string or null | No | County |
| `Transactions[].Submissions[].Subscribers[].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 |
| `Transactions[].Submissions[].Subscribers[].Demographics.PhoneNumber` | object | No |  |
| `Transactions[].Submissions[].Subscribers[].Demographics.PhoneNumber.Home` | string or null | No | Home phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Submissions[].Subscribers[].Demographics.PhoneNumber.Office` | string or null | No | Office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Submissions[].Subscribers[].Demographics.PhoneNumber.Mobile` | string or null | No | Mobile phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Submissions[].Subscribers[].Demographics.DOB` | string or null | No | Subscriber's date of birth. *In [YYYY-MM-DD format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Transactions[].Submissions[].Subscribers[].Demographics.Sex` | string or null | No | Subscriber'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 |
| `Transactions[].Submissions[].Subscribers[].OrganizationName` | string or null | No | *If the subscriber is not a person, this will contain the organization name* |
| `Transactions[].Submissions[].Subscribers[].ResponsibilityLevel` | string or null | No | Payor responsibility level. Value set 38b89355-04be-4dd0-bcdd-ba66e69b07dd: Tertiary, Primary, Secondary |
| `Transactions[].Submissions[].Subscribers[].Insurance` | object | No |  |
| `Transactions[].Submissions[].Subscribers[].Insurance.Plan` | object | No |  |
| `Transactions[].Submissions[].Subscribers[].Insurance.Plan.ID` | string or null | No | Identifier of insurance plan |
| `Transactions[].Submissions[].Subscribers[].Insurance.Plan.IDType` | string or null | No | ID type of insurance plan |
| `Transactions[].Submissions[].Subscribers[].Insurance.Plan.Name` | string or null | No | Name of insurance plan |
| `Transactions[].Submissions[].Subscribers[].Insurance.Plan.Type` | string or null | No | Type of insurance plan |
| `Transactions[].Submissions[].Subscribers[].Insurance.MemberNumber` | string or null | No | Patient member number |
| `Transactions[].Submissions[].Subscribers[].Insurance.Company` | object | No |  |
| `Transactions[].Submissions[].Subscribers[].Insurance.Company.ID` | string or null | No | ID of insurance company (payor) |
| `Transactions[].Submissions[].Subscribers[].Insurance.Company.IDType` | string or null | No | ID type of insurance company (payor) |
| `Transactions[].Submissions[].Subscribers[].Insurance.Company.Name` | string or null | No | Name of insurance company (payor) |
| `Transactions[].Submissions[].Subscribers[].Insurance.Company.Address` | object | No | Insurance company's address |
| `Transactions[].Submissions[].Subscribers[].Insurance.Company.Address.StreetAddress` | string or null | No | Street address |
| `Transactions[].Submissions[].Subscribers[].Insurance.Company.Address.City` | string or null | No | City |
| `Transactions[].Submissions[].Subscribers[].Insurance.Company.Address.State` | string or null | No | State |
| `Transactions[].Submissions[].Subscribers[].Insurance.Company.Address.ZIP` | string or null | No | ZIP |
| `Transactions[].Submissions[].Subscribers[].Insurance.Company.Address.County` | string or null | No | County |
| `Transactions[].Submissions[].Subscribers[].Insurance.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 |
| `Transactions[].Submissions[].Subscribers[].Insurance.Company.PhoneNumber` | string or null | No | Insurance companys phone number. *In E. 164 Format (i.e. +16085551234)* |
| `Transactions[].Submissions[].Subscribers[].Insurance.GroupNumber` | string or null | No | Insurance policy group number |
| `Transactions[].Submissions[].Subscribers[].Insurance.GroupName` | string or null | No | Insurance policy group name |
| `Transactions[].Submissions[].Subscribers[].Insurance.EffectiveDate` | string or null | No | Effect date of this insurance policy. *In [YYYY-MM-DD format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Transactions[].Submissions[].Subscribers[].Insurance.ExpirationDate` | string or null | No | Expiration date of this insurance policy. *In [YYYY-MM-DD format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Transactions[].Submissions[].Subscribers[].Insurance.PolicyNumber` | string or null | No | Insurance policy number |
| `Transactions[].Submissions[].Subscribers[].Insurance.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 |
| `Transactions[].Submissions[].Subscribers[].Insurance.AgreementType` | string or null | No | Type of insurance agreement. Value set db651e3c-4a48-40e3-bc45-eddf613d0ff3: Standard, Unified, Maternity |
| `Transactions[].Submissions[].Subscribers[].Insurance.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 |
| `Transactions[].Submissions[].Subscribers[].Patients` | Array of object | No |  |
| `Transactions[].Submissions[].Subscribers[].Patients[].Identifiers` | Array of object | No | List of IDs and ID types that identify the patient |
| `Transactions[].Submissions[].Subscribers[].Patients[].Identifiers[].ID` | string or null | No | ID for the patient |
| `Transactions[].Submissions[].Subscribers[].Patients[].Identifiers[].IDType` | string or null | No | Type of ID. *E.g. MRN, EPI* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics` | object | No |  |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics.FirstName` | string or null | No | Patient's first name |
| `Transactions[].Submissions[].Subscribers[].Patients[].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. |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics.LastName` | string or null | No | Patient's last name |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics.DOB` | string or null | No | Patient's date of birth. *In [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics.SSN` | string or null | No | Patient's social security number |
| `Transactions[].Submissions[].Subscribers[].Patients[].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 |
| `Transactions[].Submissions[].Subscribers[].Patients[].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 |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics.IsHispanic` | boolean or null | No | Indicates if the patient is of hispanic origin. Value set 731a7062-165a-434c-bef7-b02b824dfc7b: true, false, null |
| `Transactions[].Submissions[].Subscribers[].Patients[].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 |
| `Transactions[].Submissions[].Subscribers[].Patients[].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 |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics.IsDeceased` | boolean or null | No | Indicates if the patient is deceased |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics.DeathDateTime` | string or null | No | Date and Time the patient was proclaimed deceased. *[ISO 8601 Format](https://en.wikipedia.org/wiki/ISO_8601)* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics.PhoneNumber` | object | No |  |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics.PhoneNumber.Home` | string or null | No | Patient's home phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics.PhoneNumber.Office` | string or null | No | Patient's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics.PhoneNumber.Mobile` | string or null | No | Patient's mobile phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics.EmailAddresses` | Array of string | No | Patient's email address(es) |
| `Transactions[].Submissions[].Subscribers[].Patients[].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 |
| `Transactions[].Submissions[].Subscribers[].Patients[].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 |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics.Address` | object | No | Patient's home address |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics.Address.StreetAddress` | string or null | No | Street address |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics.Address.City` | string or null | No | City |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics.Address.State` | string or null | No | State |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics.Address.ZIP` | string or null | No | ZIP |
| `Transactions[].Submissions[].Subscribers[].Patients[].Demographics.Address.County` | string or null | No | County |
| `Transactions[].Submissions[].Subscribers[].Patients[].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 |
| `Transactions[].Submissions[].Subscribers[].Patients[].Notes` | Array of string | No | Patient-level notes |
| `Transactions[].Submissions[].Subscribers[].Patients[].RelationToSubscriber` | string or null | No | Relation to the subscriber. 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 |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims` | Array of object | No | Array of claims for the given subscriber/patient. |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Adjustments` | Array of object | No | Adjustments explain why a claim was paid differently than it was billed. *Adjustments may not exist at the claim level if they exist at the service level* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Adjustments[].Amount` | string or null | No | Monetary amount of the adjustment. *A negative number indicates a payment increase, while a positive number indicates a payment reduction.* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Adjustments[].Quantity` | string or null | No |  |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Adjustments[].Type` | string or null | No | Type of Adjustment. Value set 5e523f56-2e85-438c-94fd-4e8c8dc1649b: Other adjustments, Patient responsibility, Payor initiated reductions, Contractual obligations |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Adjustments[].Reason` | string or null | No | Adjustment reason. Value set 2242ceb1-6b74-45d2-bc33-e71891342ca5: Co-payment amount, Coinsurance amount, Deductible amount, Claim specific negotiated discount, Denial |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].SubmissionNumber` | string or null | No | This will generally be the claim number sent on the initial claim submission. |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Type` | string or null | No | Type of Claim (Institutional only). *May be referred to as the Bill Type Frequency, Claim Frequency Code, or Bill Type* Value set 3ab4b2e9-e742-40b9-a9dc-127e447449a3: Original, Cancel, Replacement |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].TotalAmount` | string or null | No | Total amount of all lines on the claim. |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].CopayAmount` | string or null | No | Amount the patient has paid or still owes. |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].IsProviderSignatureOnFile` | boolean or null | No | Whether or not the provider signature is on file for the claim. |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].IsReleaseOfInformationOnFile` | boolean or null | No | Whether or not the submitter has a signed ROI form for the patient. |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].ProviderAcceptanceCode` | string or null | No | Code indicating whether the provider accepts assignment. |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].BenefitsAssignmentCode` | boolean or null | No | Code indicates whether the patient has or has not assigned benefits to the provider. Value set d39b6043-537b-41d2-b5b6-37d7f77989ff: Assigned, Assigned on Lab Only, Not Assigned |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].AdditionalDates` | Array of object | No | Collection of additional dates related to the claim |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].AdditionalDates[].DateTime` | string or null | No | *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].AdditionalDates[].Type` | string or null | No | Type of date value. *e.x. Service Period Start (https://ushik.ahrq.gov/ViewItemDetails?system=sdo&itemKey=133121000)* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].ReferenceNumbers` | Array of object | No | Reference numbers associated to the claim like Prior Auth Number, Member ID, and Provider IDs |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].ReferenceNumbers[].ID` | string or null | No | ID for the claim |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].ReferenceNumbers[].IDType` | string or null | No | The type of ID |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Diagnoses` | Array of object | No |  |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Diagnoses[].Code` | string or null | No | Diagnosis code. *First index in array indicates primary diagnosis* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Diagnoses[].Codeset` | string or null | No | Code set used to identify the diagnosis code. *e.x. ICD-10, ICD-9* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Diagnoses[].Description` | string or null | No | Diagnosis name |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Diagnoses[].Type` | string or null | No | Type of diagnosis. *One of the following: Admitting, Working, or Final* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].DiagnosisRelatedGroup` | string or null | No | CMS Diagnosis Related Group for an inpatient admission |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers` | Array of object | No |  |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].ID` | string or null | No | ID of the provider. *This ID is often required for Inpatient Visits.* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].IDType` | string or null | No | ID type of the ID for the provider |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].FirstName` | string or null | No | First name of the undefined |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].LastName` | string or null | No | Last name of the undefined |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Credentials` | Array of string | No | List of credentials for the undefined. *e.g. MD, PhD* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Address` | object | No | Provider's address |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Address.StreetAddress` | string or null | No | Street address |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Address.City` | string or null | No | City |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Address.State` | string or null | No | State |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Address.ZIP` | string or null | No | ZIP |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Address.County` | string or null | No | County |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].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 |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].EmailAddresses` | Array of string | No | Provider's email address(es) |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].PhoneNumber` | object | No |  |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].PhoneNumber.Office` | string or null | No | Provider's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Location` | object | No | Provider's location |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].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* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Location.Department` | string or null | No | Department |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].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* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Location.Room` | string or null | No | Room. *Example: 136* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Role` | string or null | No | The role this provider has in patient care. *E.x. Attending, Referring, Operating* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Specialty` | object | No |  |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Specialty.ID` | string or null | No | ID of specialty. *Commonly the taxonomy ID* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Providers[].Specialty.Description` | string or null | No | Description/name of specialty |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services` | Array of object | No | Services associated with this claim |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Code` | string or null | No | Code for the service line |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Codeset` | string or null | No | Code set used to identify the service line |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Description` | string or null | No | Description of the service line |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Adjustments` | Array of object | No | Adjustments explain why a claim was paid differently than it was billed. *Adjustments may not exist at the service level if they exist at the claim level* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Adjustments[].Amount` | string or null | No | Monetary amount of the adjustment. *A negative number indicates a payment increase, while a positive number indicates a payment reduction.* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Adjustments[].Quantity` | string or null | No |  |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Adjustments[].Type` | string or null | No | Type of Adjustment. Value set 5e523f56-2e85-438c-94fd-4e8c8dc1649b: Other adjustments, Patient responsibility, Payor initiated reductions, Contractual obligations |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Adjustments[].Reason` | string or null | No | Adjustment reason. Value set 2242ceb1-6b74-45d2-bc33-e71891342ca5: Co-payment amount, Coinsurance amount, Deductible amount, Claim specific negotiated discount, Denial |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Modifiers` | Array of string | No | Array of service modifiers |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Amount` | string or null | No | Total dollar amount for this line item |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].StartDateTime` | string or null | No | When the service conveyed began |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].EndDateTime` | string or null | No | When the service conveyed ended |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].RevenueCode` | string or null | No | Institutional only. |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Quantity` | object | No |  |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Quantity.Value` | string or null | No | Service line quantity. |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Quantity.Units` | string or null | No | Associated units to the quantity |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].IsEmergency` | boolean or null | No | Whether or not this service was performed in an emergency setting. |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].ReferenceNumbers` | Array of object | No | Reference numbers associated to the claim service line |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].ReferenceNumbers[].ID` | string or null | No | ID for the service line |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].ReferenceNumbers[].IDType` | string or null | No | The type of ID |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Diagnoses` | Array of object | No |  |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Diagnoses[].Code` | string or null | No | Diagnosis code. *First index in array indicates primary diagnosis associated with this service line item.* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Diagnoses[].Codeset` | string or null | No | Code set used to identify the diagnosis code. *e.x. ICD-10, ICD-9* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Diagnoses[].Description` | string or null | No | Diagnosis name |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Diagnoses[].Type` | string or null | No | Type of diagnosis. *One of the following: Admitting, Working, or Final* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Drug` | object | No | Drug information related to the service of an institutional claim |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Drug.PrescriptionID` | string or null | No | Pharmacy Prescription ID associated to the the drug |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Drug.NDC` | string or null | No | NDC ID |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Drug.Quantity` | object | No |  |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Drug.Quantity.Value` | string or null | No | Drug Quantity |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Drug.Quantity.Units` | string or null | No | Associated Units to the quantity |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[].Notes` | string or null | No | Additional notes for this line |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit` | object | No |  |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.DateTime` | string or null | No | DateTime of admission. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.DischargeDateTime` | string or null | No | DateTime of discharge. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.Location` | object | No |  |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.Location.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.Location.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.Location.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.Location.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].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* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.Location.Department` | string or null | No | Department |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.Location.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.Location.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].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* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.Location.Room` | string or null | No | Room. *Example: 136* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.PreviousLocation` | object | No |  |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.PreviousLocation.Type` | string or null | No | Type of location. *Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.PreviousLocation.Facility` | string or null | No | Facility. *Example: Community Hospital* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.PreviousLocation.FacilityIdentifiers` | Array of object | No | List of IDs specific to this facility |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.PreviousLocation.FacilityIdentifiers[].ID` | string or null | No | An ID specific to this facility |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.PreviousLocation.FacilityIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.PreviousLocation.Department` | string or null | No | Department |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.PreviousLocation.DepartmentIdentifiers` | Array of object | No | List of IDs specific to this department |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.PreviousLocation.DepartmentIdentifiers[].ID` | string or null | No | An ID specific to this department |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.PreviousLocation.DepartmentIdentifiers[].IDType` | string or null | No | The source or system to which this ID pertains. *Could be an OID or a human-readable name* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.PreviousLocation.Room` | string or null | No | Room. *Example: 136* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.Type` | string or null | No | Type of inpatient admission. *Only populated for inpatient admissions. E.x. Elective, Emergency* |
| `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.VisitNumber` | string or null | No | Visit Number. *Unique ID of a single visit* |

## Example

```json
{
  "Meta": {
    "DataModel": "Claim",
    "EventType": "SubmissionBatch",
    "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
  },
  "Transactions": [
    {
      "ID": "000000001",
      "IDType": null,
      "Type": "Institutional",
      "Submitter": {
        "Identifiers": [
          {
            "ID": "8675309",
            "IDType": "TIN"
          }
        ],
        "Name": "Redox Health System",
        "Address": {
          "StreetAddress": null,
          "City": null,
          "State": null,
          "ZIP": null,
          "County": null,
          "Country": null
        },
        "EmailAddress": null,
        "PhoneNumber": {
          "Office": null,
          "Fax": null
        }
      },
      "Receiver": {
        "Identifiers": [
          {
            "ID": "123456",
            "IDType": "TIN"
          }
        ],
        "Name": "National Insurance Company of Redox",
        "Address": {
          "StreetAddress": null,
          "City": null,
          "State": null,
          "ZIP": null,
          "County": null,
          "Country": null
        },
        "EmailAddress": null,
        "PhoneNumber": {
          "Office": null,
          "Fax": null
        }
      },
      "Submissions": [
        {
          "BillingProvider": {
            "Identifiers": [],
            "Name": null,
            "Address": {
              "StreetAddress": null,
              "City": null,
              "State": null,
              "ZIP": null,
              "County": null,
              "Country": null
            },
            "EmailAddress": null,
            "PhoneNumber": {
              "Office": null,
              "Fax": null
            },
            "Specialty": {
              "ID": null,
              "Description": null
            }
          },
          "Subscribers": [
            {
              "Identifiers": [
                {
                  "ID": "0000000001",
                  "IDType": "MR"
                },
                {
                  "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
                  "IDType": "EHRID"
                },
                {
                  "ID": "a1d4ee8aba494ca",
                  "IDType": "NIST"
                }
              ],
              "Demographics": {
                "FirstName": "Timothy",
                "MiddleName": "Paul",
                "LastName": "Bixby",
                "Address": {
                  "StreetAddress": "4762 Hickory Street",
                  "City": "Monroe",
                  "State": "WI",
                  "ZIP": "53566",
                  "County": "Green",
                  "Country": "US"
                },
                "PhoneNumber": {
                  "Home": "+18088675301",
                  "Office": null,
                  "Mobile": null
                },
                "DOB": "2008-01-06",
                "Sex": "Male"
              },
              "OrganizationName": null,
              "ResponsibilityLevel": "Primary",
              "Insurance": {
                "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
              },
              "Patients": [
                {
                  "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": [],
                  "RelationToSubscriber": null,
                  "Claims": [
                    {
                      "Adjustments": [],
                      "SubmissionNumber": "66729659983",
                      "Type": "Admit Through Discharge",
                      "TotalAmount": "200.00",
                      "CopayAmount": "10.00",
                      "IsProviderSignatureOnFile": true,
                      "IsReleaseOfInformationOnFile": true,
                      "ProviderAcceptanceCode": null,
                      "BenefitsAssignmentCode": null,
                      "AdditionalDates": [
                        {
                          "DateTime": "2016-10-08",
                          "Type": "Service Period Start"
                        },
                        {
                          "DateTime": "2016-10-11",
                          "Type": "Service Period End"
                        }
                      ],
                      "ReferenceNumbers": [
                        {
                          "ID": "AUTH000000",
                          "IDType": "Prior Authorization"
                        }
                      ],
                      "Diagnoses": [
                        {
                          "Code": "M54.5",
                          "Codeset": "ICD-10",
                          "Description": null,
                          "Type": "Admitting"
                        },
                        {
                          "Code": "J45.909",
                          "Codeset": "ICD-10",
                          "Description": null,
                          "Type": null
                        }
                      ],
                      "DiagnosisRelatedGroup": "551",
                      "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
                          },
                          "Location": {
                            "Type": null,
                            "Facility": null,
                            "FacilityIdentifiers": [],
                            "Department": null,
                            "DepartmentIdentifiers": [],
                            "Room": null
                          },
                          "Role": "Attending",
                          "Specialty": {
                            "ID": "1223G0001X",
                            "Description": "General Practice"
                          }
                        }
                      ],
                      "Services": [
                        {
                          "Code": "73560",
                          "Codeset": null,
                          "Description": "X-Ray knee 1 or 2 views",
                          "Adjustments": [],
                          "Modifiers": [],
                          "Amount": "100.00",
                          "StartDateTime": null,
                          "EndDateTime": null,
                          "RevenueCode": null,
                          "Quantity": {
                            "Value": 1,
                            "Units": "Unit"
                          },
                          "IsEmergency": false,
                          "ReferenceNumbers": [
                            {
                              "ID": "1",
                              "IDType": "Control Number"
                            }
                          ],
                          "Diagnoses": [],
                          "Drug": {
                            "PrescriptionID": null,
                            "NDC": null,
                            "Quantity": {
                              "Value": null,
                              "Units": null
                            }
                          },
                          "Notes": null
                        },
                        {
                          "Code": "J9202",
                          "Codeset": "HCPCS",
                          "Description": "Zoladex",
                          "Adjustments": [],
                          "Modifiers": [],
                          "Amount": "3.50",
                          "StartDateTime": null,
                          "EndDateTime": null,
                          "RevenueCode": null,
                          "Quantity": {
                            "Value": "1",
                            "Units": "Unit"
                          },
                          "IsEmergency": false,
                          "ReferenceNumbers": [
                            {
                              "ID": "2",
                              "IDType": "Control Number"
                            }
                          ],
                          "Diagnoses": [],
                          "Drug": {
                            "PrescriptionID": "ABC123456",
                            "NDC": "00310095036",
                            "Quantity": {
                              "Value": "1",
                              "Units": "Unit"
                            }
                          },
                          "Notes": null
                        }
                      ],
                      "Visit": {
                        "DateTime": "2016-10-08",
                        "DischargeDateTime": "2016-10-11",
                        "Location": {
                          "Type": "Inpatient",
                          "Facility": "RES General Hospital",
                          "FacilityIdentifiers": [],
                          "Department": "3N",
                          "DepartmentIdentifiers": [],
                          "Room": "136"
                        },
                        "PreviousLocation": {
                          "Type": "Critical Access Hospital",
                          "Facility": null,
                          "FacilityIdentifiers": [],
                          "Department": null,
                          "DepartmentIdentifiers": [],
                          "Room": null
                        },
                        "Type": "Elective",
                        "VisitNumber": null
                      }
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}
```
