Validate Professional Claim Submission (CMS-1500) JSON

Validate a professional claim in the Stedi JSON format without submitting it

POST/professional-claim-submissions/validate

Validate 837P professional claims using a JSON request structure that follows the CMS-1500 paper form layout without submitting them to payers.

This endpoint runs all of Stedi's claim validation checks, including payer validation, claim edits and repairs, and mapping. However, this endpoint doesn't submit the claim to payers.

You can use this endpoint to validate claims before submission. It helps you catch errors early when building claim submission forms or testing your integration.

  1. Call this endpoint with a JSON payload.
  2. Stedi validates your request.
  3. The endpoint returns an empty success response (HTTP 200) if validation passes, or an error if validation fails.
Authorization
RequiredHeader

A Stedi API Key for authentication.

Body

application/json
authorization
ObjectRequired

[CMS-1500 Box 12, 13, 27, 31] Signature and assignment-of-benefits indicators for the claim, covering whether the provider has the patient's and insured's authorizations on file and whether the provider accepts the payer's terms.

Show attributes
insuredAuthorizesAssignment
authorization.insuredAuthorizesAssignment
StringRequired

[CMS-1500 Box 13] Whether the insured has authorized payment of benefits directly to the provider.

Possible values
NO
NOT_APPLICABLE
YES
patientReleasesMedicalInfo
authorization.patientReleasesMedicalInfo
StringRequired

[CMS-1500 Box 12] Whether the provider has the patient's signature on file authorizing the release of medical information needed to process the claim.

Possible values
INFORMED_CONSENT
YES
providerAcceptsAssignment
authorization.providerAcceptsAssignment
StringRequired

[CMS-1500 Box 27] Whether the billing provider agrees to be paid under the payer's terms. Providers who are contracted with the payer are usually required to accept assignment.

Possible values
ASSIGNED
CLINICAL_LAB_ONLY
NOT_ASSIGNED
providerSignature
authorization.providerSignature
StringRequired

[CMS-1500 Box 31] Whether the provider has the rendering provider's signature on file. When ON_FILE, the generated CMS-1500 PDF shows SOF (Signature on File) in this box.

Possible values
ON_FILE
NOT_ON_FILE
billing
ObjectRequired

[CMS-1500 Box 25, 26, 28, 29, 32, 32a, 32b, 33, 33a, 33b] Billing details for the claim, including the billing provider, service facility, tax identification, and total charges.

Show attributes
amountPaid
billing.amountPaid
StringRegex pattern: ^\d+(\.\d{1,2})?$

[CMS-1500 Box 29] The total amount the patient, or the patient's representative, has already paid toward services in this claim. This is the patient's payment only. Don't include amounts paid by other payers.

billingProvider
billing.billingProvider
ObjectRequired

[CMS-1500 Box 33, 33a, 33b] The person or organization, such as a clinic or group practice, that will receive payment for the claim from the payer.

Show attributes
address
billing.billingProvider.address
ObjectRequiredFormat: password

[CMS-1500 Box 33] The billing provider's physical address. This must be a street address where care is delivered or an administrative facility, not a PO Box.

Show attributes
addressLine1
billing.billingProvider.address.addressLine1
StringRequiredLength: 1 - 55

The first line of the street address. This typically contains the building number and street name.

addressLine2
billing.billingProvider.address.addressLine2
StringLength: 1 - 55

The second line of the street address. This typically contains the apartment or suite number.

city
billing.billingProvider.address.city
StringRequiredLength: 2 - 30

The city name.

postalCode
billing.billingProvider.address.postalCode
StringLength: 3 - 15

The postal or ZIP code, with no separators or spaces. For United States addresses, use the full nine-digit ZIP code, such as 100031502.

state
billing.billingProvider.address.state
StringLength: 2

The two-letter state or province code. Required when the city is in the United States or Canada.

contact
billing.billingProvider.contact
Object

[CMS-1500 Box 33] The contact for the billing provider. Include only when the billing provider's contact information differs from the submitter's.

Show attributes
email
billing.billingProvider.contact.email
StringFormat: passwordLength: 1 - 256

The contact's email address.

faxNumber
billing.billingProvider.contact.faxNumber
StringFormat: passwordLength: 1 - 256

The contact's fax number.

name
billing.billingProvider.contact.name
StringLength: 1 - 60

The name of the contact person or department. When omitted, questions are directed to the entity itself.

phoneExtension
billing.billingProvider.contact.phoneExtension
StringLength: 1 - 256

The extension for phoneNumber.

phoneNumber
billing.billingProvider.contact.phoneNumber
StringFormat: passwordLength: 1 - 256

The contact's phone number.

identifiers
billing.billingProvider.identifiers
Object

[CMS-1500 Box 33a, 33b] Identifiers for the billing provider. You must provide the billing provider's NPI. When the provider doesn't have an NPI, you can supply an alternative, such as commercialNumber or locationNumber.

Show attributes
commercialNumber
billing.billingProvider.identifiers.commercialNumber
StringLength: 1 - 50

[CMS-1500 Box 33b] A commercial number assigned to the billing provider by the payer. Include only when the payer requires it in addition to the NPI, or when the provider has no NPI.

locationNumber
billing.billingProvider.identifiers.locationNumber
StringLength: 1 - 50

[CMS-1500 Box 33b] A location number assigned to the billing provider by the payer. Include only when the payer requires it in addition to the NPI, or when the provider has no NPI.

npi
billing.billingProvider.identifiers.npi
StringLength: 2 - 80

[CMS-1500 Box 33a] The billing provider's National Provider Identifier (NPI). When the billing provider isn't assigned an NPI, supply commercialNumber or locationNumber instead.

stateLicenseNumber
billing.billingProvider.identifiers.stateLicenseNumber
StringLength: 1 - 50

[CMS-1500 Box 33b] The billing provider's state license number, assigned by a state licensing board. Include only when the payer requires it in addition to the NPI.

taxonomyCode
billing.billingProvider.identifiers.taxonomyCode
StringLength: 1 - 50

[CMS-1500 Box 33b] The billing provider's taxonomy code from the National Uniform Claim Committee Health Care Provider Taxonomy Code Set, which identifies the provider's type and specialty.

name
billing.billingProvider.name
ObjectRequired

[CMS-1500 Box 33] The billing provider's name, either a person or an organization.

2 variants:
organization
billing.billingProvider.name.organization
StringRequiredLength: 1 - 60

The organization's business name.

patientControlNumber
billing.patientControlNumber
StringRequiredFormat: passwordLength: 1 - 38

[CMS-1500 Box 26] The patient control number, a unique tracking ID you assign to the claim so you can correlate it with responses from the payer. The payer returns this ID in claim acknowledgments, Electronic Remittance Advice (ERAs), and claim status checks. We recommend using a random, 17-character alphanumeric string.

serviceFacility
billing.serviceFacility
Object

[CMS-1500 Box 32, 32a, 32b] The facility where the patient received care, also called the service facility location. This can be a healthcare facility like a surgical center or reference lab, or the patient's address when you rendered services in their home. Include when services were rendered somewhere other than the billing provider's address.

  • For telehealth services, the service facility location is the provider's address, even though the patient may have been in their home or elsewhere when receiving services.
  • When the billing provider is a physician group located at the same address as a hospital but is a separate entity, you can differentiate the service facility location by including the specific suite or building number of the physician group.
Show attributes
address
billing.serviceFacility.address
ObjectRequiredFormat: password

[CMS-1500 Box 32] The facility's physical address. This must be a street address, not a PO Box. If the service was rendered in an area where there are no street addresses, enter a description of where the service was rendered. For example, 'crossroad of State Road 34 and 45' or 'Exit near Mile marker 265 on Interstate 80'.

Show attributes
addressLine1
billing.serviceFacility.address.addressLine1
StringRequiredLength: 1 - 55

The first line of the street address. This typically contains the building number and street name.

addressLine2
billing.serviceFacility.address.addressLine2
StringLength: 1 - 55

The second line of the street address. This typically contains the apartment or suite number.

city
billing.serviceFacility.address.city
StringRequiredLength: 2 - 30

The city name.

postalCode
billing.serviceFacility.address.postalCode
StringLength: 3 - 15

The postal or ZIP code, with no separators or spaces. For United States addresses, use the full nine-digit ZIP code, such as 100031502.

state
billing.serviceFacility.address.state
StringLength: 2

The two-letter state or province code. Required when the city is in the United States or Canada.

identifiers
billing.serviceFacility.identifiers
Object

[CMS-1500 Box 32a, 32b] Identifiers for the service facility.

Show attributes
commercialNumber
billing.serviceFacility.identifiers.commercialNumber
StringLength: 1 - 50

[CMS-1500 Box 32b] A commercial number assigned to the facility by the payer. Include only when the payer requires it in addition to the NPI.

locationNumber
billing.serviceFacility.identifiers.locationNumber
StringLength: 1 - 50

[CMS-1500 Box 32b] A location number assigned to the facility by the payer. Include only when the payer requires it in addition to the NPI.

npi
billing.serviceFacility.identifiers.npi
StringLength: 2 - 80

[CMS-1500 Box 32a] The facility's National Provider Identifier (NPI). Only required when the facility's NPI differs from the billing provider's NPI. Don't include when the service facility is the patient's home.

stateLicenseNumber
billing.serviceFacility.identifiers.stateLicenseNumber
StringLength: 1 - 50

[CMS-1500 Box 32b] The facility's state license number, assigned by a state licensing board. Include only when the payer requires it in addition to the NPI.

name
billing.serviceFacility.name
ObjectRequired

[CMS-1500 Box 32] The facility's organization name. When services were rendered in the patient's home, we recommend setting this to Residence or something similar.

Show attributes
organization
billing.serviceFacility.name.organization
StringRequiredLength: 1 - 60

The organization's business name.

taxId
billing.taxId
ObjectRequired

[CMS-1500 Box 25] The billing provider's federal tax identification number, provided as either an Employer Identification Number (EIN) or a Social Security Number (SSN).

2 variants:
ssn
billing.taxId.ssn
StringRequiredFormat: passwordLength: 1 - 50

The billing provider's Social Security Number. Must be a string of exactly nine numbers with no separators. If you provide this, don't provide ein.

totalCharge
billing.totalCharge
StringRequiredRegex pattern: ^\d+(\.\d{1,2})?$

[CMS-1500 Box 28] The total charge for the claim, equal to the sum of all service line charges. It is acceptable to set this to 0 (zero).

encounter
ObjectRequired

[CMS-1500 Box 10a, 10b, 10c, 10d, 14, 15, 16, 17, 17a, 17b, 18, 19, 21, 22, 23, 24h] Clinical details about the encounter, including diagnosis codes, the related providers, relevant dates, and supporting information for the claim.

Show attributes
additionalDiagnosisCodes
encounter.additionalDiagnosisCodes
Array of StringsItems: 1 - 11

[CMS-1500 Box 21] Additional diagnoses for the claim beyond primaryDiagnosisCode, in order of importance. Use this for diagnoses that apply to the claim but are not tied to a specific service line; you don't need to repeat codes that already appear in a service line's diagnosisCodes. Stedi places these directly after the primary diagnosis in the claim's diagnosis list.

  • Use valid, billable codes at the highest level of specificity available.
  • Don't submit the decimal point (e.g., submit I639 not I63.9).
  • Don't submit header codes (codes with fewer than three characters, such as E10 for Type 1 diabetes).
attachments
encounter.attachments
Array of ObjectsItems: 1 - 10

[CMS-1500 Box 19] Supporting documentation attached to the claim, such as medical records or operative notes. Include only when required by the payer.

Array item
attachmentControlNumber
encounter.attachments[].attachmentControlNumber
StringLength: 2 - 80

A control number assigned to the attachment. The payer uses this identifier to match the attachment to the claim.

  • You must include either this property or attachmentId in the request, but not both. Including both properties will result in an error.
  • We recommend using a ULID or UUID of up to 50 characters.
  • Stedi autogenerates a control number if you don't provide one.
attachmentId
encounter.attachments[].attachmentId
StringRegex pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Length: 36

The unique identifier for an attachment file you previously uploaded to Stedi. This value is returned in the attachmentId property of the Create Claim Attachment (275) JSON response. Stedi uses it to generate and submit the 275 claim attachment transaction to the payer.

  • This property is required when you're submitting attachment files through Stedi.
  • You must include either this property or attachmentControlNumber in the request, but not both. Including both properties will result in an error.
reportTypeCode
encounter.attachments[].reportTypeCode
StringRequired

The type of report being attached.

Possible values
REPORT_JUSTIFYING_TREATMENT
DRUGS_ADMINISTERED
TREATMENT_DIAGNOSIS
INITIAL_ASSESSMENT
FUNCTIONAL_GOALS
transmissionCode
encounter.attachments[].transmissionCode
StringRequired

How you're sending the attachment to the payer.

Possible values
AVAILABLE_ON_REQUEST
BY_MAIL
ELECTRONICALLY_ONLY
EMAIL
FILE_TRANSFER
claimCodes
encounter.claimCodes
Array of StringsItems: 1 - 12

[CMS-1500 Box 10d] Up to four National Uniform Claim Committee (NUCC) condition codes. A condition code is a two-character code that provides extra information about the patient's condition or the claim itself, such as whether the claim is part of disaster relief. For a list, visit the NUCC Condition Codes.

claimNote
encounter.claimNote
Object

[CMS-1500 Box 19] A free-text note with additional information the payer may need to process the claim that doesn't fit anywhere else on the form.

5 variants:
additionalInformation
encounter.claimNote.additionalInformation
StringRequiredFormat: passwordLength: 1 - 80

Additional information that helps explain the claim, such as a special billing situation or extra context. Don't use this to describe unspecified procedure codes.

clinicalDates
encounter.clinicalDates
Object

[CMS-1500 Box 14, 15, 16, 18] Dates relevant to the patient's condition and care, such as the onset of the current illness, hospitalization dates, and dates the patient was unable to work.

Show attributes
accident
encounter.clinicalDates.accident
StringLength: 1 - 35

[CMS-1500 Box 15] The date of the accident related to this claim. Required when patientCondition.isAutoAccidentRelated or patientCondition.isOtherAccidentRelated is true, and when the condition is employment-related and resulted from an accident.

acuteManifestationOfChronicCondition
encounter.clinicalDates.acuteManifestationOfChronicCondition
StringLength: 1 - 35

[CMS-1500 Box 15] The date the patient first experienced acute symptoms of a chronic condition. Required for certain spinal manipulation claims billed to Medicare.

assumedCare
encounter.clinicalDates.assumedCare
StringLength: 1 - 35

[CMS-1500 Box 15] The date the provider assumed care of the patient, for shared-care arrangements.

firstVisitOrConsultation
encounter.clinicalDates.firstVisitOrConsultation
StringLength: 1 - 35

[CMS-1500 Box 15] The date of the patient's first visit or consultation, when required by the payer.

hospitalization
encounter.clinicalDates.hospitalization
Object

[CMS-1500 Box 18] The date range during which the patient was hospitalized for services in this claim. Provide from for the admission date and to for the discharge date; omit to while the patient is still hospitalized.

Show attributes
end
encounter.clinicalDates.hospitalization.end
StringLength: 1 - 35

The end date of the range, inclusive, in YYYY-MM-DD format.

start
encounter.clinicalDates.hospitalization.start
StringLength: 1 - 35

The start date of the range, in YYYY-MM-DD format.

initialTreatment
encounter.clinicalDates.initialTreatment
StringLength: 1 - 35

[CMS-1500 Box 15] The date the patient first received treatment for the current condition. Required when this date impacts adjudication for services such as spinal manipulation, physical or occupational therapy, or pregnancy.

lastMenstrualPeriod
encounter.clinicalDates.lastMenstrualPeriod
StringLength: 1 - 35

[CMS-1500 Box 14] The date of the patient's last menstrual period (LMP) before pregnancy. Provide for claims related to a pregnancy.

lastSeen
encounter.clinicalDates.lastSeen
StringLength: 1 - 35

[CMS-1500 Box 15] The date the patient was last seen by the attending or supervising physician for the qualifying condition. Required for routine foot care services when this date impacts adjudication.

lastWorked
encounter.clinicalDates.lastWorked
StringLength: 1 - 35

[CMS-1500 Box 15] The last date the patient worked, for disability or workers' compensation claims.

lastXray
encounter.clinicalDates.lastXray
StringLength: 1 - 35

[CMS-1500 Box 15] The date of the patient's last X-ray, for claims related to spinal manipulation.

onsetOfCurrentIllness
encounter.clinicalDates.onsetOfCurrentIllness
StringLength: 1 - 35

[CMS-1500 Box 14] The date the patient first experienced acute symptoms of the current illness or injury. Required when a service in the claim is the first for a new illness or injury, when the claim is related to an employment or accident condition, or when the payer requires it. For an emergency, provide this date when it is known and differs from the date of service.

prescription
encounter.clinicalDates.prescription
StringLength: 1 - 35

[CMS-1500 Box 15] The date of the patient's hearing or vision prescription. Required for claims billing hearing devices or vision frames and lenses.

relinquishedCare
encounter.clinicalDates.relinquishedCare
StringLength: 1 - 35

[CMS-1500 Box 15] The date the provider relinquished care of the patient, for shared-care arrangements.

repricerReceived
encounter.clinicalDates.repricerReceived
StringLength: 1 - 35

[CMS-1500 Box 15] The date the repricer received the claim, when applicable.

returnedToWork
encounter.clinicalDates.returnedToWork
StringLength: 1 - 35

[CMS-1500 Box 15] The date the patient returned to work, for disability or workers' compensation claims.

unableToWork
encounter.clinicalDates.unableToWork
Object

[CMS-1500 Box 16] The date range during which the patient was unable to work, when applicable. Provide only to when the patient is no longer unable to work and the start date is unknown.

Show attributes
end
encounter.clinicalDates.unableToWork.end
StringLength: 1 - 35

The end date of the range, inclusive, in YYYY-MM-DD format.

start
encounter.clinicalDates.unableToWork.start
StringLength: 1 - 35

The start date of the range, in YYYY-MM-DD format.

epsdtReferralCodes
encounter.epsdtReferralCodes
Array of StringsItems: 1 - 3

[CMS-1500 Box 24h] Early and Periodic Screening, Diagnosis, and Treatment (EPSDT) referral condition indicators for the claim. EPSDT is a Medicaid program that provides preventive health care services for children under age 21.

  • Include when the claim bills an EPSDT screening service, with the referral outcome of the screening.
  • Use NOT_USED when the screening did not result in a referral.
  • Mark services that resulted from a screening with serviceLines[].isEpsdtRelated.
Possible values
AVAILABLE_NOT_USED
UNDER_TREATMENT
NEW_SERVICE_REQUESTED
NOT_USED
patientCondition
encounter.patientCondition
Object

[CMS-1500 Box 10a, 10b, 10c] Whether the patient's illness or injury is related to employment or an accident.

Show attributes
autoAccidentState
encounter.patientCondition.autoAccidentState
StringLength: 2

[CMS-1500 Box 10b] The two-letter state code where the automobile accident occurred. Required when isAutoAccidentRelated is true.

isAutoAccidentRelated
encounter.patientCondition.isAutoAccidentRelated
Boolean

[CMS-1500 Box 10b] Whether the patient's condition is related to an automobile accident. When true, set autoAccidentState. Other insurance, such as automobile liability coverage, may be the primary payer.

isEmploymentRelated
encounter.patientCondition.isEmploymentRelated
Boolean

[CMS-1500 Box 10a] Whether the patient's condition is related to their employment.

isOtherAccidentRelated
encounter.patientCondition.isOtherAccidentRelated
Boolean

[CMS-1500 Box 10c] Whether the patient's condition is related to an accident other than an automobile accident.

primaryDiagnosisCode
encounter.primaryDiagnosisCode
StringRequiredLength: 1 - 30

[CMS-1500 Box 21] The principal diagnosis for the claim, which describes the main reason for the encounter. Must be an ICD-10-CM code. Stedi combines this with additionalDiagnosisCodes and the diagnosis codes on the service lines to form the claim's diagnosis list, which can hold at most 12 codes.

  • Use valid, billable codes at the highest level of specificity available.
  • Don't submit the decimal point (e.g., submit I639 not I63.9).
  • Don't submit header codes (codes with fewer than three characters, such as E10 for Type 1 diabetes).
primaryPlaceOfService
encounter.primaryPlaceOfService
StringLength: 1 - 2

The primary place of service code identifying where the services were rendered. When omitted, it is inferred from the most common place of service across the claim's service lines. Visit Place of Service Codes for a complete list.

priorReferringProvider
encounter.priorReferringProvider
Object

[CMS-1500 Box 17, 17a, 17b] The provider who wrote the initial referral that began this patient's episode of care, often the patient's primary care provider. Supply this only when a different provider then referred the patient onward to the rendering provider, such as when a primary care provider refers to a specialist who refers to another specialist. Requires referringProvider to also be set.

Show attributes
identifiers
encounter.priorReferringProvider.identifiers
Object

[CMS-1500 Box 17a, 17b] Identifiers for the referring provider.

Show attributes
commercialNumber
encounter.priorReferringProvider.identifiers.commercialNumber
StringLength: 1 - 50

[CMS-1500 Box 17a] A commercial number assigned to the referring provider by the payer. Include only when the payer requires it in addition to the NPI.

npi
encounter.priorReferringProvider.identifiers.npi
StringLength: 2 - 80

[CMS-1500 Box 17b] The referring provider's National Provider Identifier (NPI), a unique 10-digit ID issued by the Centers for Medicare & Medicaid Services (CMS).

stateLicenseNumber
encounter.priorReferringProvider.identifiers.stateLicenseNumber
StringLength: 1 - 50

[CMS-1500 Box 17a] The referring provider's state license number, assigned by a state licensing board. Include only when the payer requires it in addition to the NPI.

name
encounter.priorReferringProvider.name
ObjectRequired

[CMS-1500 Box 17] The full name of the referring provider.

Show attributes
person
encounter.priorReferringProvider.name.person
ObjectRequiredFormat: password

The person's name.

Show attributes
firstName
encounter.priorReferringProvider.name.person.firstName
StringLength: 1 - 35

The person's first name.

lastName
encounter.priorReferringProvider.name.person.lastName
StringRequiredLength: 1 - 60

The person's last name. Don't include a name suffix such as Jr. or III here. Use the suffix property instead.

middleName
encounter.priorReferringProvider.name.person.middleName
StringLength: 1 - 25

The person's middle name or initial.

suffix
encounter.priorReferringProvider.name.person.suffix
StringLength: 1 - 10

The person's name suffix, such as Jr. or III. Include only a personal name suffix here, not professional or academic credentials such as M.D.

referenceNumbers
encounter.referenceNumbers
Object

[CMS-1500 Box 23] Payer-issued reference numbers for the claim, such as a prior authorization, referral, CLIA, or mammography certification number.

Show attributes
clia
encounter.referenceNumbers.clia
StringLength: 1 - 50

[CMS-1500 Box 23] The Clinical Laboratory Improvement Amendments (CLIA) certification number. Required for all CLIA-certified facilities performing CLIA-covered laboratory services. When the claim contains both in-house and outsourced laboratory services, use the CLIA number for services performed by the billing or rendering provider.

mammographyCertification
encounter.referenceNumbers.mammographyCertification
StringLength: 1 - 50

[CMS-1500 Box 23] The facility's six-digit FDA Mammography Quality Standards Act (MQSA) certification number. Required when mammography services are rendered by a certified mammography provider.

priorAuthorization
encounter.referenceNumbers.priorAuthorization
StringLength: 1 - 50

[CMS-1500 Box 23] A payer-issued prior authorization number that approves the services on this claim. Required when the payer or Utilization Management Organization (UMO) assigned an authorization number and the services were preauthorized. To override this for a specific service line, set serviceLines[].priorAuthorizations instead.

referral
encounter.referenceNumbers.referral
StringLength: 1 - 50

[CMS-1500 Box 23] A referral number for the provider referral tied to the services on this claim. Required when the payer or Utilization Management Organization (UMO) assigned a referral number and a referral is involved.

referringProvider
encounter.referringProvider
Object

[CMS-1500 Box 17, 17a, 17b] The provider who referred the patient to the rendering provider for the care on this claim. Supply this whenever the claim involves a referral. When the patient passed through a chain of referrals, this is the most recent referral, the one the rendering provider acted on; identify the provider who wrote the earliest referral in priorReferringProvider.

Show attributes
identifiers
encounter.referringProvider.identifiers
Object

[CMS-1500 Box 17a, 17b] Identifiers for the referring provider.

Show attributes
commercialNumber
encounter.referringProvider.identifiers.commercialNumber
StringLength: 1 - 50

[CMS-1500 Box 17a] A commercial number assigned to the referring provider by the payer. Include only when the payer requires it in addition to the NPI.

npi
encounter.referringProvider.identifiers.npi
StringLength: 2 - 80

[CMS-1500 Box 17b] The referring provider's National Provider Identifier (NPI), a unique 10-digit ID issued by the Centers for Medicare & Medicaid Services (CMS).

stateLicenseNumber
encounter.referringProvider.identifiers.stateLicenseNumber
StringLength: 1 - 50

[CMS-1500 Box 17a] The referring provider's state license number, assigned by a state licensing board. Include only when the payer requires it in addition to the NPI.

name
encounter.referringProvider.name
ObjectRequired

[CMS-1500 Box 17] The full name of the referring provider.

Show attributes
person
encounter.referringProvider.name.person
ObjectRequiredFormat: password

The person's name.

Show attributes
firstName
encounter.referringProvider.name.person.firstName
StringLength: 1 - 35

The person's first name.

lastName
encounter.referringProvider.name.person.lastName
StringRequiredLength: 1 - 60

The person's last name. Don't include a name suffix such as Jr. or III here. Use the suffix property instead.

middleName
encounter.referringProvider.name.person.middleName
StringLength: 1 - 25

The person's middle name or initial.

suffix
encounter.referringProvider.name.person.suffix
StringLength: 1 - 10

The person's name suffix, such as Jr. or III. Include only a personal name suffix here, not professional or academic credentials such as M.D.

resubmission
encounter.resubmission
Object

[CMS-1500 Box 22] Whether this claim replaces or voids a previously submitted claim. Omit when you're submitting a new claim and when you're resubmitting a claim that was rejected before it entered the payer's processing system. You must also omit this property for every resubmission to Original Medicare because Original Medicare doesn't accept REPLACEMENT_OF_PRIOR_CLAIM.

Show attributes
code
encounter.resubmission.code
String

Whether this claim replaces or cancels a previously submitted claim.

Possible values
REPLACEMENT_OF_PRIOR_CLAIM
CANCELLATION_OF_PRIOR_CLAIM
originalReferenceNumber
encounter.resubmission.originalReferenceNumber
StringLength: 1 - 50

The Payer Claim Control Number (sometimes called the ICN) of the original claim being replaced or cancelled. Generally required when code is set. One exception is Original Medicare, which specifies that you omit this value from resubmissions.

supervisingProvider
encounter.supervisingProvider
Object

[CMS-1500 Box 17, 17a, 17b] The provider who oversaw the rendering provider and the care reported in this claim, when the rendering provider was supervised by a physician.

Show attributes
identifiers
encounter.supervisingProvider.identifiers
Object

[CMS-1500 Box 17a, 17b] Identifiers for the supervising provider.

Show attributes
commercialNumber
encounter.supervisingProvider.identifiers.commercialNumber
StringLength: 1 - 50

[CMS-1500 Box 17a] A commercial number assigned to the supervising provider by the payer. Include only when the payer requires it in addition to the NPI.

locationNumber
encounter.supervisingProvider.identifiers.locationNumber
StringLength: 1 - 50

[CMS-1500 Box 17a] A location number assigned to the supervising provider by the payer. Include only when the payer requires it in addition to the NPI.

npi
encounter.supervisingProvider.identifiers.npi
StringLength: 2 - 80

[CMS-1500 Box 17b] The supervising provider's National Provider Identifier (NPI), a unique 10-digit ID issued by the Centers for Medicare & Medicaid Services (CMS).

stateLicenseNumber
encounter.supervisingProvider.identifiers.stateLicenseNumber
StringLength: 1 - 50

[CMS-1500 Box 17a] The supervising provider's state license number, assigned by a state licensing board. Include only when the payer requires it in addition to the NPI.

name
encounter.supervisingProvider.name
ObjectRequired

[CMS-1500 Box 17] The full name of the supervising provider.

Show attributes
person
encounter.supervisingProvider.name.person
ObjectRequiredFormat: password

The person's name.

Show attributes
firstName
encounter.supervisingProvider.name.person.firstName
StringLength: 1 - 35

The person's first name.

lastName
encounter.supervisingProvider.name.person.lastName
StringRequiredLength: 1 - 60

The person's last name. Don't include a name suffix such as Jr. or III here. Use the suffix property instead.

middleName
encounter.supervisingProvider.name.person.middleName
StringLength: 1 - 25

The person's middle name or initial.

suffix
encounter.supervisingProvider.name.person.suffix
StringLength: 1 - 10

The person's name suffix, such as Jr. or III. Include only a personal name suffix here, not professional or academic credentials such as M.D.

insured
ObjectRequired

[CMS-1500 Box 1, 1a, 4, 7, 11, 11a, 11b, 11c] The person who carries the insurance policy being billed. The insured is also called the subscriber, primary policyholder, or primary cardholder, and may be a different person from the patient. For example, when a spouse or child receives care under an employee's plan, the employee is the insured.

Show attributes
address
insured.address
ObjectFormat: password

[CMS-1500 Box 7] The mailing address for the insured's permanent residence.

Show attributes
addressLine1
insured.address.addressLine1
StringRequiredLength: 1 - 55

The first line of the street address. This typically contains the building number and street name.

addressLine2
insured.address.addressLine2
StringLength: 1 - 55

The second line of the street address. This typically contains the apartment or suite number.

city
insured.address.city
StringRequiredLength: 2 - 30

The city name.

postalCode
insured.address.postalCode
StringLength: 3 - 15

The postal or ZIP code, with no separators or spaces. For United States addresses, use the full nine-digit ZIP code, such as 100031502.

state
insured.address.state
StringLength: 2

The two-letter state or province code. Required when the city is in the United States or Canada.

dateOfBirth
insured.dateOfBirth
StringRegex pattern: ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$Format: password

[CMS-1500 Box 11a] The insured's date of birth. Used to distinguish the insured from other members with similar names.

gender
insured.gender
StringFormat: password

[CMS-1500 Box 11a] The insured's sex.

Possible values
MALE
FEMALE
UNKNOWN
insuranceType
insured.insuranceType
StringRequired

[CMS-1500 Box 1] The type of health insurance plan being billed. Pick the type that best matches the plan and payer. For most commercial payers, use OTHER.

Possible values
MEDICARE
MEDICAID
TRICARE
CHAMPVA
FECA_BLK_LUNG
memberId
insured.memberId
StringFormat: passwordLength: 2 - 80

[CMS-1500 Box 1a] The member ID for the insured's insurance policy, typically found on the insurance card. For Medicare claims, this is the insured's Medicare Beneficiary Identifier (MBI).

name
insured.name
ObjectRequired

[CMS-1500 Box 4] The full name of the insured. This is a person for most claims. Provide an organization only for workers' compensation or other property and casualty claims where the policy is held by an entity, such as the patient's employer.

2 variants:
organization
insured.name.organization
StringRequiredLength: 1 - 60

The organization's business name.

paymentResponsibilityLevelCode
insured.paymentResponsibilityLevelCode
StringRequired

[CMS-1500 Box 11] The payer's responsibility level for this claim. This form supports claims to primary payers only.

Possible values
PRIMARY
planName
insured.planName
StringFormat: passwordLength: 1 - 60

[CMS-1500 Box 11c] The name of the insured's insurance plan, typically found on the insurance card.

policyOrGroupNumber
insured.policyOrGroupNumber
StringFormat: passwordLength: 1 - 50

[CMS-1500 Box 11] The payer's code for the employer or other party that purchased the plan, typically found on the insurance card. For workers' compensation claims, use the Federal Employees' Compensation Act (FECA) number for the case.

propertyCasualtyClaimNumber
insured.propertyCasualtyClaimNumber
StringFormat: passwordLength: 1 - 50

[CMS-1500 Box 11b] The claim number assigned by a property or casualty insurer. Include for workers' compensation, automobile accident, or other liability claims when the payer requires it.

ssn
insured.ssn
StringFormat: passwordLength: 1 - 50

[CMS-1500 Box 11b] The insured's Social Security Number. Only include when specifically instructed by a payer.

otherInsured
Array of ObjectsMax items: 10

[CMS-1500 Box 9, 9a, 9d] Coverage the patient holds under another insurance policy, relevant to coordination of benefits. Include this when the patient has coverage from another payer in addition to the one you're billing.

Array item
address
otherInsured[].address
ObjectFormat: password

The mailing address of the person insured under the other policy.

Show attributes
addressLine1
otherInsured[].address.addressLine1
StringRequiredLength: 1 - 55

The first line of the street address. This typically contains the building number and street name.

addressLine2
otherInsured[].address.addressLine2
StringLength: 1 - 55

The second line of the street address. This typically contains the apartment or suite number.

city
otherInsured[].address.city
StringRequiredLength: 2 - 30

The city name.

postalCode
otherInsured[].address.postalCode
StringLength: 3 - 15

The postal or ZIP code, with no separators or spaces. For United States addresses, use the full nine-digit ZIP code, such as 100031502.

state
otherInsured[].address.state
StringLength: 2

The two-letter state or province code. Required when the city is in the United States or Canada.

authorization
otherInsured[].authorization
ObjectRequired

Signature and assignment-of-benefits indicators for the other coverage.

Show attributes
insuredAuthorizesAssignment
otherInsured[].authorization.insuredAuthorizesAssignment
StringRequired

Whether the other insured has authorized payment of benefits directly to the provider.

Possible values
NO
NOT_APPLICABLE
YES
patientReleasesMedicalInfo
otherInsured[].authorization.patientReleasesMedicalInfo
StringRequired

Whether the provider has the other insured's authorization to release medical information needed to process the claim.

Possible values
INFORMED_CONSENT
YES
providerGeneratedPatientSignature
otherInsured[].authorization.providerGeneratedPatientSignature
Boolean

Whether the provider generated the patient's signature because the patient was physically unable to sign.

claimFilingIndicator
otherInsured[].claimFilingIndicator
StringRequired

The type of plan or payer the other coverage is filed under.

Possible values
OTHER_NON_FEDERAL_PROGRAMS
PREFERRED_PROVIDER_ORGANIZATION
POINT_OF_SERVICE
EXCLUSIVE_PROVIDER_ORGANIZATION
INDEMNITY_INSURANCE
medicareSecondaryInsuranceType
otherInsured[].medicareSecondaryInsuranceType
String

The Medicare secondary payer reason, when the other coverage makes Medicare the secondary payer.

Possible values
WORKING_AGED_BENEFICIARY_OR_SPOUSE_WITH_EGHP
END_STAGE_RENAL_DISEASE_IN_MANDATED_COORDINATION_PERIOD_WITH_EGHP
NO_FAULT_INSURANCE_INCLUDING_AUTO_IS_PRIMARY
WORKERS_COMPENSATION
PUBLIC_HEALTH_SERVICE_OR_OTHER_FEDERAL_AGENCY
memberId
otherInsured[].memberId
StringRequiredFormat: passwordLength: 2 - 80

[CMS-1500 Box 9] The member ID for the other policy.

name
otherInsured[].name
ObjectRequired

[CMS-1500 Box 9] The name of the person insured under the other policy.

2 variants:
organization
otherInsured[].name.organization
StringRequiredLength: 1 - 60

The organization's business name.

otherPayer
otherInsured[].otherPayer
ObjectRequired

The payer that provides the other coverage.

Show attributes
id
otherInsured[].otherPayer.id
ObjectRequired

The other payer's identifier.

2 variants:
payerId
otherInsured[].otherPayer.id.payerId
StringRequiredLength: 2 - 80

The other payer's payer identification number.

name
otherInsured[].otherPayer.name
ObjectRequired

The other payer's business name.

Show attributes
organization
otherInsured[].otherPayer.name.organization
StringRequiredLength: 1 - 60

The organization's business name.

planName
otherInsured[].planName
StringFormat: passwordLength: 1 - 60

[CMS-1500 Box 9d] The name of the other insurance plan.

policyOrGroupNumber
otherInsured[].policyOrGroupNumber
StringFormat: passwordLength: 1 - 50

[CMS-1500 Box 9a] The policy or group number for the other coverage.

relationshipToInsured
otherInsured[].relationshipToInsured
StringRequired

How the patient is related to the person insured under the other policy.

Possible values
SPOUSE
SELF
CHILD
EMPLOYEE
UNKNOWN
responsibilityLevel
otherInsured[].responsibilityLevel
StringRequired

The other payer's responsibility level for this claim, relative to the payer being billed.

Possible values
PRIMARY
SECONDARY
TERTIARY
ssn
otherInsured[].ssn
StringFormat: passwordLength: 1 - 50

The Social Security Number of the person insured under the other policy. Only include when specifically instructed by a payer.

patient
Object

[CMS-1500 Box 2, 3, 5, 6] The person who received care. Only include this object when the patient is someone other than the insured, such as a spouse or dependent on the insured's plan. When the patient is the insured, leave this empty.

Show attributes
address
patient.address
ObjectRequiredFormat: password

[CMS-1500 Box 5] The mailing address for the patient's permanent residence.

Show attributes
addressLine1
patient.address.addressLine1
StringRequiredLength: 1 - 55

The first line of the street address. This typically contains the building number and street name.

addressLine2
patient.address.addressLine2
StringLength: 1 - 55

The second line of the street address. This typically contains the apartment or suite number.

city
patient.address.city
StringRequiredLength: 2 - 30

The city name.

postalCode
patient.address.postalCode
StringLength: 3 - 15

The postal or ZIP code, with no separators or spaces. For United States addresses, use the full nine-digit ZIP code, such as 100031502.

state
patient.address.state
StringLength: 2

The two-letter state or province code. Required when the city is in the United States or Canada.

dateOfBirth
patient.dateOfBirth
StringRequiredRegex pattern: ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$Format: password

[CMS-1500 Box 3] The patient's date of birth. Used to distinguish the patient from other members with similar names.

gender
patient.gender
StringRequiredFormat: password

[CMS-1500 Box 3] The patient's sex.

Possible values
MALE
FEMALE
UNKNOWN
name
patient.name
ObjectRequired

[CMS-1500 Box 2] The full name of the person who received care.

Show attributes
person
patient.name.person
ObjectRequiredFormat: password

The person's name.

Show attributes
firstName
patient.name.person.firstName
StringLength: 1 - 35

The person's first name.

lastName
patient.name.person.lastName
StringRequiredLength: 1 - 60

The person's last name. Don't include a name suffix such as Jr. or III here. Use the suffix property instead.

middleName
patient.name.person.middleName
StringLength: 1 - 25

The person's middle name or initial.

suffix
patient.name.person.suffix
StringLength: 1 - 10

The person's name suffix, such as Jr. or III. Include only a personal name suffix here, not professional or academic credentials such as M.D.

relationshipToInsured
patient.relationshipToInsured
StringRequired

[CMS-1500 Box 6] How the patient is related to the insured.

Possible values
SPOUSE
CHILD
EMPLOYEE
OTHER_RELATIONSHIP
payer
ObjectRequired

[CMS-1500 Carrier Block] The payer being billed for this claim, identified by a Stedi payer ID. Visit the Payer Network for a complete list of payers and their IDs.

Show attributes
address
payer.address
ObjectFormat: password

[CMS-1500 Carrier Block] The payer's mailing address.

Show attributes
addressLine1
payer.address.addressLine1
StringRequiredLength: 1 - 55

The first line of the street address. This typically contains the building number and street name.

addressLine2
payer.address.addressLine2
StringLength: 1 - 55

The second line of the street address. This typically contains the apartment or suite number.

city
payer.address.city
StringRequiredLength: 2 - 30

The city name.

postalCode
payer.address.postalCode
StringLength: 3 - 15

The postal or ZIP code, with no separators or spaces. For United States addresses, use the full nine-digit ZIP code, such as 100031502.

state
payer.address.state
StringLength: 2

The two-letter state or province code. Required when the city is in the United States or Canada.

id
payer.id
StringRequiredLength: 2 - 80

[CMS-1500 Carrier Block] The Stedi payer ID for the payer being billed. Visit the Payer Network for a complete list.

  • You can send requests using the primary payer ID, the Stedi payer ID, or any alias listed in the payer record.
  • You must include leading 0 characters. Payer IDs are alphanumeric strings and must be treated as complete strings, not integers. For example, use 00540 for SISCO, not 540.
name
payer.name
Object

[CMS-1500 Carrier Block] The payer's business name, such as Aetna or Cigna.

Show attributes
organization
payer.name.organization
StringRequiredLength: 1 - 60

The organization's business name.

receiverId
payer.receiverId
StringLength: 2 - 80

[CMS-1500 Carrier Block] The ID of the receiver that processes the claim, typically the clearinghouse or payer. Only include when the receiver differs from the payer.

purpose
StringRequired

[CMS-1500 Carrier Block] The purpose of the submission. Use CHARGEABLE for standard fee-for-service claims, which covers most submissions.

Possible values
SUBROGATION_DEMAND
CHARGEABLE
REPORTING
serviceLines
Array of ObjectsRequiredItems: 1 - 50

[CMS-1500 Box 17, 17a, 17b, 24a-24j] The individual services, procedures, or supplies being billed. Each service line corresponds to one row in Box 24 of the CMS-1500 form.

Array item
attachments
serviceLines[].attachments
Array of ObjectsItems: 1 - 10

[CMS-1500 Box 24] Supporting documentation attached to this service line. Only include when the payer requires it. Visit Submit claim attachments for more information.

Array item
attachmentControlNumber
serviceLines[].attachments[].attachmentControlNumber
StringLength: 2 - 80

A control number assigned to the attachment. The payer uses this identifier to match the attachment to the claim.

  • You must include either this property or attachmentId in the request, but not both. Including both properties will result in an error.
  • We recommend using a ULID or UUID of up to 50 characters.
  • Stedi autogenerates a control number if you don't provide one.
attachmentId
serviceLines[].attachments[].attachmentId
StringRegex pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Length: 36

The unique identifier for an attachment file you previously uploaded to Stedi. This value is returned in the attachmentId property of the Create Claim Attachment (275) JSON response. Stedi uses it to generate and submit the 275 claim attachment transaction to the payer.

  • This property is required when you're submitting attachment files through Stedi.
  • You must include either this property or attachmentControlNumber in the request, but not both. Including both properties will result in an error.
reportTypeCode
serviceLines[].attachments[].reportTypeCode
StringRequired

The type of report being attached.

Possible values
REPORT_JUSTIFYING_TREATMENT
DRUGS_ADMINISTERED
TREATMENT_DIAGNOSIS
INITIAL_ASSESSMENT
FUNCTIONAL_GOALS
transmissionCode
serviceLines[].attachments[].transmissionCode
StringRequired

How you're sending the attachment to the payer.

Possible values
AVAILABLE_ON_REQUEST
BY_MAIL
ELECTRONICALLY_ONLY
EMAIL
FILE_TRANSFER
datesOfService
serviceLines[].datesOfService
ObjectRequired

[CMS-1500 Box 24a] The date or date range when the patient received the service.

Show attributes
end
serviceLines[].datesOfService.end
StringLength: 1 - 35

The end date of the range, inclusive, in YYYY-MM-DD format.

start
serviceLines[].datesOfService.start
StringLength: 1 - 35

The start date of the range, in YYYY-MM-DD format.

diagnosisCodes
serviceLines[].diagnosisCodes
Array of StringsRequiredItems: 1 - 4

[CMS-1500 Box 24e] Up to four diagnoses this service relates to. Must be ICD-10-CM codes. List them in order of importance to the service, with the most relevant diagnosis first. Across encounter.primaryDiagnosisCode and the codes on every service line, a claim can use at most 12 distinct diagnosis codes.

  • You must submit a valid, billable code at the highest level of specificity. Include the 4th - 7th characters as applicable.
  • Don't submit the decimal point for ICD codes. The decimal point is implied.
  • Don't submit ICD-10 header codes. Header codes exist to group related codes and aren't valid for billing. These header codes can change with each new version of ICD-10, so we recommend reviewing your diagnosis codes every year to ensure that they aren't classified as header codes in the most recent version. To determine whether a code is a header code, you can also search the Value Set Authority Center. If the 'Header' property is set, the code is a header code and you shouldn't use it in claim submissions.
drugIdentification
serviceLines[].drugIdentification
Object

[CMS-1500 Box 24] Drug identification details for the service line. Required when a drug is billed for this line and a prescription was written.

Show attributes
associationNumber
serviceLines[].drugIdentification.associationNumber
Object

A prescription number or, for compound drugs, a link sequence number that ties the components of the compound together.

2 variants:
linkSequenceNumber
serviceLines[].drugIdentification.associationNumber.linkSequenceNumber
StringRequiredLength: 1 - 50

A provider-assigned number, unique to this claim, that ties together the components of a compound drug when there is no prescription number.

nationalDrugCode
serviceLines[].drugIdentification.nationalDrugCode
StringRequiredLength: 1 - 48

The dispensed drug's National Drug Code (NDC).

originalNdc
serviceLines[].drugIdentification.originalNdc
StringLength: 1 - 80

The original National Drug Code (NDC), when it differs from the code reported in nationalDrugCode.

unitCount
serviceLines[].drugIdentification.unitCount
StringRequiredRegex pattern: ^\d{1,8}(\.\d{1,3})?$

The quantity of the drug administered, expressed in the unit given by unitOfMeasure.

unitOfMeasure
serviceLines[].drugIdentification.unitOfMeasure
StringRequired

The unit of measure for unitCount.

Possible values
INTERNATIONAL_UNIT
GRAM
MILLIGRAM
MILLILITER
UNIT
isEmergency
serviceLines[].isEmergency
Boolean

[CMS-1500 Box 24c] Whether the service was related to an emergency, meaning the patient required immediate intervention for a severe, life-threatening, or potentially disabling condition.

isEpsdtRelated
serviceLines[].isEpsdtRelated
Boolean

[CMS-1500 Box 24h] Whether the service is related to an Early and Periodic Screening, Diagnosis, and Treatment (EPSDT) encounter. Set this on services that resulted from an EPSDT screening, not on the screening service itself. Report the screening's referral outcome in encounter.epsdtReferralCodes.

isFamilyPlanning
serviceLines[].isFamilyPlanning
Boolean

[CMS-1500 Box 24h] Whether the service was related to a family planning program.

lineItemChargeAmount
serviceLines[].lineItemChargeAmount
StringRequiredRegex pattern: ^\d+(\.\d{1,2})?$

[CMS-1500 Box 24f] The charge for this service line, including the provider's base charge and any applicable tax or postage. It is acceptable to set this to 0 (zero).

lineItemControlNumber
serviceLines[].lineItemControlNumber
StringLength: 1 - 50

A control number you assign to this service line for your own tracking. Each must be unique within the claim. If you don't set it, Stedi sets it for you – a random ULID.

narrativeForUnspecifiedCode
serviceLines[].narrativeForUnspecifiedCode
StringLength: 1 - 80

[CMS-1500 Box 24] A free-text description that clarifies the procedure code and any modifiers. Provide when billing an unspecified or unlisted procedure code.

orderingProvider
serviceLines[].orderingProvider
Object

[CMS-1500 Box 17, 17a, 17b] The provider who ordered the services, tests, or supplies billed on this service line. For example, a physician who ordered lab work or imaging. Include when the ordering provider differs from the rendering provider for this line.

Show attributes
identifiers
serviceLines[].orderingProvider.identifiers
Object

[CMS-1500 Box 17a, 17b] Identifiers for the ordering provider.

Show attributes
commercialNumber
serviceLines[].orderingProvider.identifiers.commercialNumber
StringLength: 1 - 50

[CMS-1500 Box 17a] A commercial number assigned to the ordering provider by the payer. Include only when the payer requires it in addition to the NPI.

npi
serviceLines[].orderingProvider.identifiers.npi
StringLength: 2 - 80

[CMS-1500 Box 17b] The ordering provider's National Provider Identifier (NPI), a unique 10-digit ID issued by the Centers for Medicare & Medicaid Services (CMS).

stateLicenseNumber
serviceLines[].orderingProvider.identifiers.stateLicenseNumber
StringLength: 1 - 50

[CMS-1500 Box 17a] The ordering provider's state license number, assigned by a state licensing board. Include only when the payer requires it in addition to the NPI.

name
serviceLines[].orderingProvider.name
ObjectRequired

[CMS-1500 Box 17] The full name of the ordering provider.

Show attributes
person
serviceLines[].orderingProvider.name.person
ObjectRequiredFormat: password

The person's name.

Show attributes
firstName
serviceLines[].orderingProvider.name.person.firstName
StringLength: 1 - 35

The person's first name.

lastName
serviceLines[].orderingProvider.name.person.lastName
StringRequiredLength: 1 - 60

The person's last name. Don't include a name suffix such as Jr. or III here. Use the suffix property instead.

middleName
serviceLines[].orderingProvider.name.person.middleName
StringLength: 1 - 25

The person's middle name or initial.

suffix
serviceLines[].orderingProvider.name.person.suffix
StringLength: 1 - 10

The person's name suffix, such as Jr. or III. Include only a personal name suffix here, not professional or academic credentials such as M.D.

placeOfService
serviceLines[].placeOfService
StringLength: 1 - 2

[CMS-1500 Box 24b] The place of service code identifying where the patient received the service. Visit Place of Service Codes for a complete list.

priorAuthorizations
serviceLines[].priorAuthorizations
Array of ObjectsItems: 1 - 5

Prior authorization numbers that apply to this service line. Include only numbers that differ from the claim-level prior authorization in encounter.referenceNumbers.priorAuthorization. You can use the same number on multiple service lines.

Array item
otherPayerPrimaryId
serviceLines[].priorAuthorizations[].otherPayerPrimaryId
StringLength: 1 - 50

The identifier of the other payer that issued this prior authorization number. Include only when the number was issued by a payer other than the one being billed, and match the other payer's identifier in otherInsured[].otherPayer.id.

priorAuthorizationNumber
serviceLines[].priorAuthorizations[].priorAuthorizationNumber
StringRequiredLength: 1 - 50

The payer-issued prior authorization number for this service line.

procedureCode
serviceLines[].procedureCode
ObjectRequired

[CMS-1500 Box 24d] The procedure, service, or supply code being billed, with any applicable modifiers.

Show attributes
code
serviceLines[].procedureCode.code
StringRequiredLength: 1 - 48

The procedure, service, or supply code, typically a CPT or HCPCS code.

modifiers
serviceLines[].procedureCode.modifiers
Array of StringsItems: 1 - 4

Up to four modifier codes that convey special circumstances related to the service, such as 25 or JW.

renderingProvider
serviceLines[].renderingProvider
Object

[CMS-1500 Box 24i, 24j] The provider who performed this service. Include only when the rendering provider for this line differs from the claim. This is also where you supply a substitute (locum tenens) provider's information.

Show attributes
identifiers
serviceLines[].renderingProvider.identifiers
Object

[CMS-1500 Box 24i, 24j] Identifiers for the rendering provider.

Show attributes
commercialNumber
serviceLines[].renderingProvider.identifiers.commercialNumber
StringLength: 1 - 50

[CMS-1500 Box 24i] A commercial number assigned to the rendering provider by the payer. Include only when the payer requires it in addition to the NPI.

locationNumber
serviceLines[].renderingProvider.identifiers.locationNumber
StringLength: 1 - 50

[CMS-1500 Box 24i] A location number assigned to the rendering provider by the payer. Include only when the payer requires it in addition to the NPI.

npi
serviceLines[].renderingProvider.identifiers.npi
StringLength: 2 - 80

[CMS-1500 Box 24j] The rendering provider's National Provider Identifier (NPI), a unique 10-digit ID issued by the Centers for Medicare & Medicaid Services (CMS).

stateLicenseNumber
serviceLines[].renderingProvider.identifiers.stateLicenseNumber
StringLength: 1 - 50

[CMS-1500 Box 24i] The rendering provider's state license number, assigned by a state licensing board. Include only when the payer requires it in addition to the NPI.

taxonomyCode
serviceLines[].renderingProvider.identifiers.taxonomyCode
StringLength: 1 - 50

[CMS-1500 Box 24i] The rendering provider's taxonomy code from the National Uniform Claim Committee Health Care Provider Taxonomy Code Set, which identifies the provider's type and specialty.

name
serviceLines[].renderingProvider.name
ObjectRequired

[CMS-1500 Box 24j] The rendering provider's name. Provide a person's name or an organization's business name.

2 variants:
organization
serviceLines[].renderingProvider.name.organization
StringRequiredLength: 1 - 60

The organization's business name.

units
serviceLines[].units
StringRequiredRegex pattern: ^\d{1,8}(\.\d{1,3})?$

[CMS-1500 Box 24g] The number of units of the service provided. The units depend on the procedure code and the nature of the service. For example, they may correspond to office visits (1 unit per visit), individual diagnostic tests (1 unit per test), or time (when a service is billed in 15-minute increments, 4 units could equal 1 hour). For anesthesia procedure codes (00100-01999), report the total anesthesia time in minutes; Stedi reports the unit of measure as minutes for these codes automatically.

submitter
ObjectRequired

[CMS-1500 Carrier Block] The entity submitting the claim to Stedi.

Show attributes
contact
submitter.contact
Object

[CMS-1500 Carrier Block] The contact for questions about this claim submission. Provide at least a phone number or an email address.

Show attributes
email
submitter.contact.email
StringFormat: passwordLength: 1 - 256

The contact's email address.

faxNumber
submitter.contact.faxNumber
StringFormat: passwordLength: 1 - 256

The contact's fax number.

name
submitter.contact.name
StringLength: 1 - 60

The name of the contact person or department. When omitted, questions are directed to the entity itself.

phoneExtension
submitter.contact.phoneExtension
StringLength: 1 - 256

The extension for phoneNumber.

phoneNumber
submitter.contact.phoneNumber
StringFormat: passwordLength: 1 - 256

The contact's phone number.

etin
submitter.etin
StringLength: 2 - 80

[CMS-1500 Carrier Block] The submitter's Electronic Transmitter Identification Number (ETIN), a payer-assigned ID that identifies the entity transmitting the claim.

name
submitter.name
ObjectRequired

[CMS-1500 Carrier Block] The name of the submitter, either a person or an organization.

2 variants:
organization
submitter.name.organization
StringRequiredLength: 1 - 60

The organization's business name.

This endpoint returns no response body on success.